content
stringlengths 28
1.34M
|
|---|
import { Injectable } from '@nestjs/common';
import type {
ListQueryOptions,
PaginatedList,
RequestContext,
} from '@vendure/core';
import { ListQueryBuilder } from '@vendure/core';
import { SupplierStockInTransit } from '../../entities/supplier-stock-in-transit.entity';
@Injectable()
export class SupplierStockInTransitService {
constructor(private readonly listQueryBuilder: ListQueryBuilder) {}
findAll(
ctx: RequestContext,
options?: ListQueryOptions<SupplierStockInTransit>
): Promise<PaginatedList<SupplierStockInTransit>> {
return this.listQueryBuilder
.build(SupplierStockInTransit, options, {
ctx,
relations: ['supplierStock', 'supplierStock.productVariant'],
})
.getManyAndCount()
.then(([items, totalItems]) => {
return {
items,
totalItems,
};
});
}
}
|
import { Injectable } from '@nestjs/common';
import type {
ListQueryOptions,
PaginatedList,
RelationPaths,
RequestContext,
} from '@vendure/core';
import { ListQueryBuilder } from '@vendure/core';
import { SupplierStock } from '../../entities/supplier-stock.entity';
@Injectable()
export class SupplierStockService {
constructor(private readonly listQueryBuilder: ListQueryBuilder) {}
findAll(
ctx: RequestContext,
options?: ListQueryOptions<SupplierStock>,
relations?: RelationPaths<SupplierStock>
): Promise<PaginatedList<SupplierStock>> {
return this.listQueryBuilder
.build(SupplierStock, options, {
ctx,
relations: relations ?? [
'product',
'productVariant',
'supplier',
'stocksInTransits',
],
})
.getManyAndCount()
.then(([items, totalItems]) => {
return {
items,
totalItems,
};
});
}
}
|
import type { CustomFieldConfig } from '@vendure/core';
import { Asset } from '@vendure/core';
export const productVariantCustomFields: CustomFieldConfig[] = [
// {
// type: 'int',
// name: 'costPrice',
// nullable: false,
// public: false,
// defaultValue: 0,
// label: [
// {
// languageCode: LanguageCode.en,
// value: 'Cost Price',
// },
// ],
// description: [
// {
// languageCode: LanguageCode.en,
// value: 'The cost price of this product',
// },
// ],
// },
{
type: 'relation',
name: 'tryonFrameAsset',
nullable: true,
entity: Asset,
eager: true,
public: true,
},
{
type: 'relation',
name: 'tryonTempleAsset',
nullable: true,
entity: Asset,
eager: true,
public: true,
},
{
type: 'relation',
name: 'visualFrameAsset',
nullable: true,
entity: Asset,
eager: true,
public: true,
},
// {
// type: 'relation',
// name: 'dimensionFrameAsset',
// nullable: true,
// entity: Asset,
// eager: true,
// public: true,
// },
// {
// type: 'relation',
// name: 'dimensionTempleAsset',
// nullable: true,
// entity: Asset,
// eager: true,
// public: true,
// },
// {
// type: 'text',
// name: 'tryonFrameModelConfig',
// nullable: true,
// public: true,
// label: [
// {
// languageCode: LanguageCode.en,
// value: 'Tryon Frame Model Config',
// },
// ],
// description: [
// {
// languageCode: LanguageCode.en,
// value: 'The tryon model json config data product variant',
// },
// ],
// },
];
|
import { DeepPartial, ID, VendureEntity } from '@vendure/core';
import { Column, Entity, ManyToOne } from 'typeorm';
import { SupplierStock } from './supplier-stock.entity';
/**
* @description This entity represents a SupplierInTransit information
*
* @docsCategory entities
*/
@Entity('supplier_stock_in_transit')
export class SupplierStockInTransit extends VendureEntity {
constructor(input?: DeepPartial<SupplierStockInTransit>) {
super(input);
}
@Column({ nullable: true })
channelName?: string;
@Column()
channelOrderNo: string;
@Column()
quantity: number;
@ManyToOne(
() => SupplierStock,
(supplierStock) => supplierStock.stocksInTransits
)
supplierStock: SupplierStock;
@Column({ type: 'int' })
supplierStockId: ID;
}
|
import {
DeepPartial,
ID,
Product,
ProductVariant,
VendureEntity,
} from '@vendure/core';
import { Column, Entity, OneToMany, ManyToOne } from 'typeorm';
import { SupplierStockInTransit } from './supplier-stock-in-transit.entity';
/**
* @description This entity represents a supplier virtual stock
*
* @docsCategory entities
*/
@Entity('supplier_stock')
export class SupplierStock extends VendureEntity {
constructor(input?: DeepPartial<SupplierStock>) {
super(input);
}
@Column({ default: 0 })
stockOnHand: number;
@Column({ default: 0 })
virtualStock: number;
@Column({ default: 0 })
inTransitsStock: number;
@Column({ nullable: true })
stockArea: string;
@OneToMany(() => SupplierStockInTransit, (type) => type.supplierStock)
stocksInTransits: SupplierStockInTransit[];
@Column({ default: true })
enabled: boolean;
@Column({ nullable: true })
link?: string;
@Column({ nullable: true, type: 'simple-json' })
tags?: string[];
@Column({ type: 'tinytext', nullable: true })
comment?: string;
@ManyToOne(() => ProductVariant, { onDelete: 'CASCADE' })
productVariant: ProductVariant;
@Column('int')
productVariantId: ID;
@ManyToOne(() => Product, { onDelete: 'CASCADE' })
product: Product;
@Column('int', { nullable: true })
productId: ID;
}
|
import { Injectable, OnModuleInit } from '@nestjs/common';
import { Args, Mutation, Resolver } from '@nestjs/graphql';
import { JobState } from '@vendure/common/lib/generated-types';
import { JobQueue, JobQueueService, Logger, PluginCommonModule, VendurePlugin } from '@vendure/core';
import { gql } from 'graphql-tag';
import { forkJoin, Observable, of } from 'rxjs';
import { catchError, map } from 'rxjs/operators';
interface TaskConfigInput {
intervalMs: number;
shouldFail: boolean;
retries: number;
subscribeToResult: boolean;
}
let queueCount = 1;
@Injectable()
export class JobQueueTestService implements OnModuleInit {
private queues: Array<JobQueue<{ intervalMs: number; shouldFail: boolean }>> = [];
constructor(private jobQueueService: JobQueueService) {}
async onModuleInit() {
for (let i = 0; i < queueCount; i++) {
const queue: JobQueue<{
intervalMs: number;
shouldFail: boolean;
}> = await this.jobQueueService.createQueue({
name: `test-queue-${i + 1}`,
process: async job => {
Logger.info(`Starting job ${job.id}, shouldFail: ${JSON.stringify(job.data.shouldFail)}`);
let progress = 0;
while (progress < 100) {
// Logger.info(`Job ${job.id} progress: ${progress}`);
await new Promise(resolve => setTimeout(resolve, job.data.intervalMs));
progress += 10;
job.setProgress(progress);
if (progress > 70 && job.data.shouldFail) {
Logger.warn(`Job ${job.id} will fail`);
throw new Error(`Job failed!!`);
}
}
Logger.info(`Completed job ${job.id}`);
return 'Done!';
},
});
this.queues.push(queue);
}
}
async startTask(input: TaskConfigInput) {
const { intervalMs, shouldFail, subscribeToResult, retries } = input;
const updates: Array<Observable<number>> = [];
for (const queue of this.queues) {
const job = await queue.add({ intervalMs, shouldFail }, { retries });
if (subscribeToResult) {
updates.push(
job.updates().pipe(
map(update => {
Logger.info(`Job ${update.id}: progress: ${update.progress}`);
if (update.state === JobState.COMPLETED) {
Logger.info(`COMPLETED: ${JSON.stringify(update.result, null, 2)}`);
return update.result;
}
return update.progress;
}),
catchError(err => of(err.message)),
),
);
}
}
if (subscribeToResult) {
return forkJoin(...updates);
} else {
return 'running in background';
}
}
}
@Resolver()
export class JobQueueTestResolver {
constructor(private service: JobQueueTestService) {}
@Mutation()
startTask(@Args() args: any) {
return this.service.startTask(args.input);
}
}
/**
* A plugin which can be used to test job queue strategies. Exposes a mutation `startTask` in
* the Admin API which triggers a job.
*/
@VendurePlugin({
imports: [PluginCommonModule],
adminApiExtensions: {
resolvers: [JobQueueTestResolver],
schema: gql`
input TaskConfigInput {
intervalMs: Int!
shouldFail: Boolean!
retries: Int
subscribeToResult: Boolean
}
extend type Mutation {
startTask(input: TaskConfigInput!): JSON!
}
`,
},
providers: [JobQueueTestService],
})
export class JobQueueTestPlugin {
static init(options: { queueCount: number }) {
queueCount = options.queueCount;
return this;
}
}
|
import { HttpModule } from '@nestjs/axios';
import { MiddlewareConsumer, NestModule } from '@nestjs/common';
import { PluginCommonModule, VendurePlugin } from '@vendure/core';
import express from 'express';
import path from 'path';
import { KeycloakAuthenticationStrategy } from './keycloak-authentication-strategy';
/**
* A demo plugin which configures an AuthenticationStrategy for a KeyCloak ID server.
*
* Assumes that KeyCloak is running on port 9000, with a realm configured named "myrealm"
* and a client named "vendure".
*
* Add the plugin to the VendureConfig and set the Admin UI `loginUrl` option to
* "http://localhost:3000/keycloak-login".
*
* Video demo of this: https://youtu.be/Tj4kwjNd2nM
*/
@VendurePlugin({
imports: [PluginCommonModule, HttpModule],
configuration: config => {
config.authOptions.adminAuthenticationStrategy = [
...config.authOptions.adminAuthenticationStrategy,
new KeycloakAuthenticationStrategy(),
];
return config;
},
})
export class KeycloakAuthPlugin implements NestModule {
configure(consumer: MiddlewareConsumer) {
consumer.apply(express.static(path.join(__dirname, 'public'))).forRoutes('keycloak-login');
}
}
|
import { HttpService } from '@nestjs/axios';
import {
AuthenticationStrategy,
ExternalAuthenticationService,
Injector,
Logger,
RequestContext,
Role,
TransactionalConnection,
User,
} from '@vendure/core';
import { DocumentNode } from 'graphql';
import gql from 'graphql-tag';
export type KeycloakAuthData = {
token: string;
};
export type OpenIdUserInfo = {
name: string;
sub: string;
email?: string;
email_verified: boolean;
preferred_username: string;
given_name?: string;
family_name?: string;
};
export class KeycloakAuthenticationStrategy implements AuthenticationStrategy<KeycloakAuthData> {
readonly name = 'keycloak';
private externalAuthenticationService: ExternalAuthenticationService;
private httpService: HttpService;
private connection: TransactionalConnection;
private bearerToken: string;
init(injector: Injector) {
this.externalAuthenticationService = injector.get(ExternalAuthenticationService);
this.httpService = injector.get(HttpService);
this.connection = injector.get(TransactionalConnection);
}
defineInputType(): DocumentNode {
return gql`
input KeycloakAuthInput {
token: String!
}
`;
}
async authenticate(ctx: RequestContext, data: KeycloakAuthData): Promise<User | false> {
let userInfo: OpenIdUserInfo;
this.bearerToken = data.token;
try {
const response = await this.httpService
.get('http://localhost:9000/realms/myrealm/protocol/openid-connect/userinfo', {
headers: {
Authorization: `Bearer ${this.bearerToken}`,
},
})
.toPromise();
userInfo = response?.data;
} catch (e: any) {
Logger.error(e);
return false;
}
if (!userInfo) {
return false;
}
const user = await this.externalAuthenticationService.findAdministratorUser(
ctx,
this.name,
userInfo.sub,
);
if (user) {
return user;
}
const merchantRole = await this.connection.getRepository(ctx, Role).findOne({
where: { code: 'merchant' },
});
if (!merchantRole) {
Logger.error(`Could not find "merchant" role`);
return false;
}
return this.externalAuthenticationService.createAdministratorAndUser(ctx, {
strategy: this.name,
externalIdentifier: userInfo.sub,
identifier: userInfo.preferred_username,
emailAddress: userInfo.email,
firstName: userInfo.given_name ?? userInfo.preferred_username,
lastName: userInfo.family_name ?? userInfo.preferred_username,
roles: [merchantRole],
});
}
}
|
/* eslint-disable */
export type Maybe<T> = T;
export type InputMaybe<T> = T;
export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
export type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]?: Maybe<T[SubKey]> };
export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]: Maybe<T[SubKey]> };
export type MakeEmpty<T extends { [key: string]: unknown }, K extends keyof T> = { [_ in K]?: never };
export type Incremental<T> =
| T
| { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
/** All built-in and custom scalars, mapped to their actual values */
export type Scalars = {
ID: { input: string | number; output: string | number };
String: { input: string; output: string };
Boolean: { input: boolean; output: boolean };
Int: { input: number; output: number };
Float: { input: number; output: number };
DateTime: { input: any; output: any };
JSON: { input: any; output: any };
Money: { input: any; output: any };
Upload: { input: any; output: any };
};
export type AddFulfillmentToOrderResult =
| CreateFulfillmentError
| EmptyOrderLineSelectionError
| Fulfillment
| FulfillmentStateTransitionError
| InsufficientStockOnHandError
| InvalidFulfillmentHandlerError
| ItemsAlreadyFulfilledError;
export type AddItemInput = {
productVariantId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type AddItemToDraftOrderInput = {
productVariantId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type AddManualPaymentToOrderResult = ManualPaymentStateError | Order;
export type AddNoteToCustomerInput = {
id: Scalars['ID']['input'];
isPublic: Scalars['Boolean']['input'];
note: Scalars['String']['input'];
};
export type AddNoteToOrderInput = {
id: Scalars['ID']['input'];
isPublic: Scalars['Boolean']['input'];
note: Scalars['String']['input'];
};
export type Address = Node & {
__typename?: 'Address';
city?: Maybe<Scalars['String']['output']>;
company?: Maybe<Scalars['String']['output']>;
country: Country;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
defaultBillingAddress?: Maybe<Scalars['Boolean']['output']>;
defaultShippingAddress?: Maybe<Scalars['Boolean']['output']>;
fullName?: Maybe<Scalars['String']['output']>;
id: Scalars['ID']['output'];
phoneNumber?: Maybe<Scalars['String']['output']>;
postalCode?: Maybe<Scalars['String']['output']>;
province?: Maybe<Scalars['String']['output']>;
streetLine1: Scalars['String']['output'];
streetLine2?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type AdjustDraftOrderLineInput = {
orderLineId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type Adjustment = {
__typename?: 'Adjustment';
adjustmentSource: Scalars['String']['output'];
amount: Scalars['Money']['output'];
data?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
type: AdjustmentType;
};
export enum AdjustmentType {
DISTRIBUTED_ORDER_PROMOTION = 'DISTRIBUTED_ORDER_PROMOTION',
OTHER = 'OTHER',
PROMOTION = 'PROMOTION',
}
export type Administrator = Node & {
__typename?: 'Administrator';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
emailAddress: Scalars['String']['output'];
firstName: Scalars['String']['output'];
id: Scalars['ID']['output'];
lastName: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
user: User;
};
export type AdministratorFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
emailAddress?: InputMaybe<StringOperators>;
firstName?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
lastName?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type AdministratorList = PaginatedList & {
__typename?: 'AdministratorList';
items: Array<Administrator>;
totalItems: Scalars['Int']['output'];
};
export type AdministratorListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<AdministratorFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<AdministratorSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type AdministratorPaymentInput = {
metadata?: InputMaybe<Scalars['JSON']['input']>;
paymentMethod?: InputMaybe<Scalars['String']['input']>;
};
export type AdministratorRefundInput = {
paymentId: Scalars['ID']['input'];
reason?: InputMaybe<Scalars['String']['input']>;
};
export type AdministratorSortParameter = {
createdAt?: InputMaybe<SortOrder>;
emailAddress?: InputMaybe<SortOrder>;
firstName?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
lastName?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type Allocation = Node &
StockMovement & {
__typename?: 'Allocation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
orderLine: OrderLine;
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
/** Returned if an attempting to refund an OrderItem which has already been refunded */
export type AlreadyRefundedError = ErrorResult & {
__typename?: 'AlreadyRefundedError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
refundId: Scalars['ID']['output'];
};
export type ApplyCouponCodeResult =
| CouponCodeExpiredError
| CouponCodeInvalidError
| CouponCodeLimitError
| Order;
export type Asset = Node & {
__typename?: 'Asset';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
fileSize: Scalars['Int']['output'];
focalPoint?: Maybe<Coordinate>;
height: Scalars['Int']['output'];
id: Scalars['ID']['output'];
mimeType: Scalars['String']['output'];
name: Scalars['String']['output'];
preview: Scalars['String']['output'];
source: Scalars['String']['output'];
tags: Array<Tag>;
type: AssetType;
updatedAt: Scalars['DateTime']['output'];
width: Scalars['Int']['output'];
};
export type AssetFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
fileSize?: InputMaybe<NumberOperators>;
height?: InputMaybe<NumberOperators>;
id?: InputMaybe<IdOperators>;
mimeType?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
preview?: InputMaybe<StringOperators>;
source?: InputMaybe<StringOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
width?: InputMaybe<NumberOperators>;
};
export type AssetList = PaginatedList & {
__typename?: 'AssetList';
items: Array<Asset>;
totalItems: Scalars['Int']['output'];
};
export type AssetListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<AssetFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<AssetSortParameter>;
tags?: InputMaybe<Array<Scalars['String']['input']>>;
tagsOperator?: InputMaybe<LogicalOperator>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type AssetSortParameter = {
createdAt?: InputMaybe<SortOrder>;
fileSize?: InputMaybe<SortOrder>;
height?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
mimeType?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
preview?: InputMaybe<SortOrder>;
source?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
width?: InputMaybe<SortOrder>;
};
export enum AssetType {
BINARY = 'BINARY',
IMAGE = 'IMAGE',
VIDEO = 'VIDEO',
}
export type AssignAssetsToChannelInput = {
assetIds: Array<Scalars['ID']['input']>;
channelId: Scalars['ID']['input'];
};
export type AssignCollectionsToChannelInput = {
channelId: Scalars['ID']['input'];
collectionIds: Array<Scalars['ID']['input']>;
};
export type AssignFacetsToChannelInput = {
channelId: Scalars['ID']['input'];
facetIds: Array<Scalars['ID']['input']>;
};
export type AssignPaymentMethodsToChannelInput = {
channelId: Scalars['ID']['input'];
paymentMethodIds: Array<Scalars['ID']['input']>;
};
export type AssignProductVariantsToChannelInput = {
channelId: Scalars['ID']['input'];
priceFactor?: InputMaybe<Scalars['Float']['input']>;
productVariantIds: Array<Scalars['ID']['input']>;
};
export type AssignProductsToChannelInput = {
channelId: Scalars['ID']['input'];
priceFactor?: InputMaybe<Scalars['Float']['input']>;
productIds: Array<Scalars['ID']['input']>;
};
export type AssignPromotionsToChannelInput = {
channelId: Scalars['ID']['input'];
promotionIds: Array<Scalars['ID']['input']>;
};
export type AssignShippingMethodsToChannelInput = {
channelId: Scalars['ID']['input'];
shippingMethodIds: Array<Scalars['ID']['input']>;
};
export type AssignStockLocationsToChannelInput = {
channelId: Scalars['ID']['input'];
stockLocationIds: Array<Scalars['ID']['input']>;
};
export type AuthenticationInput = {
native?: InputMaybe<NativeAuthInput>;
};
export type AuthenticationMethod = Node & {
__typename?: 'AuthenticationMethod';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
strategy: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type AuthenticationResult = CurrentUser | InvalidCredentialsError;
export type BooleanCustomFieldConfig = CustomField & {
__typename?: 'BooleanCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
/** Operators for filtering on a list of Boolean fields */
export type BooleanListOperators = {
inList: Scalars['Boolean']['input'];
};
/** Operators for filtering on a Boolean field */
export type BooleanOperators = {
eq?: InputMaybe<Scalars['Boolean']['input']>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
};
/** Returned if an attempting to cancel lines from an Order which is still active */
export type CancelActiveOrderError = ErrorResult & {
__typename?: 'CancelActiveOrderError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
orderState: Scalars['String']['output'];
};
export type CancelOrderInput = {
/** Specify whether the shipping charges should also be cancelled. Defaults to false */
cancelShipping?: InputMaybe<Scalars['Boolean']['input']>;
/** Optionally specify which OrderLines to cancel. If not provided, all OrderLines will be cancelled */
lines?: InputMaybe<Array<OrderLineInput>>;
/** The id of the order to be cancelled */
orderId: Scalars['ID']['input'];
reason?: InputMaybe<Scalars['String']['input']>;
};
export type CancelOrderResult =
| CancelActiveOrderError
| EmptyOrderLineSelectionError
| MultipleOrderError
| Order
| OrderStateTransitionError
| QuantityTooGreatError;
/** Returned if the Payment cancellation fails */
export type CancelPaymentError = ErrorResult & {
__typename?: 'CancelPaymentError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
paymentErrorMessage: Scalars['String']['output'];
};
export type CancelPaymentResult = CancelPaymentError | Payment | PaymentStateTransitionError;
export type Cancellation = Node &
StockMovement & {
__typename?: 'Cancellation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
orderLine: OrderLine;
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type Channel = Node & {
__typename?: 'Channel';
availableCurrencyCodes: Array<CurrencyCode>;
availableLanguageCodes?: Maybe<Array<LanguageCode>>;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
/** @deprecated Use defaultCurrencyCode instead */
currencyCode: CurrencyCode;
customFields?: Maybe<Scalars['JSON']['output']>;
defaultCurrencyCode: CurrencyCode;
defaultLanguageCode: LanguageCode;
defaultShippingZone?: Maybe<Zone>;
defaultTaxZone?: Maybe<Zone>;
id: Scalars['ID']['output'];
/** Not yet used - will be implemented in a future release. */
outOfStockThreshold?: Maybe<Scalars['Int']['output']>;
pricesIncludeTax: Scalars['Boolean']['output'];
seller?: Maybe<Seller>;
token: Scalars['String']['output'];
/** Not yet used - will be implemented in a future release. */
trackInventory?: Maybe<Scalars['Boolean']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
/**
* Returned when the default LanguageCode of a Channel is no longer found in the `availableLanguages`
* of the GlobalSettings
*/
export type ChannelDefaultLanguageError = ErrorResult & {
__typename?: 'ChannelDefaultLanguageError';
channelCode: Scalars['String']['output'];
errorCode: ErrorCode;
language: Scalars['String']['output'];
message: Scalars['String']['output'];
};
export type ChannelFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
currencyCode?: InputMaybe<StringOperators>;
defaultCurrencyCode?: InputMaybe<StringOperators>;
defaultLanguageCode?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
outOfStockThreshold?: InputMaybe<NumberOperators>;
pricesIncludeTax?: InputMaybe<BooleanOperators>;
token?: InputMaybe<StringOperators>;
trackInventory?: InputMaybe<BooleanOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ChannelList = PaginatedList & {
__typename?: 'ChannelList';
items: Array<Channel>;
totalItems: Scalars['Int']['output'];
};
export type ChannelListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ChannelFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ChannelSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ChannelSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
outOfStockThreshold?: InputMaybe<SortOrder>;
token?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type Collection = Node & {
__typename?: 'Collection';
assets: Array<Asset>;
breadcrumbs: Array<CollectionBreadcrumb>;
children?: Maybe<Array<Collection>>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
featuredAsset?: Maybe<Asset>;
filters: Array<ConfigurableOperation>;
id: Scalars['ID']['output'];
inheritFilters: Scalars['Boolean']['output'];
isPrivate: Scalars['Boolean']['output'];
languageCode?: Maybe<LanguageCode>;
name: Scalars['String']['output'];
parent?: Maybe<Collection>;
parentId: Scalars['ID']['output'];
position: Scalars['Int']['output'];
productVariants: ProductVariantList;
slug: Scalars['String']['output'];
translations: Array<CollectionTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type CollectionProductVariantsArgs = {
options?: InputMaybe<ProductVariantListOptions>;
};
export type CollectionBreadcrumb = {
__typename?: 'CollectionBreadcrumb';
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
slug: Scalars['String']['output'];
};
export type CollectionFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
inheritFilters?: InputMaybe<BooleanOperators>;
isPrivate?: InputMaybe<BooleanOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
parentId?: InputMaybe<IdOperators>;
position?: InputMaybe<NumberOperators>;
slug?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CollectionList = PaginatedList & {
__typename?: 'CollectionList';
items: Array<Collection>;
totalItems: Scalars['Int']['output'];
};
export type CollectionListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CollectionFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CollectionSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
topLevelOnly?: InputMaybe<Scalars['Boolean']['input']>;
};
/**
* Which Collections are present in the products returned
* by the search, and in what quantity.
*/
export type CollectionResult = {
__typename?: 'CollectionResult';
collection: Collection;
count: Scalars['Int']['output'];
};
export type CollectionSortParameter = {
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
parentId?: InputMaybe<SortOrder>;
position?: InputMaybe<SortOrder>;
slug?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type CollectionTranslation = {
__typename?: 'CollectionTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
slug: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ConfigArg = {
__typename?: 'ConfigArg';
name: Scalars['String']['output'];
value: Scalars['String']['output'];
};
export type ConfigArgDefinition = {
__typename?: 'ConfigArgDefinition';
defaultValue?: Maybe<Scalars['JSON']['output']>;
description?: Maybe<Scalars['String']['output']>;
label?: Maybe<Scalars['String']['output']>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
required: Scalars['Boolean']['output'];
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type ConfigArgInput = {
name: Scalars['String']['input'];
/** A JSON stringified representation of the actual value */
value: Scalars['String']['input'];
};
export type ConfigurableOperation = {
__typename?: 'ConfigurableOperation';
args: Array<ConfigArg>;
code: Scalars['String']['output'];
};
export type ConfigurableOperationDefinition = {
__typename?: 'ConfigurableOperationDefinition';
args: Array<ConfigArgDefinition>;
code: Scalars['String']['output'];
description: Scalars['String']['output'];
};
export type ConfigurableOperationInput = {
arguments: Array<ConfigArgInput>;
code: Scalars['String']['input'];
};
export type Coordinate = {
__typename?: 'Coordinate';
x: Scalars['Float']['output'];
y: Scalars['Float']['output'];
};
export type CoordinateInput = {
x: Scalars['Float']['input'];
y: Scalars['Float']['input'];
};
export type Country = Node &
Region & {
__typename?: 'Country';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
parent?: Maybe<Region>;
parentId?: Maybe<Scalars['ID']['output']>;
translations: Array<RegionTranslation>;
type: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type CountryFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
enabled?: InputMaybe<BooleanOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
parentId?: InputMaybe<IdOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CountryList = PaginatedList & {
__typename?: 'CountryList';
items: Array<Country>;
totalItems: Scalars['Int']['output'];
};
export type CountryListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CountryFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CountrySortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type CountrySortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
parentId?: InputMaybe<SortOrder>;
type?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type CountryTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
/** Returned if the provided coupon code is invalid */
export type CouponCodeExpiredError = ErrorResult & {
__typename?: 'CouponCodeExpiredError';
couponCode: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the provided coupon code is invalid */
export type CouponCodeInvalidError = ErrorResult & {
__typename?: 'CouponCodeInvalidError';
couponCode: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the provided coupon code is invalid */
export type CouponCodeLimitError = ErrorResult & {
__typename?: 'CouponCodeLimitError';
couponCode: Scalars['String']['output'];
errorCode: ErrorCode;
limit: Scalars['Int']['output'];
message: Scalars['String']['output'];
};
export type CreateAddressInput = {
city?: InputMaybe<Scalars['String']['input']>;
company?: InputMaybe<Scalars['String']['input']>;
countryCode: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
defaultBillingAddress?: InputMaybe<Scalars['Boolean']['input']>;
defaultShippingAddress?: InputMaybe<Scalars['Boolean']['input']>;
fullName?: InputMaybe<Scalars['String']['input']>;
phoneNumber?: InputMaybe<Scalars['String']['input']>;
postalCode?: InputMaybe<Scalars['String']['input']>;
province?: InputMaybe<Scalars['String']['input']>;
streetLine1: Scalars['String']['input'];
streetLine2?: InputMaybe<Scalars['String']['input']>;
};
export type CreateAdministratorInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress: Scalars['String']['input'];
firstName: Scalars['String']['input'];
lastName: Scalars['String']['input'];
password: Scalars['String']['input'];
roleIds: Array<Scalars['ID']['input']>;
};
export type CreateAssetInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
file: Scalars['Upload']['input'];
tags?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type CreateAssetResult = Asset | MimeTypeError;
export type CreateChannelInput = {
availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
defaultCurrencyCode?: InputMaybe<CurrencyCode>;
defaultLanguageCode: LanguageCode;
defaultShippingZoneId: Scalars['ID']['input'];
defaultTaxZoneId: Scalars['ID']['input'];
outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
pricesIncludeTax: Scalars['Boolean']['input'];
sellerId?: InputMaybe<Scalars['ID']['input']>;
token: Scalars['String']['input'];
trackInventory?: InputMaybe<Scalars['Boolean']['input']>;
};
export type CreateChannelResult = Channel | LanguageNotAvailableError;
export type CreateCollectionInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
filters: Array<ConfigurableOperationInput>;
inheritFilters?: InputMaybe<Scalars['Boolean']['input']>;
isPrivate?: InputMaybe<Scalars['Boolean']['input']>;
parentId?: InputMaybe<Scalars['ID']['input']>;
translations: Array<CreateCollectionTranslationInput>;
};
export type CreateCollectionTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description: Scalars['String']['input'];
languageCode: LanguageCode;
name: Scalars['String']['input'];
slug: Scalars['String']['input'];
};
export type CreateCountryInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled: Scalars['Boolean']['input'];
translations: Array<CountryTranslationInput>;
};
export type CreateCustomerGroupInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
customerIds?: InputMaybe<Array<Scalars['ID']['input']>>;
name: Scalars['String']['input'];
};
export type CreateCustomerInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress: Scalars['String']['input'];
firstName: Scalars['String']['input'];
lastName: Scalars['String']['input'];
phoneNumber?: InputMaybe<Scalars['String']['input']>;
title?: InputMaybe<Scalars['String']['input']>;
};
export type CreateCustomerResult = Customer | EmailAddressConflictError;
export type CreateFacetInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
isPrivate: Scalars['Boolean']['input'];
translations: Array<FacetTranslationInput>;
values?: InputMaybe<Array<CreateFacetValueWithFacetInput>>;
};
export type CreateFacetValueInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
facetId: Scalars['ID']['input'];
translations: Array<FacetValueTranslationInput>;
};
export type CreateFacetValueWithFacetInput = {
code: Scalars['String']['input'];
translations: Array<FacetValueTranslationInput>;
};
/** Returned if an error is thrown in a FulfillmentHandler's createFulfillment method */
export type CreateFulfillmentError = ErrorResult & {
__typename?: 'CreateFulfillmentError';
errorCode: ErrorCode;
fulfillmentHandlerError: Scalars['String']['output'];
message: Scalars['String']['output'];
};
export type CreateGroupOptionInput = {
code: Scalars['String']['input'];
translations: Array<ProductOptionGroupTranslationInput>;
};
export type CreatePaymentMethodInput = {
checker?: InputMaybe<ConfigurableOperationInput>;
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled: Scalars['Boolean']['input'];
handler: ConfigurableOperationInput;
translations: Array<PaymentMethodTranslationInput>;
};
export type CreateProductCustomFieldsInput = {
featuredReviewId?: InputMaybe<Scalars['ID']['input']>;
reviewCount?: InputMaybe<Scalars['Float']['input']>;
reviewRating?: InputMaybe<Scalars['Float']['input']>;
};
export type CreateProductInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<CreateProductCustomFieldsInput>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
translations: Array<ProductTranslationInput>;
};
export type CreateProductOptionGroupInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
options: Array<CreateGroupOptionInput>;
translations: Array<ProductOptionGroupTranslationInput>;
};
export type CreateProductOptionInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
productOptionGroupId: Scalars['ID']['input'];
translations: Array<ProductOptionGroupTranslationInput>;
};
export type CreateProductVariantInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
optionIds?: InputMaybe<Array<Scalars['ID']['input']>>;
outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
price?: InputMaybe<Scalars['Money']['input']>;
productId: Scalars['ID']['input'];
sku: Scalars['String']['input'];
stockLevels?: InputMaybe<Array<StockLevelInput>>;
stockOnHand?: InputMaybe<Scalars['Int']['input']>;
taxCategoryId?: InputMaybe<Scalars['ID']['input']>;
trackInventory?: InputMaybe<GlobalFlag>;
translations: Array<ProductVariantTranslationInput>;
useGlobalOutOfStockThreshold?: InputMaybe<Scalars['Boolean']['input']>;
};
export type CreateProductVariantOptionInput = {
code: Scalars['String']['input'];
optionGroupId: Scalars['ID']['input'];
translations: Array<ProductOptionTranslationInput>;
};
export type CreatePromotionInput = {
actions: Array<ConfigurableOperationInput>;
conditions: Array<ConfigurableOperationInput>;
couponCode?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled: Scalars['Boolean']['input'];
endsAt?: InputMaybe<Scalars['DateTime']['input']>;
perCustomerUsageLimit?: InputMaybe<Scalars['Int']['input']>;
startsAt?: InputMaybe<Scalars['DateTime']['input']>;
translations: Array<PromotionTranslationInput>;
};
export type CreatePromotionResult = MissingConditionsError | Promotion;
export type CreateProvinceInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled: Scalars['Boolean']['input'];
translations: Array<ProvinceTranslationInput>;
};
export type CreateRoleInput = {
channelIds?: InputMaybe<Array<Scalars['ID']['input']>>;
code: Scalars['String']['input'];
description: Scalars['String']['input'];
permissions: Array<Permission>;
};
export type CreateSellerInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
name: Scalars['String']['input'];
};
export type CreateShippingMethodInput = {
calculator: ConfigurableOperationInput;
checker: ConfigurableOperationInput;
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
fulfillmentHandler: Scalars['String']['input'];
translations: Array<ShippingMethodTranslationInput>;
};
export type CreateStockLocationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
name: Scalars['String']['input'];
};
export type CreateTagInput = {
value: Scalars['String']['input'];
};
export type CreateTaxCategoryInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
isDefault?: InputMaybe<Scalars['Boolean']['input']>;
name: Scalars['String']['input'];
};
export type CreateTaxRateInput = {
categoryId: Scalars['ID']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
customerGroupId?: InputMaybe<Scalars['ID']['input']>;
enabled: Scalars['Boolean']['input'];
name: Scalars['String']['input'];
value: Scalars['Float']['input'];
zoneId: Scalars['ID']['input'];
};
export type CreateZoneInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
memberIds?: InputMaybe<Array<Scalars['ID']['input']>>;
name: Scalars['String']['input'];
};
/**
* @description
* ISO 4217 currency code
*
* @docsCategory common
*/
export enum CurrencyCode {
/** United Arab Emirates dirham */
AED = 'AED',
/** Afghan afghani */
AFN = 'AFN',
/** Albanian lek */
ALL = 'ALL',
/** Armenian dram */
AMD = 'AMD',
/** Netherlands Antillean guilder */
ANG = 'ANG',
/** Angolan kwanza */
AOA = 'AOA',
/** Argentine peso */
ARS = 'ARS',
/** Australian dollar */
AUD = 'AUD',
/** Aruban florin */
AWG = 'AWG',
/** Azerbaijani manat */
AZN = 'AZN',
/** Bosnia and Herzegovina convertible mark */
BAM = 'BAM',
/** Barbados dollar */
BBD = 'BBD',
/** Bangladeshi taka */
BDT = 'BDT',
/** Bulgarian lev */
BGN = 'BGN',
/** Bahraini dinar */
BHD = 'BHD',
/** Burundian franc */
BIF = 'BIF',
/** Bermudian dollar */
BMD = 'BMD',
/** Brunei dollar */
BND = 'BND',
/** Boliviano */
BOB = 'BOB',
/** Brazilian real */
BRL = 'BRL',
/** Bahamian dollar */
BSD = 'BSD',
/** Bhutanese ngultrum */
BTN = 'BTN',
/** Botswana pula */
BWP = 'BWP',
/** Belarusian ruble */
BYN = 'BYN',
/** Belize dollar */
BZD = 'BZD',
/** Canadian dollar */
CAD = 'CAD',
/** Congolese franc */
CDF = 'CDF',
/** Swiss franc */
CHF = 'CHF',
/** Chilean peso */
CLP = 'CLP',
/** Renminbi (Chinese) yuan */
CNY = 'CNY',
/** Colombian peso */
COP = 'COP',
/** Costa Rican colon */
CRC = 'CRC',
/** Cuban convertible peso */
CUC = 'CUC',
/** Cuban peso */
CUP = 'CUP',
/** Cape Verde escudo */
CVE = 'CVE',
/** Czech koruna */
CZK = 'CZK',
/** Djiboutian franc */
DJF = 'DJF',
/** Danish krone */
DKK = 'DKK',
/** Dominican peso */
DOP = 'DOP',
/** Algerian dinar */
DZD = 'DZD',
/** Egyptian pound */
EGP = 'EGP',
/** Eritrean nakfa */
ERN = 'ERN',
/** Ethiopian birr */
ETB = 'ETB',
/** Euro */
EUR = 'EUR',
/** Fiji dollar */
FJD = 'FJD',
/** Falkland Islands pound */
FKP = 'FKP',
/** Pound sterling */
GBP = 'GBP',
/** Georgian lari */
GEL = 'GEL',
/** Ghanaian cedi */
GHS = 'GHS',
/** Gibraltar pound */
GIP = 'GIP',
/** Gambian dalasi */
GMD = 'GMD',
/** Guinean franc */
GNF = 'GNF',
/** Guatemalan quetzal */
GTQ = 'GTQ',
/** Guyanese dollar */
GYD = 'GYD',
/** Hong Kong dollar */
HKD = 'HKD',
/** Honduran lempira */
HNL = 'HNL',
/** Croatian kuna */
HRK = 'HRK',
/** Haitian gourde */
HTG = 'HTG',
/** Hungarian forint */
HUF = 'HUF',
/** Indonesian rupiah */
IDR = 'IDR',
/** Israeli new shekel */
ILS = 'ILS',
/** Indian rupee */
INR = 'INR',
/** Iraqi dinar */
IQD = 'IQD',
/** Iranian rial */
IRR = 'IRR',
/** Icelandic króna */
ISK = 'ISK',
/** Jamaican dollar */
JMD = 'JMD',
/** Jordanian dinar */
JOD = 'JOD',
/** Japanese yen */
JPY = 'JPY',
/** Kenyan shilling */
KES = 'KES',
/** Kyrgyzstani som */
KGS = 'KGS',
/** Cambodian riel */
KHR = 'KHR',
/** Comoro franc */
KMF = 'KMF',
/** North Korean won */
KPW = 'KPW',
/** South Korean won */
KRW = 'KRW',
/** Kuwaiti dinar */
KWD = 'KWD',
/** Cayman Islands dollar */
KYD = 'KYD',
/** Kazakhstani tenge */
KZT = 'KZT',
/** Lao kip */
LAK = 'LAK',
/** Lebanese pound */
LBP = 'LBP',
/** Sri Lankan rupee */
LKR = 'LKR',
/** Liberian dollar */
LRD = 'LRD',
/** Lesotho loti */
LSL = 'LSL',
/** Libyan dinar */
LYD = 'LYD',
/** Moroccan dirham */
MAD = 'MAD',
/** Moldovan leu */
MDL = 'MDL',
/** Malagasy ariary */
MGA = 'MGA',
/** Macedonian denar */
MKD = 'MKD',
/** Myanmar kyat */
MMK = 'MMK',
/** Mongolian tögrög */
MNT = 'MNT',
/** Macanese pataca */
MOP = 'MOP',
/** Mauritanian ouguiya */
MRU = 'MRU',
/** Mauritian rupee */
MUR = 'MUR',
/** Maldivian rufiyaa */
MVR = 'MVR',
/** Malawian kwacha */
MWK = 'MWK',
/** Mexican peso */
MXN = 'MXN',
/** Malaysian ringgit */
MYR = 'MYR',
/** Mozambican metical */
MZN = 'MZN',
/** Namibian dollar */
NAD = 'NAD',
/** Nigerian naira */
NGN = 'NGN',
/** Nicaraguan córdoba */
NIO = 'NIO',
/** Norwegian krone */
NOK = 'NOK',
/** Nepalese rupee */
NPR = 'NPR',
/** New Zealand dollar */
NZD = 'NZD',
/** Omani rial */
OMR = 'OMR',
/** Panamanian balboa */
PAB = 'PAB',
/** Peruvian sol */
PEN = 'PEN',
/** Papua New Guinean kina */
PGK = 'PGK',
/** Philippine peso */
PHP = 'PHP',
/** Pakistani rupee */
PKR = 'PKR',
/** Polish złoty */
PLN = 'PLN',
/** Paraguayan guaraní */
PYG = 'PYG',
/** Qatari riyal */
QAR = 'QAR',
/** Romanian leu */
RON = 'RON',
/** Serbian dinar */
RSD = 'RSD',
/** Russian ruble */
RUB = 'RUB',
/** Rwandan franc */
RWF = 'RWF',
/** Saudi riyal */
SAR = 'SAR',
/** Solomon Islands dollar */
SBD = 'SBD',
/** Seychelles rupee */
SCR = 'SCR',
/** Sudanese pound */
SDG = 'SDG',
/** Swedish krona/kronor */
SEK = 'SEK',
/** Singapore dollar */
SGD = 'SGD',
/** Saint Helena pound */
SHP = 'SHP',
/** Sierra Leonean leone */
SLL = 'SLL',
/** Somali shilling */
SOS = 'SOS',
/** Surinamese dollar */
SRD = 'SRD',
/** South Sudanese pound */
SSP = 'SSP',
/** São Tomé and Príncipe dobra */
STN = 'STN',
/** Salvadoran colón */
SVC = 'SVC',
/** Syrian pound */
SYP = 'SYP',
/** Swazi lilangeni */
SZL = 'SZL',
/** Thai baht */
THB = 'THB',
/** Tajikistani somoni */
TJS = 'TJS',
/** Turkmenistan manat */
TMT = 'TMT',
/** Tunisian dinar */
TND = 'TND',
/** Tongan paʻanga */
TOP = 'TOP',
/** Turkish lira */
TRY = 'TRY',
/** Trinidad and Tobago dollar */
TTD = 'TTD',
/** New Taiwan dollar */
TWD = 'TWD',
/** Tanzanian shilling */
TZS = 'TZS',
/** Ukrainian hryvnia */
UAH = 'UAH',
/** Ugandan shilling */
UGX = 'UGX',
/** United States dollar */
USD = 'USD',
/** Uruguayan peso */
UYU = 'UYU',
/** Uzbekistan som */
UZS = 'UZS',
/** Venezuelan bolívar soberano */
VES = 'VES',
/** Vietnamese đồng */
VND = 'VND',
/** Vanuatu vatu */
VUV = 'VUV',
/** Samoan tala */
WST = 'WST',
/** CFA franc BEAC */
XAF = 'XAF',
/** East Caribbean dollar */
XCD = 'XCD',
/** CFA franc BCEAO */
XOF = 'XOF',
/** CFP franc (franc Pacifique) */
XPF = 'XPF',
/** Yemeni rial */
YER = 'YER',
/** South African rand */
ZAR = 'ZAR',
/** Zambian kwacha */
ZMW = 'ZMW',
/** Zimbabwean dollar */
ZWL = 'ZWL',
}
export type CurrentUser = {
__typename?: 'CurrentUser';
channels: Array<CurrentUserChannel>;
id: Scalars['ID']['output'];
identifier: Scalars['String']['output'];
};
export type CurrentUserChannel = {
__typename?: 'CurrentUserChannel';
code: Scalars['String']['output'];
id: Scalars['ID']['output'];
permissions: Array<Permission>;
token: Scalars['String']['output'];
};
export type CustomField = {
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type CustomFieldConfig =
| BooleanCustomFieldConfig
| DateTimeCustomFieldConfig
| FloatCustomFieldConfig
| IntCustomFieldConfig
| LocaleStringCustomFieldConfig
| LocaleTextCustomFieldConfig
| RelationCustomFieldConfig
| StringCustomFieldConfig
| TextCustomFieldConfig;
export type CustomFields = {
__typename?: 'CustomFields';
Address: Array<CustomFieldConfig>;
Administrator: Array<CustomFieldConfig>;
Asset: Array<CustomFieldConfig>;
Channel: Array<CustomFieldConfig>;
Collection: Array<CustomFieldConfig>;
Customer: Array<CustomFieldConfig>;
CustomerGroup: Array<CustomFieldConfig>;
Facet: Array<CustomFieldConfig>;
FacetValue: Array<CustomFieldConfig>;
Fulfillment: Array<CustomFieldConfig>;
GlobalSettings: Array<CustomFieldConfig>;
Order: Array<CustomFieldConfig>;
OrderLine: Array<CustomFieldConfig>;
PaymentMethod: Array<CustomFieldConfig>;
Product: Array<CustomFieldConfig>;
ProductOption: Array<CustomFieldConfig>;
ProductOptionGroup: Array<CustomFieldConfig>;
ProductVariant: Array<CustomFieldConfig>;
Promotion: Array<CustomFieldConfig>;
Region: Array<CustomFieldConfig>;
Seller: Array<CustomFieldConfig>;
ShippingMethod: Array<CustomFieldConfig>;
StockLocation: Array<CustomFieldConfig>;
TaxCategory: Array<CustomFieldConfig>;
TaxRate: Array<CustomFieldConfig>;
User: Array<CustomFieldConfig>;
Zone: Array<CustomFieldConfig>;
};
export type Customer = Node & {
__typename?: 'Customer';
addresses?: Maybe<Array<Address>>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
emailAddress: Scalars['String']['output'];
firstName: Scalars['String']['output'];
groups: Array<CustomerGroup>;
history: HistoryEntryList;
id: Scalars['ID']['output'];
lastName: Scalars['String']['output'];
orders: OrderList;
phoneNumber?: Maybe<Scalars['String']['output']>;
title?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
user?: Maybe<User>;
};
export type CustomerHistoryArgs = {
options?: InputMaybe<HistoryEntryListOptions>;
};
export type CustomerOrdersArgs = {
options?: InputMaybe<OrderListOptions>;
};
export type CustomerFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
emailAddress?: InputMaybe<StringOperators>;
firstName?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
lastName?: InputMaybe<StringOperators>;
phoneNumber?: InputMaybe<StringOperators>;
postalCode?: InputMaybe<StringOperators>;
title?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CustomerGroup = Node & {
__typename?: 'CustomerGroup';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
customers: CustomerList;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type CustomerGroupCustomersArgs = {
options?: InputMaybe<CustomerListOptions>;
};
export type CustomerGroupFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CustomerGroupList = PaginatedList & {
__typename?: 'CustomerGroupList';
items: Array<CustomerGroup>;
totalItems: Scalars['Int']['output'];
};
export type CustomerGroupListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CustomerGroupFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CustomerGroupSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type CustomerGroupSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type CustomerList = PaginatedList & {
__typename?: 'CustomerList';
items: Array<Customer>;
totalItems: Scalars['Int']['output'];
};
export type CustomerListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CustomerFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CustomerSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type CustomerSortParameter = {
createdAt?: InputMaybe<SortOrder>;
emailAddress?: InputMaybe<SortOrder>;
firstName?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
lastName?: InputMaybe<SortOrder>;
phoneNumber?: InputMaybe<SortOrder>;
title?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
/** Operators for filtering on a list of Date fields */
export type DateListOperators = {
inList: Scalars['DateTime']['input'];
};
/** Operators for filtering on a DateTime field */
export type DateOperators = {
after?: InputMaybe<Scalars['DateTime']['input']>;
before?: InputMaybe<Scalars['DateTime']['input']>;
between?: InputMaybe<DateRange>;
eq?: InputMaybe<Scalars['DateTime']['input']>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
};
export type DateRange = {
end: Scalars['DateTime']['input'];
start: Scalars['DateTime']['input'];
};
/**
* Expects the same validation formats as the `<input type="datetime-local">` HTML element.
* See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes
*/
export type DateTimeCustomFieldConfig = CustomField & {
__typename?: 'DateTimeCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['String']['output']>;
min?: Maybe<Scalars['String']['output']>;
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
step?: Maybe<Scalars['Int']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type DeleteAssetInput = {
assetId: Scalars['ID']['input'];
deleteFromAllChannels?: InputMaybe<Scalars['Boolean']['input']>;
force?: InputMaybe<Scalars['Boolean']['input']>;
};
export type DeleteAssetsInput = {
assetIds: Array<Scalars['ID']['input']>;
deleteFromAllChannels?: InputMaybe<Scalars['Boolean']['input']>;
force?: InputMaybe<Scalars['Boolean']['input']>;
};
export type DeleteStockLocationInput = {
id: Scalars['ID']['input'];
transferToLocationId?: InputMaybe<Scalars['ID']['input']>;
};
export type DeletionResponse = {
__typename?: 'DeletionResponse';
message?: Maybe<Scalars['String']['output']>;
result: DeletionResult;
};
export enum DeletionResult {
/** The entity was successfully deleted */
DELETED = 'DELETED',
/** Deletion did not take place, reason given in message */
NOT_DELETED = 'NOT_DELETED',
}
export type Discount = {
__typename?: 'Discount';
adjustmentSource: Scalars['String']['output'];
amount: Scalars['Money']['output'];
amountWithTax: Scalars['Money']['output'];
description: Scalars['String']['output'];
type: AdjustmentType;
};
/** Returned when attempting to create a Customer with an email address already registered to an existing User. */
export type EmailAddressConflictError = ErrorResult & {
__typename?: 'EmailAddressConflictError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if no OrderLines have been specified for the operation */
export type EmptyOrderLineSelectionError = ErrorResult & {
__typename?: 'EmptyOrderLineSelectionError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export enum ErrorCode {
ALREADY_REFUNDED_ERROR = 'ALREADY_REFUNDED_ERROR',
CANCEL_ACTIVE_ORDER_ERROR = 'CANCEL_ACTIVE_ORDER_ERROR',
CANCEL_PAYMENT_ERROR = 'CANCEL_PAYMENT_ERROR',
CHANNEL_DEFAULT_LANGUAGE_ERROR = 'CHANNEL_DEFAULT_LANGUAGE_ERROR',
COUPON_CODE_EXPIRED_ERROR = 'COUPON_CODE_EXPIRED_ERROR',
COUPON_CODE_INVALID_ERROR = 'COUPON_CODE_INVALID_ERROR',
COUPON_CODE_LIMIT_ERROR = 'COUPON_CODE_LIMIT_ERROR',
CREATE_FULFILLMENT_ERROR = 'CREATE_FULFILLMENT_ERROR',
EMAIL_ADDRESS_CONFLICT_ERROR = 'EMAIL_ADDRESS_CONFLICT_ERROR',
EMPTY_ORDER_LINE_SELECTION_ERROR = 'EMPTY_ORDER_LINE_SELECTION_ERROR',
FACET_IN_USE_ERROR = 'FACET_IN_USE_ERROR',
FULFILLMENT_STATE_TRANSITION_ERROR = 'FULFILLMENT_STATE_TRANSITION_ERROR',
GUEST_CHECKOUT_ERROR = 'GUEST_CHECKOUT_ERROR',
INELIGIBLE_SHIPPING_METHOD_ERROR = 'INELIGIBLE_SHIPPING_METHOD_ERROR',
INSUFFICIENT_STOCK_ERROR = 'INSUFFICIENT_STOCK_ERROR',
INSUFFICIENT_STOCK_ON_HAND_ERROR = 'INSUFFICIENT_STOCK_ON_HAND_ERROR',
INVALID_CREDENTIALS_ERROR = 'INVALID_CREDENTIALS_ERROR',
INVALID_FULFILLMENT_HANDLER_ERROR = 'INVALID_FULFILLMENT_HANDLER_ERROR',
ITEMS_ALREADY_FULFILLED_ERROR = 'ITEMS_ALREADY_FULFILLED_ERROR',
LANGUAGE_NOT_AVAILABLE_ERROR = 'LANGUAGE_NOT_AVAILABLE_ERROR',
MANUAL_PAYMENT_STATE_ERROR = 'MANUAL_PAYMENT_STATE_ERROR',
MIME_TYPE_ERROR = 'MIME_TYPE_ERROR',
MISSING_CONDITIONS_ERROR = 'MISSING_CONDITIONS_ERROR',
MULTIPLE_ORDER_ERROR = 'MULTIPLE_ORDER_ERROR',
NATIVE_AUTH_STRATEGY_ERROR = 'NATIVE_AUTH_STRATEGY_ERROR',
NEGATIVE_QUANTITY_ERROR = 'NEGATIVE_QUANTITY_ERROR',
NOTHING_TO_REFUND_ERROR = 'NOTHING_TO_REFUND_ERROR',
NO_ACTIVE_ORDER_ERROR = 'NO_ACTIVE_ORDER_ERROR',
NO_CHANGES_SPECIFIED_ERROR = 'NO_CHANGES_SPECIFIED_ERROR',
ORDER_LIMIT_ERROR = 'ORDER_LIMIT_ERROR',
ORDER_MODIFICATION_ERROR = 'ORDER_MODIFICATION_ERROR',
ORDER_MODIFICATION_STATE_ERROR = 'ORDER_MODIFICATION_STATE_ERROR',
ORDER_STATE_TRANSITION_ERROR = 'ORDER_STATE_TRANSITION_ERROR',
PAYMENT_METHOD_MISSING_ERROR = 'PAYMENT_METHOD_MISSING_ERROR',
PAYMENT_ORDER_MISMATCH_ERROR = 'PAYMENT_ORDER_MISMATCH_ERROR',
PAYMENT_STATE_TRANSITION_ERROR = 'PAYMENT_STATE_TRANSITION_ERROR',
PRODUCT_OPTION_IN_USE_ERROR = 'PRODUCT_OPTION_IN_USE_ERROR',
QUANTITY_TOO_GREAT_ERROR = 'QUANTITY_TOO_GREAT_ERROR',
REFUND_ORDER_STATE_ERROR = 'REFUND_ORDER_STATE_ERROR',
REFUND_PAYMENT_ID_MISSING_ERROR = 'REFUND_PAYMENT_ID_MISSING_ERROR',
REFUND_STATE_TRANSITION_ERROR = 'REFUND_STATE_TRANSITION_ERROR',
SETTLE_PAYMENT_ERROR = 'SETTLE_PAYMENT_ERROR',
UNKNOWN_ERROR = 'UNKNOWN_ERROR',
}
export type ErrorResult = {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Facet = Node & {
__typename?: 'Facet';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
isPrivate: Scalars['Boolean']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<FacetTranslation>;
updatedAt: Scalars['DateTime']['output'];
values: Array<FacetValue>;
};
export type FacetFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
isPrivate?: InputMaybe<BooleanOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type FacetInUseError = ErrorResult & {
__typename?: 'FacetInUseError';
errorCode: ErrorCode;
facetCode: Scalars['String']['output'];
message: Scalars['String']['output'];
productCount: Scalars['Int']['output'];
variantCount: Scalars['Int']['output'];
};
export type FacetList = PaginatedList & {
__typename?: 'FacetList';
items: Array<Facet>;
totalItems: Scalars['Int']['output'];
};
export type FacetListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<FacetFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<FacetSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type FacetSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type FacetTranslation = {
__typename?: 'FacetTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type FacetTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type FacetValue = Node & {
__typename?: 'FacetValue';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
facet: Facet;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<FacetValueTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
/**
* Used to construct boolean expressions for filtering search results
* by FacetValue ID. Examples:
*
* * ID=1 OR ID=2: `{ facetValueFilters: [{ or: [1,2] }] }`
* * ID=1 AND ID=2: `{ facetValueFilters: [{ and: 1 }, { and: 2 }] }`
* * ID=1 AND (ID=2 OR ID=3): `{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }`
*/
export type FacetValueFilterInput = {
and?: InputMaybe<Scalars['ID']['input']>;
or?: InputMaybe<Array<Scalars['ID']['input']>>;
};
export type FacetValueFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type FacetValueList = PaginatedList & {
__typename?: 'FacetValueList';
items: Array<FacetValue>;
totalItems: Scalars['Int']['output'];
};
export type FacetValueListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<FacetValueFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<FacetValueSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
/**
* Which FacetValues are present in the products returned
* by the search, and in what quantity.
*/
export type FacetValueResult = {
__typename?: 'FacetValueResult';
count: Scalars['Int']['output'];
facetValue: FacetValue;
};
export type FacetValueSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type FacetValueTranslation = {
__typename?: 'FacetValueTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type FacetValueTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type FloatCustomFieldConfig = CustomField & {
__typename?: 'FloatCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['Float']['output']>;
min?: Maybe<Scalars['Float']['output']>;
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
step?: Maybe<Scalars['Float']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type FulfillOrderInput = {
handler: ConfigurableOperationInput;
lines: Array<OrderLineInput>;
};
export type Fulfillment = Node & {
__typename?: 'Fulfillment';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
lines: Array<FulfillmentLine>;
method: Scalars['String']['output'];
nextStates: Array<Scalars['String']['output']>;
state: Scalars['String']['output'];
/** @deprecated Use the `lines` field instead */
summary: Array<FulfillmentLine>;
trackingCode?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type FulfillmentLine = {
__typename?: 'FulfillmentLine';
fulfillment: Fulfillment;
fulfillmentId: Scalars['ID']['output'];
orderLine: OrderLine;
orderLineId: Scalars['ID']['output'];
quantity: Scalars['Int']['output'];
};
/** Returned when there is an error in transitioning the Fulfillment state */
export type FulfillmentStateTransitionError = ErrorResult & {
__typename?: 'FulfillmentStateTransitionError';
errorCode: ErrorCode;
fromState: Scalars['String']['output'];
message: Scalars['String']['output'];
toState: Scalars['String']['output'];
transitionError: Scalars['String']['output'];
};
export enum GlobalFlag {
FALSE = 'FALSE',
INHERIT = 'INHERIT',
TRUE = 'TRUE',
}
export type GlobalSettings = {
__typename?: 'GlobalSettings';
availableLanguages: Array<LanguageCode>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
outOfStockThreshold: Scalars['Int']['output'];
serverConfig: ServerConfig;
trackInventory: Scalars['Boolean']['output'];
updatedAt: Scalars['DateTime']['output'];
};
/** Returned when attempting to set the Customer on a guest checkout when the configured GuestCheckoutStrategy does not allow it. */
export type GuestCheckoutError = ErrorResult & {
__typename?: 'GuestCheckoutError';
errorCode: ErrorCode;
errorDetail: Scalars['String']['output'];
message: Scalars['String']['output'];
};
export type HistoryEntry = Node & {
__typename?: 'HistoryEntry';
administrator?: Maybe<Administrator>;
createdAt: Scalars['DateTime']['output'];
data: Scalars['JSON']['output'];
id: Scalars['ID']['output'];
isPublic: Scalars['Boolean']['output'];
type: HistoryEntryType;
updatedAt: Scalars['DateTime']['output'];
};
export type HistoryEntryFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
isPublic?: InputMaybe<BooleanOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type HistoryEntryList = PaginatedList & {
__typename?: 'HistoryEntryList';
items: Array<HistoryEntry>;
totalItems: Scalars['Int']['output'];
};
export type HistoryEntryListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<HistoryEntryFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<HistoryEntrySortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type HistoryEntrySortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export enum HistoryEntryType {
CUSTOMER_ADDED_TO_GROUP = 'CUSTOMER_ADDED_TO_GROUP',
CUSTOMER_ADDRESS_CREATED = 'CUSTOMER_ADDRESS_CREATED',
CUSTOMER_ADDRESS_DELETED = 'CUSTOMER_ADDRESS_DELETED',
CUSTOMER_ADDRESS_UPDATED = 'CUSTOMER_ADDRESS_UPDATED',
CUSTOMER_DETAIL_UPDATED = 'CUSTOMER_DETAIL_UPDATED',
CUSTOMER_EMAIL_UPDATE_REQUESTED = 'CUSTOMER_EMAIL_UPDATE_REQUESTED',
CUSTOMER_EMAIL_UPDATE_VERIFIED = 'CUSTOMER_EMAIL_UPDATE_VERIFIED',
CUSTOMER_NOTE = 'CUSTOMER_NOTE',
CUSTOMER_PASSWORD_RESET_REQUESTED = 'CUSTOMER_PASSWORD_RESET_REQUESTED',
CUSTOMER_PASSWORD_RESET_VERIFIED = 'CUSTOMER_PASSWORD_RESET_VERIFIED',
CUSTOMER_PASSWORD_UPDATED = 'CUSTOMER_PASSWORD_UPDATED',
CUSTOMER_REGISTERED = 'CUSTOMER_REGISTERED',
CUSTOMER_REMOVED_FROM_GROUP = 'CUSTOMER_REMOVED_FROM_GROUP',
CUSTOMER_VERIFIED = 'CUSTOMER_VERIFIED',
ORDER_CANCELLATION = 'ORDER_CANCELLATION',
ORDER_COUPON_APPLIED = 'ORDER_COUPON_APPLIED',
ORDER_COUPON_REMOVED = 'ORDER_COUPON_REMOVED',
ORDER_FULFILLMENT = 'ORDER_FULFILLMENT',
ORDER_FULFILLMENT_TRANSITION = 'ORDER_FULFILLMENT_TRANSITION',
ORDER_MODIFIED = 'ORDER_MODIFIED',
ORDER_NOTE = 'ORDER_NOTE',
ORDER_PAYMENT_TRANSITION = 'ORDER_PAYMENT_TRANSITION',
ORDER_REFUND_TRANSITION = 'ORDER_REFUND_TRANSITION',
ORDER_STATE_TRANSITION = 'ORDER_STATE_TRANSITION',
}
/** Operators for filtering on a list of ID fields */
export type IdListOperators = {
inList: Scalars['ID']['input'];
};
/** Operators for filtering on an ID field */
export type IdOperators = {
eq?: InputMaybe<Scalars['String']['input']>;
in?: InputMaybe<Array<Scalars['String']['input']>>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
notEq?: InputMaybe<Scalars['String']['input']>;
notIn?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type ImportInfo = {
__typename?: 'ImportInfo';
errors?: Maybe<Array<Scalars['String']['output']>>;
imported: Scalars['Int']['output'];
processed: Scalars['Int']['output'];
};
/** Returned when attempting to set a ShippingMethod for which the Order is not eligible */
export type IneligibleShippingMethodError = ErrorResult & {
__typename?: 'IneligibleShippingMethodError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when attempting to add more items to the Order than are available */
export type InsufficientStockError = ErrorResult & {
__typename?: 'InsufficientStockError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
order: Order;
quantityAvailable: Scalars['Int']['output'];
};
/**
* Returned if attempting to create a Fulfillment when there is insufficient
* stockOnHand of a ProductVariant to satisfy the requested quantity.
*/
export type InsufficientStockOnHandError = ErrorResult & {
__typename?: 'InsufficientStockOnHandError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
productVariantId: Scalars['ID']['output'];
productVariantName: Scalars['String']['output'];
stockOnHand: Scalars['Int']['output'];
};
export type IntCustomFieldConfig = CustomField & {
__typename?: 'IntCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['Int']['output']>;
min?: Maybe<Scalars['Int']['output']>;
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
step?: Maybe<Scalars['Int']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
/** Returned if the user authentication credentials are not valid */
export type InvalidCredentialsError = ErrorResult & {
__typename?: 'InvalidCredentialsError';
authenticationError: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the specified FulfillmentHandler code is not valid */
export type InvalidFulfillmentHandlerError = ErrorResult & {
__typename?: 'InvalidFulfillmentHandlerError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the specified items are already part of a Fulfillment */
export type ItemsAlreadyFulfilledError = ErrorResult & {
__typename?: 'ItemsAlreadyFulfilledError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Job = Node & {
__typename?: 'Job';
attempts: Scalars['Int']['output'];
createdAt: Scalars['DateTime']['output'];
data?: Maybe<Scalars['JSON']['output']>;
duration: Scalars['Int']['output'];
error?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
isSettled: Scalars['Boolean']['output'];
progress: Scalars['Float']['output'];
queueName: Scalars['String']['output'];
result?: Maybe<Scalars['JSON']['output']>;
retries: Scalars['Int']['output'];
settledAt?: Maybe<Scalars['DateTime']['output']>;
startedAt?: Maybe<Scalars['DateTime']['output']>;
state: JobState;
};
export type JobBufferSize = {
__typename?: 'JobBufferSize';
bufferId: Scalars['String']['output'];
size: Scalars['Int']['output'];
};
export type JobFilterParameter = {
attempts?: InputMaybe<NumberOperators>;
createdAt?: InputMaybe<DateOperators>;
duration?: InputMaybe<NumberOperators>;
id?: InputMaybe<IdOperators>;
isSettled?: InputMaybe<BooleanOperators>;
progress?: InputMaybe<NumberOperators>;
queueName?: InputMaybe<StringOperators>;
retries?: InputMaybe<NumberOperators>;
settledAt?: InputMaybe<DateOperators>;
startedAt?: InputMaybe<DateOperators>;
state?: InputMaybe<StringOperators>;
};
export type JobList = PaginatedList & {
__typename?: 'JobList';
items: Array<Job>;
totalItems: Scalars['Int']['output'];
};
export type JobListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<JobFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<JobSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type JobQueue = {
__typename?: 'JobQueue';
name: Scalars['String']['output'];
running: Scalars['Boolean']['output'];
};
export type JobSortParameter = {
attempts?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
duration?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
progress?: InputMaybe<SortOrder>;
queueName?: InputMaybe<SortOrder>;
retries?: InputMaybe<SortOrder>;
settledAt?: InputMaybe<SortOrder>;
startedAt?: InputMaybe<SortOrder>;
};
/**
* @description
* The state of a Job in the JobQueue
*
* @docsCategory common
*/
export enum JobState {
CANCELLED = 'CANCELLED',
COMPLETED = 'COMPLETED',
FAILED = 'FAILED',
PENDING = 'PENDING',
RETRYING = 'RETRYING',
RUNNING = 'RUNNING',
}
/**
* @description
* Languages in the form of a ISO 639-1 language code with optional
* region or script modifier (e.g. de_AT). The selection available is based
* on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)
* and includes the major spoken languages of the world and any widely-used variants.
*
* @docsCategory common
*/
export enum LanguageCode {
/** Afrikaans */
af = 'af',
/** Akan */
ak = 'ak',
/** Amharic */
am = 'am',
/** Arabic */
ar = 'ar',
/** Assamese */
as = 'as',
/** Azerbaijani */
az = 'az',
/** Belarusian */
be = 'be',
/** Bulgarian */
bg = 'bg',
/** Bambara */
bm = 'bm',
/** Bangla */
bn = 'bn',
/** Tibetan */
bo = 'bo',
/** Breton */
br = 'br',
/** Bosnian */
bs = 'bs',
/** Catalan */
ca = 'ca',
/** Chechen */
ce = 'ce',
/** Corsican */
co = 'co',
/** Czech */
cs = 'cs',
/** Church Slavic */
cu = 'cu',
/** Welsh */
cy = 'cy',
/** Danish */
da = 'da',
/** German */
de = 'de',
/** Austrian German */
de_AT = 'de_AT',
/** Swiss High German */
de_CH = 'de_CH',
/** Dzongkha */
dz = 'dz',
/** Ewe */
ee = 'ee',
/** Greek */
el = 'el',
/** English */
en = 'en',
/** Australian English */
en_AU = 'en_AU',
/** Canadian English */
en_CA = 'en_CA',
/** British English */
en_GB = 'en_GB',
/** American English */
en_US = 'en_US',
/** Esperanto */
eo = 'eo',
/** Spanish */
es = 'es',
/** European Spanish */
es_ES = 'es_ES',
/** Mexican Spanish */
es_MX = 'es_MX',
/** Estonian */
et = 'et',
/** Basque */
eu = 'eu',
/** Persian */
fa = 'fa',
/** Dari */
fa_AF = 'fa_AF',
/** Fulah */
ff = 'ff',
/** Finnish */
fi = 'fi',
/** Faroese */
fo = 'fo',
/** French */
fr = 'fr',
/** Canadian French */
fr_CA = 'fr_CA',
/** Swiss French */
fr_CH = 'fr_CH',
/** Western Frisian */
fy = 'fy',
/** Irish */
ga = 'ga',
/** Scottish Gaelic */
gd = 'gd',
/** Galician */
gl = 'gl',
/** Gujarati */
gu = 'gu',
/** Manx */
gv = 'gv',
/** Hausa */
ha = 'ha',
/** Hebrew */
he = 'he',
/** Hindi */
hi = 'hi',
/** Croatian */
hr = 'hr',
/** Haitian Creole */
ht = 'ht',
/** Hungarian */
hu = 'hu',
/** Armenian */
hy = 'hy',
/** Interlingua */
ia = 'ia',
/** Indonesian */
id = 'id',
/** Igbo */
ig = 'ig',
/** Sichuan Yi */
ii = 'ii',
/** Icelandic */
is = 'is',
/** Italian */
it = 'it',
/** Japanese */
ja = 'ja',
/** Javanese */
jv = 'jv',
/** Georgian */
ka = 'ka',
/** Kikuyu */
ki = 'ki',
/** Kazakh */
kk = 'kk',
/** Kalaallisut */
kl = 'kl',
/** Khmer */
km = 'km',
/** Kannada */
kn = 'kn',
/** Korean */
ko = 'ko',
/** Kashmiri */
ks = 'ks',
/** Kurdish */
ku = 'ku',
/** Cornish */
kw = 'kw',
/** Kyrgyz */
ky = 'ky',
/** Latin */
la = 'la',
/** Luxembourgish */
lb = 'lb',
/** Ganda */
lg = 'lg',
/** Lingala */
ln = 'ln',
/** Lao */
lo = 'lo',
/** Lithuanian */
lt = 'lt',
/** Luba-Katanga */
lu = 'lu',
/** Latvian */
lv = 'lv',
/** Malagasy */
mg = 'mg',
/** Maori */
mi = 'mi',
/** Macedonian */
mk = 'mk',
/** Malayalam */
ml = 'ml',
/** Mongolian */
mn = 'mn',
/** Marathi */
mr = 'mr',
/** Malay */
ms = 'ms',
/** Maltese */
mt = 'mt',
/** Burmese */
my = 'my',
/** Norwegian Bokmål */
nb = 'nb',
/** North Ndebele */
nd = 'nd',
/** Nepali */
ne = 'ne',
/** Dutch */
nl = 'nl',
/** Flemish */
nl_BE = 'nl_BE',
/** Norwegian Nynorsk */
nn = 'nn',
/** Nyanja */
ny = 'ny',
/** Oromo */
om = 'om',
/** Odia */
or = 'or',
/** Ossetic */
os = 'os',
/** Punjabi */
pa = 'pa',
/** Polish */
pl = 'pl',
/** Pashto */
ps = 'ps',
/** Portuguese */
pt = 'pt',
/** Brazilian Portuguese */
pt_BR = 'pt_BR',
/** European Portuguese */
pt_PT = 'pt_PT',
/** Quechua */
qu = 'qu',
/** Romansh */
rm = 'rm',
/** Rundi */
rn = 'rn',
/** Romanian */
ro = 'ro',
/** Moldavian */
ro_MD = 'ro_MD',
/** Russian */
ru = 'ru',
/** Kinyarwanda */
rw = 'rw',
/** Sanskrit */
sa = 'sa',
/** Sindhi */
sd = 'sd',
/** Northern Sami */
se = 'se',
/** Sango */
sg = 'sg',
/** Sinhala */
si = 'si',
/** Slovak */
sk = 'sk',
/** Slovenian */
sl = 'sl',
/** Samoan */
sm = 'sm',
/** Shona */
sn = 'sn',
/** Somali */
so = 'so',
/** Albanian */
sq = 'sq',
/** Serbian */
sr = 'sr',
/** Southern Sotho */
st = 'st',
/** Sundanese */
su = 'su',
/** Swedish */
sv = 'sv',
/** Swahili */
sw = 'sw',
/** Congo Swahili */
sw_CD = 'sw_CD',
/** Tamil */
ta = 'ta',
/** Telugu */
te = 'te',
/** Tajik */
tg = 'tg',
/** Thai */
th = 'th',
/** Tigrinya */
ti = 'ti',
/** Turkmen */
tk = 'tk',
/** Tongan */
to = 'to',
/** Turkish */
tr = 'tr',
/** Tatar */
tt = 'tt',
/** Uyghur */
ug = 'ug',
/** Ukrainian */
uk = 'uk',
/** Urdu */
ur = 'ur',
/** Uzbek */
uz = 'uz',
/** Vietnamese */
vi = 'vi',
/** Volapük */
vo = 'vo',
/** Wolof */
wo = 'wo',
/** Xhosa */
xh = 'xh',
/** Yiddish */
yi = 'yi',
/** Yoruba */
yo = 'yo',
/** Chinese */
zh = 'zh',
/** Simplified Chinese */
zh_Hans = 'zh_Hans',
/** Traditional Chinese */
zh_Hant = 'zh_Hant',
/** Zulu */
zu = 'zu',
}
/** Returned if attempting to set a Channel's defaultLanguageCode to a language which is not enabled in GlobalSettings */
export type LanguageNotAvailableError = ErrorResult & {
__typename?: 'LanguageNotAvailableError';
errorCode: ErrorCode;
languageCode: Scalars['String']['output'];
message: Scalars['String']['output'];
};
export type LocaleStringCustomFieldConfig = CustomField & {
__typename?: 'LocaleStringCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
length?: Maybe<Scalars['Int']['output']>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
pattern?: Maybe<Scalars['String']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type LocaleTextCustomFieldConfig = CustomField & {
__typename?: 'LocaleTextCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type LocalizedString = {
__typename?: 'LocalizedString';
languageCode: LanguageCode;
value: Scalars['String']['output'];
};
export enum LogicalOperator {
AND = 'AND',
OR = 'OR',
}
export type ManualPaymentInput = {
metadata?: InputMaybe<Scalars['JSON']['input']>;
method: Scalars['String']['input'];
orderId: Scalars['ID']['input'];
transactionId?: InputMaybe<Scalars['String']['input']>;
};
/**
* Returned when a call to addManualPaymentToOrder is made but the Order
* is not in the required state.
*/
export type ManualPaymentStateError = ErrorResult & {
__typename?: 'ManualPaymentStateError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export enum MetricInterval {
Daily = 'Daily',
}
export type MetricSummary = {
__typename?: 'MetricSummary';
entries: Array<MetricSummaryEntry>;
interval: MetricInterval;
title: Scalars['String']['output'];
type: MetricType;
};
export type MetricSummaryEntry = {
__typename?: 'MetricSummaryEntry';
label: Scalars['String']['output'];
value: Scalars['Float']['output'];
};
export type MetricSummaryInput = {
interval: MetricInterval;
refresh?: InputMaybe<Scalars['Boolean']['input']>;
types: Array<MetricType>;
};
export enum MetricType {
AverageOrderValue = 'AverageOrderValue',
OrderCount = 'OrderCount',
OrderTotal = 'OrderTotal',
}
export type MimeTypeError = ErrorResult & {
__typename?: 'MimeTypeError';
errorCode: ErrorCode;
fileName: Scalars['String']['output'];
message: Scalars['String']['output'];
mimeType: Scalars['String']['output'];
};
/** Returned if a PromotionCondition has neither a couponCode nor any conditions set */
export type MissingConditionsError = ErrorResult & {
__typename?: 'MissingConditionsError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type ModifyOrderInput = {
addItems?: InputMaybe<Array<AddItemInput>>;
adjustOrderLines?: InputMaybe<Array<OrderLineInput>>;
couponCodes?: InputMaybe<Array<Scalars['String']['input']>>;
dryRun: Scalars['Boolean']['input'];
note?: InputMaybe<Scalars['String']['input']>;
options?: InputMaybe<ModifyOrderOptions>;
orderId: Scalars['ID']['input'];
refund?: InputMaybe<AdministratorRefundInput>;
surcharges?: InputMaybe<Array<SurchargeInput>>;
updateBillingAddress?: InputMaybe<UpdateOrderAddressInput>;
updateShippingAddress?: InputMaybe<UpdateOrderAddressInput>;
};
export type ModifyOrderOptions = {
freezePromotions?: InputMaybe<Scalars['Boolean']['input']>;
recalculateShipping?: InputMaybe<Scalars['Boolean']['input']>;
};
export type ModifyOrderResult =
| CouponCodeExpiredError
| CouponCodeInvalidError
| CouponCodeLimitError
| InsufficientStockError
| NegativeQuantityError
| NoChangesSpecifiedError
| Order
| OrderLimitError
| OrderModificationStateError
| PaymentMethodMissingError
| RefundPaymentIdMissingError;
export type MoveCollectionInput = {
collectionId: Scalars['ID']['input'];
index: Scalars['Int']['input'];
parentId: Scalars['ID']['input'];
};
/** Returned if an operation has specified OrderLines from multiple Orders */
export type MultipleOrderError = ErrorResult & {
__typename?: 'MultipleOrderError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Mutation = {
__typename?: 'Mutation';
/** Add Customers to a CustomerGroup */
addCustomersToGroup: CustomerGroup;
addFulfillmentToOrder: AddFulfillmentToOrderResult;
/** Adds an item to the draft Order. */
addItemToDraftOrder: UpdateOrderItemsResult;
/**
* Used to manually create a new Payment against an Order.
* This can be used by an Administrator when an Order is in the ArrangingPayment state.
*
* It is also used when a completed Order
* has been modified (using `modifyOrder`) and the price has increased. The extra payment
* can then be manually arranged by the administrator, and the details used to create a new
* Payment.
*/
addManualPaymentToOrder: AddManualPaymentToOrderResult;
/** Add members to a Zone */
addMembersToZone: Zone;
addNoteToCustomer: Customer;
addNoteToOrder: Order;
/** Add an OptionGroup to a Product */
addOptionGroupToProduct: Product;
/** Adjusts a draft OrderLine. If custom fields are defined on the OrderLine entity, a third argument 'customFields' of type `OrderLineCustomFieldsInput` will be available. */
adjustDraftOrderLine: UpdateOrderItemsResult;
/** Applies the given coupon code to the draft Order */
applyCouponCodeToDraftOrder: ApplyCouponCodeResult;
approveProductReview?: Maybe<ProductReview>;
/** Assign assets to channel */
assignAssetsToChannel: Array<Asset>;
/** Assigns Collections to the specified Channel */
assignCollectionsToChannel: Array<Collection>;
/** Assigns Facets to the specified Channel */
assignFacetsToChannel: Array<Facet>;
/** Assigns PaymentMethods to the specified Channel */
assignPaymentMethodsToChannel: Array<PaymentMethod>;
/** Assigns ProductVariants to the specified Channel */
assignProductVariantsToChannel: Array<ProductVariant>;
/** Assigns all ProductVariants of Product to the specified Channel */
assignProductsToChannel: Array<Product>;
/** Assigns Promotions to the specified Channel */
assignPromotionsToChannel: Array<Promotion>;
/** Assign a Role to an Administrator */
assignRoleToAdministrator: Administrator;
/** Assigns ShippingMethods to the specified Channel */
assignShippingMethodsToChannel: Array<ShippingMethod>;
/** Assigns StockLocations to the specified Channel */
assignStockLocationsToChannel: Array<StockLocation>;
/** Authenticates the user using a named authentication strategy */
authenticate: AuthenticationResult;
cancelJob: Job;
cancelOrder: CancelOrderResult;
cancelPayment: CancelPaymentResult;
/** Create a new Administrator */
createAdministrator: Administrator;
/** Create a new Asset */
createAssets: Array<CreateAssetResult>;
/** Create a new Channel */
createChannel: CreateChannelResult;
/** Create a new Collection */
createCollection: Collection;
/** Create a new Country */
createCountry: Country;
/** Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer. */
createCustomer: CreateCustomerResult;
/** Create a new Address and associate it with the Customer specified by customerId */
createCustomerAddress: Address;
/** Create a new CustomerGroup */
createCustomerGroup: CustomerGroup;
/** Creates a draft Order */
createDraftOrder: Order;
/** Create a new Facet */
createFacet: Facet;
/** Create one or more FacetValues */
createFacetValues: Array<FacetValue>;
/** Create existing PaymentMethod */
createPaymentMethod: PaymentMethod;
/** Create a new Product */
createProduct: Product;
/** Create a new ProductOption within a ProductOptionGroup */
createProductOption: ProductOption;
/** Create a new ProductOptionGroup */
createProductOptionGroup: ProductOptionGroup;
/** Create a set of ProductVariants based on the OptionGroups assigned to the given Product */
createProductVariants: Array<Maybe<ProductVariant>>;
createPromotion: CreatePromotionResult;
/** Create a new Province */
createProvince: Province;
/** Create a new Role */
createRole: Role;
/** Create a new Seller */
createSeller: Seller;
/** Create a new ShippingMethod */
createShippingMethod: ShippingMethod;
createStockLocation: StockLocation;
/** Create a new Tag */
createTag: Tag;
/** Create a new TaxCategory */
createTaxCategory: TaxCategory;
/** Create a new TaxRate */
createTaxRate: TaxRate;
/** Create a new Zone */
createZone: Zone;
/** Delete an Administrator */
deleteAdministrator: DeletionResponse;
/** Delete multiple Administrators */
deleteAdministrators: Array<DeletionResponse>;
/** Delete an Asset */
deleteAsset: DeletionResponse;
/** Delete multiple Assets */
deleteAssets: DeletionResponse;
/** Delete a Channel */
deleteChannel: DeletionResponse;
/** Delete multiple Channels */
deleteChannels: Array<DeletionResponse>;
/** Delete a Collection and all of its descendants */
deleteCollection: DeletionResponse;
/** Delete multiple Collections and all of their descendants */
deleteCollections: Array<DeletionResponse>;
/** Delete multiple Countries */
deleteCountries: Array<DeletionResponse>;
/** Delete a Country */
deleteCountry: DeletionResponse;
/** Delete a Customer */
deleteCustomer: DeletionResponse;
/** Update an existing Address */
deleteCustomerAddress: Success;
/** Delete a CustomerGroup */
deleteCustomerGroup: DeletionResponse;
/** Delete multiple CustomerGroups */
deleteCustomerGroups: Array<DeletionResponse>;
deleteCustomerNote: DeletionResponse;
/** Deletes Customers */
deleteCustomers: Array<DeletionResponse>;
/** Deletes a draft Order */
deleteDraftOrder: DeletionResponse;
/** Delete an existing Facet */
deleteFacet: DeletionResponse;
/** Delete one or more FacetValues */
deleteFacetValues: Array<DeletionResponse>;
/** Delete multiple existing Facets */
deleteFacets: Array<DeletionResponse>;
deleteOrderNote: DeletionResponse;
/** Delete a PaymentMethod */
deletePaymentMethod: DeletionResponse;
/** Delete multiple PaymentMethods */
deletePaymentMethods: Array<DeletionResponse>;
/** Delete a Product */
deleteProduct: DeletionResponse;
/** Delete a ProductOption */
deleteProductOption: DeletionResponse;
/** Delete a ProductVariant */
deleteProductVariant: DeletionResponse;
/** Delete multiple ProductVariants */
deleteProductVariants: Array<DeletionResponse>;
/** Delete multiple Products */
deleteProducts: Array<DeletionResponse>;
deletePromotion: DeletionResponse;
deletePromotions: Array<DeletionResponse>;
/** Delete a Province */
deleteProvince: DeletionResponse;
/** Delete an existing Role */
deleteRole: DeletionResponse;
/** Delete multiple Roles */
deleteRoles: Array<DeletionResponse>;
/** Delete a Seller */
deleteSeller: DeletionResponse;
/** Delete multiple Sellers */
deleteSellers: Array<DeletionResponse>;
/** Delete a ShippingMethod */
deleteShippingMethod: DeletionResponse;
/** Delete multiple ShippingMethods */
deleteShippingMethods: Array<DeletionResponse>;
deleteStockLocation: DeletionResponse;
deleteStockLocations: Array<DeletionResponse>;
/** Delete an existing Tag */
deleteTag: DeletionResponse;
/** Deletes multiple TaxCategories */
deleteTaxCategories: Array<DeletionResponse>;
/** Deletes a TaxCategory */
deleteTaxCategory: DeletionResponse;
/** Delete a TaxRate */
deleteTaxRate: DeletionResponse;
/** Delete multiple TaxRates */
deleteTaxRates: Array<DeletionResponse>;
/** Delete a Zone */
deleteZone: DeletionResponse;
/** Delete a Zone */
deleteZones: Array<DeletionResponse>;
flushBufferedJobs: Success;
importProducts?: Maybe<ImportInfo>;
/** Authenticates the user using the native authentication strategy. This mutation is an alias for `authenticate({ native: { ... }})` */
login: NativeAuthenticationResult;
logout: Success;
/**
* Allows an Order to be modified after it has been completed by the Customer. The Order must first
* be in the `Modifying` state.
*/
modifyOrder: ModifyOrderResult;
/** Move a Collection to a different parent or index */
moveCollection: Collection;
refundOrder: RefundOrderResult;
reindex: Job;
rejectProductReview?: Maybe<ProductReview>;
/** Removes Collections from the specified Channel */
removeCollectionsFromChannel: Array<Collection>;
/** Removes the given coupon code from the draft Order */
removeCouponCodeFromDraftOrder?: Maybe<Order>;
/** Remove Customers from a CustomerGroup */
removeCustomersFromGroup: CustomerGroup;
/** Remove an OrderLine from the draft Order */
removeDraftOrderLine: RemoveOrderItemsResult;
/** Removes Facets from the specified Channel */
removeFacetsFromChannel: Array<RemoveFacetFromChannelResult>;
/** Remove members from a Zone */
removeMembersFromZone: Zone;
/**
* Remove an OptionGroup from a Product. If the OptionGroup is in use by any ProductVariants
* the mutation will return a ProductOptionInUseError, and the OptionGroup will not be removed.
* Setting the `force` argument to `true` will override this and remove the OptionGroup anyway,
* as well as removing any of the group's options from the Product's ProductVariants.
*/
removeOptionGroupFromProduct: RemoveOptionGroupFromProductResult;
/** Removes PaymentMethods from the specified Channel */
removePaymentMethodsFromChannel: Array<PaymentMethod>;
/** Removes ProductVariants from the specified Channel */
removeProductVariantsFromChannel: Array<ProductVariant>;
/** Removes all ProductVariants of Product from the specified Channel */
removeProductsFromChannel: Array<Product>;
/** Removes Promotions from the specified Channel */
removePromotionsFromChannel: Array<Promotion>;
/** Remove all settled jobs in the given queues older than the given date. Returns the number of jobs deleted. */
removeSettledJobs: Scalars['Int']['output'];
/** Removes ShippingMethods from the specified Channel */
removeShippingMethodsFromChannel: Array<ShippingMethod>;
/** Removes StockLocations from the specified Channel */
removeStockLocationsFromChannel: Array<StockLocation>;
runPendingSearchIndexUpdates: Success;
setCustomerForDraftOrder: SetCustomerForDraftOrderResult;
/** Sets the billing address for a draft Order */
setDraftOrderBillingAddress: Order;
/** Allows any custom fields to be set for the active order */
setDraftOrderCustomFields: Order;
/** Sets the shipping address for a draft Order */
setDraftOrderShippingAddress: Order;
/** Sets the shipping method by id, which can be obtained with the `eligibleShippingMethodsForDraftOrder` query */
setDraftOrderShippingMethod: SetOrderShippingMethodResult;
setOrderCustomFields?: Maybe<Order>;
settlePayment: SettlePaymentResult;
settleRefund: SettleRefundResult;
transitionFulfillmentToState: TransitionFulfillmentToStateResult;
transitionOrderToState?: Maybe<TransitionOrderToStateResult>;
transitionPaymentToState: TransitionPaymentToStateResult;
/** Update the active (currently logged-in) Administrator */
updateActiveAdministrator: Administrator;
/** Update an existing Administrator */
updateAdministrator: Administrator;
/** Update an existing Asset */
updateAsset: Asset;
/** Update an existing Channel */
updateChannel: UpdateChannelResult;
/** Update an existing Collection */
updateCollection: Collection;
/** Update an existing Country */
updateCountry: Country;
/** Update an existing Customer */
updateCustomer: UpdateCustomerResult;
/** Update an existing Address */
updateCustomerAddress: Address;
/** Update an existing CustomerGroup */
updateCustomerGroup: CustomerGroup;
updateCustomerNote: HistoryEntry;
/** Update an existing Facet */
updateFacet: Facet;
/** Update one or more FacetValues */
updateFacetValues: Array<FacetValue>;
updateGlobalSettings: UpdateGlobalSettingsResult;
updateOrderNote: HistoryEntry;
/** Update an existing PaymentMethod */
updatePaymentMethod: PaymentMethod;
/** Update an existing Product */
updateProduct: Product;
/** Create a new ProductOption within a ProductOptionGroup */
updateProductOption: ProductOption;
/** Update an existing ProductOptionGroup */
updateProductOptionGroup: ProductOptionGroup;
updateProductReview: ProductReview;
/** Update existing ProductVariants */
updateProductVariants: Array<Maybe<ProductVariant>>;
/** Update multiple existing Products */
updateProducts: Array<Product>;
updatePromotion: UpdatePromotionResult;
/** Update an existing Province */
updateProvince: Province;
/** Update an existing Role */
updateRole: Role;
/** Update an existing Seller */
updateSeller: Seller;
/** Update an existing ShippingMethod */
updateShippingMethod: ShippingMethod;
updateStockLocation: StockLocation;
/** Update an existing Tag */
updateTag: Tag;
/** Update an existing TaxCategory */
updateTaxCategory: TaxCategory;
/** Update an existing TaxRate */
updateTaxRate: TaxRate;
/** Update an existing Zone */
updateZone: Zone;
};
export type MutationAddCustomersToGroupArgs = {
customerGroupId: Scalars['ID']['input'];
customerIds: Array<Scalars['ID']['input']>;
};
export type MutationAddFulfillmentToOrderArgs = {
input: FulfillOrderInput;
};
export type MutationAddItemToDraftOrderArgs = {
input: AddItemToDraftOrderInput;
orderId: Scalars['ID']['input'];
};
export type MutationAddManualPaymentToOrderArgs = {
input: ManualPaymentInput;
};
export type MutationAddMembersToZoneArgs = {
memberIds: Array<Scalars['ID']['input']>;
zoneId: Scalars['ID']['input'];
};
export type MutationAddNoteToCustomerArgs = {
input: AddNoteToCustomerInput;
};
export type MutationAddNoteToOrderArgs = {
input: AddNoteToOrderInput;
};
export type MutationAddOptionGroupToProductArgs = {
optionGroupId: Scalars['ID']['input'];
productId: Scalars['ID']['input'];
};
export type MutationAdjustDraftOrderLineArgs = {
input: AdjustDraftOrderLineInput;
orderId: Scalars['ID']['input'];
};
export type MutationApplyCouponCodeToDraftOrderArgs = {
couponCode: Scalars['String']['input'];
orderId: Scalars['ID']['input'];
};
export type MutationApproveProductReviewArgs = {
id: Scalars['ID']['input'];
};
export type MutationAssignAssetsToChannelArgs = {
input: AssignAssetsToChannelInput;
};
export type MutationAssignCollectionsToChannelArgs = {
input: AssignCollectionsToChannelInput;
};
export type MutationAssignFacetsToChannelArgs = {
input: AssignFacetsToChannelInput;
};
export type MutationAssignPaymentMethodsToChannelArgs = {
input: AssignPaymentMethodsToChannelInput;
};
export type MutationAssignProductVariantsToChannelArgs = {
input: AssignProductVariantsToChannelInput;
};
export type MutationAssignProductsToChannelArgs = {
input: AssignProductsToChannelInput;
};
export type MutationAssignPromotionsToChannelArgs = {
input: AssignPromotionsToChannelInput;
};
export type MutationAssignRoleToAdministratorArgs = {
administratorId: Scalars['ID']['input'];
roleId: Scalars['ID']['input'];
};
export type MutationAssignShippingMethodsToChannelArgs = {
input: AssignShippingMethodsToChannelInput;
};
export type MutationAssignStockLocationsToChannelArgs = {
input: AssignStockLocationsToChannelInput;
};
export type MutationAuthenticateArgs = {
input: AuthenticationInput;
rememberMe?: InputMaybe<Scalars['Boolean']['input']>;
};
export type MutationCancelJobArgs = {
jobId: Scalars['ID']['input'];
};
export type MutationCancelOrderArgs = {
input: CancelOrderInput;
};
export type MutationCancelPaymentArgs = {
id: Scalars['ID']['input'];
};
export type MutationCreateAdministratorArgs = {
input: CreateAdministratorInput;
};
export type MutationCreateAssetsArgs = {
input: Array<CreateAssetInput>;
};
export type MutationCreateChannelArgs = {
input: CreateChannelInput;
};
export type MutationCreateCollectionArgs = {
input: CreateCollectionInput;
};
export type MutationCreateCountryArgs = {
input: CreateCountryInput;
};
export type MutationCreateCustomerArgs = {
input: CreateCustomerInput;
password?: InputMaybe<Scalars['String']['input']>;
};
export type MutationCreateCustomerAddressArgs = {
customerId: Scalars['ID']['input'];
input: CreateAddressInput;
};
export type MutationCreateCustomerGroupArgs = {
input: CreateCustomerGroupInput;
};
export type MutationCreateFacetArgs = {
input: CreateFacetInput;
};
export type MutationCreateFacetValuesArgs = {
input: Array<CreateFacetValueInput>;
};
export type MutationCreatePaymentMethodArgs = {
input: CreatePaymentMethodInput;
};
export type MutationCreateProductArgs = {
input: CreateProductInput;
};
export type MutationCreateProductOptionArgs = {
input: CreateProductOptionInput;
};
export type MutationCreateProductOptionGroupArgs = {
input: CreateProductOptionGroupInput;
};
export type MutationCreateProductVariantsArgs = {
input: Array<CreateProductVariantInput>;
};
export type MutationCreatePromotionArgs = {
input: CreatePromotionInput;
};
export type MutationCreateProvinceArgs = {
input: CreateProvinceInput;
};
export type MutationCreateRoleArgs = {
input: CreateRoleInput;
};
export type MutationCreateSellerArgs = {
input: CreateSellerInput;
};
export type MutationCreateShippingMethodArgs = {
input: CreateShippingMethodInput;
};
export type MutationCreateStockLocationArgs = {
input: CreateStockLocationInput;
};
export type MutationCreateTagArgs = {
input: CreateTagInput;
};
export type MutationCreateTaxCategoryArgs = {
input: CreateTaxCategoryInput;
};
export type MutationCreateTaxRateArgs = {
input: CreateTaxRateInput;
};
export type MutationCreateZoneArgs = {
input: CreateZoneInput;
};
export type MutationDeleteAdministratorArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteAdministratorsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteAssetArgs = {
input: DeleteAssetInput;
};
export type MutationDeleteAssetsArgs = {
input: DeleteAssetsInput;
};
export type MutationDeleteChannelArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteChannelsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteCollectionArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCollectionsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteCountriesArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteCountryArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCustomerArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCustomerAddressArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCustomerGroupArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCustomerGroupsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteCustomerNoteArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCustomersArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteDraftOrderArgs = {
orderId: Scalars['ID']['input'];
};
export type MutationDeleteFacetArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
id: Scalars['ID']['input'];
};
export type MutationDeleteFacetValuesArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteFacetsArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteOrderNoteArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeletePaymentMethodArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
id: Scalars['ID']['input'];
};
export type MutationDeletePaymentMethodsArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteProductArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteProductOptionArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteProductVariantArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteProductVariantsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteProductsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeletePromotionArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeletePromotionsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteProvinceArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteRoleArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteRolesArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteSellerArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteSellersArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteShippingMethodArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteShippingMethodsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteStockLocationArgs = {
input: DeleteStockLocationInput;
};
export type MutationDeleteStockLocationsArgs = {
input: Array<DeleteStockLocationInput>;
};
export type MutationDeleteTagArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteTaxCategoriesArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteTaxCategoryArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteTaxRateArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteTaxRatesArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteZoneArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteZonesArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationFlushBufferedJobsArgs = {
bufferIds?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type MutationImportProductsArgs = {
csvFile: Scalars['Upload']['input'];
};
export type MutationLoginArgs = {
password: Scalars['String']['input'];
rememberMe?: InputMaybe<Scalars['Boolean']['input']>;
username: Scalars['String']['input'];
};
export type MutationModifyOrderArgs = {
input: ModifyOrderInput;
};
export type MutationMoveCollectionArgs = {
input: MoveCollectionInput;
};
export type MutationRefundOrderArgs = {
input: RefundOrderInput;
};
export type MutationRejectProductReviewArgs = {
id: Scalars['ID']['input'];
};
export type MutationRemoveCollectionsFromChannelArgs = {
input: RemoveCollectionsFromChannelInput;
};
export type MutationRemoveCouponCodeFromDraftOrderArgs = {
couponCode: Scalars['String']['input'];
orderId: Scalars['ID']['input'];
};
export type MutationRemoveCustomersFromGroupArgs = {
customerGroupId: Scalars['ID']['input'];
customerIds: Array<Scalars['ID']['input']>;
};
export type MutationRemoveDraftOrderLineArgs = {
orderId: Scalars['ID']['input'];
orderLineId: Scalars['ID']['input'];
};
export type MutationRemoveFacetsFromChannelArgs = {
input: RemoveFacetsFromChannelInput;
};
export type MutationRemoveMembersFromZoneArgs = {
memberIds: Array<Scalars['ID']['input']>;
zoneId: Scalars['ID']['input'];
};
export type MutationRemoveOptionGroupFromProductArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
optionGroupId: Scalars['ID']['input'];
productId: Scalars['ID']['input'];
};
export type MutationRemovePaymentMethodsFromChannelArgs = {
input: RemovePaymentMethodsFromChannelInput;
};
export type MutationRemoveProductVariantsFromChannelArgs = {
input: RemoveProductVariantsFromChannelInput;
};
export type MutationRemoveProductsFromChannelArgs = {
input: RemoveProductsFromChannelInput;
};
export type MutationRemovePromotionsFromChannelArgs = {
input: RemovePromotionsFromChannelInput;
};
export type MutationRemoveSettledJobsArgs = {
olderThan?: InputMaybe<Scalars['DateTime']['input']>;
queueNames?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type MutationRemoveShippingMethodsFromChannelArgs = {
input: RemoveShippingMethodsFromChannelInput;
};
export type MutationRemoveStockLocationsFromChannelArgs = {
input: RemoveStockLocationsFromChannelInput;
};
export type MutationSetCustomerForDraftOrderArgs = {
customerId?: InputMaybe<Scalars['ID']['input']>;
input?: InputMaybe<CreateCustomerInput>;
orderId: Scalars['ID']['input'];
};
export type MutationSetDraftOrderBillingAddressArgs = {
input: CreateAddressInput;
orderId: Scalars['ID']['input'];
};
export type MutationSetDraftOrderCustomFieldsArgs = {
input: UpdateOrderInput;
orderId: Scalars['ID']['input'];
};
export type MutationSetDraftOrderShippingAddressArgs = {
input: CreateAddressInput;
orderId: Scalars['ID']['input'];
};
export type MutationSetDraftOrderShippingMethodArgs = {
orderId: Scalars['ID']['input'];
shippingMethodId: Scalars['ID']['input'];
};
export type MutationSetOrderCustomFieldsArgs = {
input: UpdateOrderInput;
};
export type MutationSettlePaymentArgs = {
id: Scalars['ID']['input'];
};
export type MutationSettleRefundArgs = {
input: SettleRefundInput;
};
export type MutationTransitionFulfillmentToStateArgs = {
id: Scalars['ID']['input'];
state: Scalars['String']['input'];
};
export type MutationTransitionOrderToStateArgs = {
id: Scalars['ID']['input'];
state: Scalars['String']['input'];
};
export type MutationTransitionPaymentToStateArgs = {
id: Scalars['ID']['input'];
state: Scalars['String']['input'];
};
export type MutationUpdateActiveAdministratorArgs = {
input: UpdateActiveAdministratorInput;
};
export type MutationUpdateAdministratorArgs = {
input: UpdateAdministratorInput;
};
export type MutationUpdateAssetArgs = {
input: UpdateAssetInput;
};
export type MutationUpdateChannelArgs = {
input: UpdateChannelInput;
};
export type MutationUpdateCollectionArgs = {
input: UpdateCollectionInput;
};
export type MutationUpdateCountryArgs = {
input: UpdateCountryInput;
};
export type MutationUpdateCustomerArgs = {
input: UpdateCustomerInput;
};
export type MutationUpdateCustomerAddressArgs = {
input: UpdateAddressInput;
};
export type MutationUpdateCustomerGroupArgs = {
input: UpdateCustomerGroupInput;
};
export type MutationUpdateCustomerNoteArgs = {
input: UpdateCustomerNoteInput;
};
export type MutationUpdateFacetArgs = {
input: UpdateFacetInput;
};
export type MutationUpdateFacetValuesArgs = {
input: Array<UpdateFacetValueInput>;
};
export type MutationUpdateGlobalSettingsArgs = {
input: UpdateGlobalSettingsInput;
};
export type MutationUpdateOrderNoteArgs = {
input: UpdateOrderNoteInput;
};
export type MutationUpdatePaymentMethodArgs = {
input: UpdatePaymentMethodInput;
};
export type MutationUpdateProductArgs = {
input: UpdateProductInput;
};
export type MutationUpdateProductOptionArgs = {
input: UpdateProductOptionInput;
};
export type MutationUpdateProductOptionGroupArgs = {
input: UpdateProductOptionGroupInput;
};
export type MutationUpdateProductReviewArgs = {
input: UpdateProductReviewInput;
};
export type MutationUpdateProductVariantsArgs = {
input: Array<UpdateProductVariantInput>;
};
export type MutationUpdateProductsArgs = {
input: Array<UpdateProductInput>;
};
export type MutationUpdatePromotionArgs = {
input: UpdatePromotionInput;
};
export type MutationUpdateProvinceArgs = {
input: UpdateProvinceInput;
};
export type MutationUpdateRoleArgs = {
input: UpdateRoleInput;
};
export type MutationUpdateSellerArgs = {
input: UpdateSellerInput;
};
export type MutationUpdateShippingMethodArgs = {
input: UpdateShippingMethodInput;
};
export type MutationUpdateStockLocationArgs = {
input: UpdateStockLocationInput;
};
export type MutationUpdateTagArgs = {
input: UpdateTagInput;
};
export type MutationUpdateTaxCategoryArgs = {
input: UpdateTaxCategoryInput;
};
export type MutationUpdateTaxRateArgs = {
input: UpdateTaxRateInput;
};
export type MutationUpdateZoneArgs = {
input: UpdateZoneInput;
};
export type NativeAuthInput = {
password: Scalars['String']['input'];
username: Scalars['String']['input'];
};
/** Returned when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured. */
export type NativeAuthStrategyError = ErrorResult & {
__typename?: 'NativeAuthStrategyError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type NativeAuthenticationResult = CurrentUser | InvalidCredentialsError | NativeAuthStrategyError;
/** Returned when attempting to set a negative OrderLine quantity. */
export type NegativeQuantityError = ErrorResult & {
__typename?: 'NegativeQuantityError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/**
* Returned when invoking a mutation which depends on there being an active Order on the
* current session.
*/
export type NoActiveOrderError = ErrorResult & {
__typename?: 'NoActiveOrderError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when a call to modifyOrder fails to specify any changes */
export type NoChangesSpecifiedError = ErrorResult & {
__typename?: 'NoChangesSpecifiedError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Node = {
id: Scalars['ID']['output'];
};
/** Returned if an attempting to refund an Order but neither items nor shipping refund was specified */
export type NothingToRefundError = ErrorResult & {
__typename?: 'NothingToRefundError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Operators for filtering on a list of Number fields */
export type NumberListOperators = {
inList: Scalars['Float']['input'];
};
/** Operators for filtering on a Int or Float field */
export type NumberOperators = {
between?: InputMaybe<NumberRange>;
eq?: InputMaybe<Scalars['Float']['input']>;
gt?: InputMaybe<Scalars['Float']['input']>;
gte?: InputMaybe<Scalars['Float']['input']>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
lt?: InputMaybe<Scalars['Float']['input']>;
lte?: InputMaybe<Scalars['Float']['input']>;
};
export type NumberRange = {
end: Scalars['Float']['input'];
start: Scalars['Float']['input'];
};
export type Order = Node & {
__typename?: 'Order';
/** An order is active as long as the payment process has not been completed */
active: Scalars['Boolean']['output'];
aggregateOrder?: Maybe<Order>;
aggregateOrderId?: Maybe<Scalars['ID']['output']>;
billingAddress?: Maybe<OrderAddress>;
channels: Array<Channel>;
/** A unique code for the Order */
code: Scalars['String']['output'];
/** An array of all coupon codes applied to the Order */
couponCodes: Array<Scalars['String']['output']>;
createdAt: Scalars['DateTime']['output'];
currencyCode: CurrencyCode;
customFields?: Maybe<Scalars['JSON']['output']>;
customer?: Maybe<Customer>;
discounts: Array<Discount>;
fulfillments?: Maybe<Array<Fulfillment>>;
history: HistoryEntryList;
id: Scalars['ID']['output'];
lines: Array<OrderLine>;
modifications: Array<OrderModification>;
nextStates: Array<Scalars['String']['output']>;
/**
* The date & time that the Order was placed, i.e. the Customer
* completed the checkout and the Order is no longer "active"
*/
orderPlacedAt?: Maybe<Scalars['DateTime']['output']>;
payments?: Maybe<Array<Payment>>;
/** Promotions applied to the order. Only gets populated after the payment process has completed. */
promotions: Array<Promotion>;
sellerOrders?: Maybe<Array<Order>>;
shipping: Scalars['Money']['output'];
shippingAddress?: Maybe<OrderAddress>;
shippingLines: Array<ShippingLine>;
shippingWithTax: Scalars['Money']['output'];
state: Scalars['String']['output'];
/**
* The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
* discounts which have been prorated (proportionally distributed) amongst the items of each OrderLine.
* To get a total of all OrderLines which does not account for prorated discounts, use the
* sum of `OrderLine.discountedLinePrice` values.
*/
subTotal: Scalars['Money']['output'];
/** Same as subTotal, but inclusive of tax */
subTotalWithTax: Scalars['Money']['output'];
/**
* Surcharges are arbitrary modifications to the Order total which are neither
* ProductVariants nor discounts resulting from applied Promotions. For example,
* one-off discounts based on customer interaction, or surcharges based on payment
* methods.
*/
surcharges: Array<Surcharge>;
/** A summary of the taxes being applied to this Order */
taxSummary: Array<OrderTaxSummary>;
/** Equal to subTotal plus shipping */
total: Scalars['Money']['output'];
totalQuantity: Scalars['Int']['output'];
/** The final payable amount. Equal to subTotalWithTax plus shippingWithTax */
totalWithTax: Scalars['Money']['output'];
type: OrderType;
updatedAt: Scalars['DateTime']['output'];
};
export type OrderHistoryArgs = {
options?: InputMaybe<HistoryEntryListOptions>;
};
export type OrderAddress = {
__typename?: 'OrderAddress';
city?: Maybe<Scalars['String']['output']>;
company?: Maybe<Scalars['String']['output']>;
country?: Maybe<Scalars['String']['output']>;
countryCode?: Maybe<Scalars['String']['output']>;
customFields?: Maybe<Scalars['JSON']['output']>;
fullName?: Maybe<Scalars['String']['output']>;
phoneNumber?: Maybe<Scalars['String']['output']>;
postalCode?: Maybe<Scalars['String']['output']>;
province?: Maybe<Scalars['String']['output']>;
streetLine1?: Maybe<Scalars['String']['output']>;
streetLine2?: Maybe<Scalars['String']['output']>;
};
export type OrderFilterParameter = {
active?: InputMaybe<BooleanOperators>;
aggregateOrderId?: InputMaybe<IdOperators>;
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
currencyCode?: InputMaybe<StringOperators>;
customerLastName?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
orderPlacedAt?: InputMaybe<DateOperators>;
shipping?: InputMaybe<NumberOperators>;
shippingWithTax?: InputMaybe<NumberOperators>;
state?: InputMaybe<StringOperators>;
subTotal?: InputMaybe<NumberOperators>;
subTotalWithTax?: InputMaybe<NumberOperators>;
total?: InputMaybe<NumberOperators>;
totalQuantity?: InputMaybe<NumberOperators>;
totalWithTax?: InputMaybe<NumberOperators>;
transactionId?: InputMaybe<StringOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
/** Returned when the maximum order size limit has been reached. */
export type OrderLimitError = ErrorResult & {
__typename?: 'OrderLimitError';
errorCode: ErrorCode;
maxItems: Scalars['Int']['output'];
message: Scalars['String']['output'];
};
export type OrderLine = Node & {
__typename?: 'OrderLine';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
/** The price of the line including discounts, excluding tax */
discountedLinePrice: Scalars['Money']['output'];
/** The price of the line including discounts and tax */
discountedLinePriceWithTax: Scalars['Money']['output'];
/**
* The price of a single unit including discounts, excluding tax.
*
* If Order-level discounts have been applied, this will not be the
* actual taxable unit price (see `proratedUnitPrice`), but is generally the
* correct price to display to customers to avoid confusion
* about the internal handling of distributed Order-level discounts.
*/
discountedUnitPrice: Scalars['Money']['output'];
/** The price of a single unit including discounts and tax */
discountedUnitPriceWithTax: Scalars['Money']['output'];
discounts: Array<Discount>;
featuredAsset?: Maybe<Asset>;
fulfillmentLines?: Maybe<Array<FulfillmentLine>>;
id: Scalars['ID']['output'];
/** The total price of the line excluding tax and discounts. */
linePrice: Scalars['Money']['output'];
/** The total price of the line including tax but excluding discounts. */
linePriceWithTax: Scalars['Money']['output'];
/** The total tax on this line */
lineTax: Scalars['Money']['output'];
order: Order;
/** The quantity at the time the Order was placed */
orderPlacedQuantity: Scalars['Int']['output'];
productVariant: ProductVariant;
/**
* The actual line price, taking into account both item discounts _and_ prorated (proportionally-distributed)
* Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax
* and refund calculations.
*/
proratedLinePrice: Scalars['Money']['output'];
/** The proratedLinePrice including tax */
proratedLinePriceWithTax: Scalars['Money']['output'];
/**
* The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed)
* Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax
* and refund calculations.
*/
proratedUnitPrice: Scalars['Money']['output'];
/** The proratedUnitPrice including tax */
proratedUnitPriceWithTax: Scalars['Money']['output'];
quantity: Scalars['Int']['output'];
taxLines: Array<TaxLine>;
taxRate: Scalars['Float']['output'];
/** The price of a single unit, excluding tax and discounts */
unitPrice: Scalars['Money']['output'];
/** Non-zero if the unitPrice has changed since it was initially added to Order */
unitPriceChangeSinceAdded: Scalars['Money']['output'];
/** The price of a single unit, including tax but excluding discounts */
unitPriceWithTax: Scalars['Money']['output'];
/** Non-zero if the unitPriceWithTax has changed since it was initially added to Order */
unitPriceWithTaxChangeSinceAdded: Scalars['Money']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type OrderLineInput = {
orderLineId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type OrderList = PaginatedList & {
__typename?: 'OrderList';
items: Array<Order>;
totalItems: Scalars['Int']['output'];
};
export type OrderListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<OrderFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<OrderSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type OrderModification = Node & {
__typename?: 'OrderModification';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
isSettled: Scalars['Boolean']['output'];
lines: Array<OrderModificationLine>;
note: Scalars['String']['output'];
payment?: Maybe<Payment>;
priceChange: Scalars['Money']['output'];
refund?: Maybe<Refund>;
surcharges?: Maybe<Array<Surcharge>>;
updatedAt: Scalars['DateTime']['output'];
};
/** Returned when attempting to modify the contents of an Order that is not in the `AddingItems` state. */
export type OrderModificationError = ErrorResult & {
__typename?: 'OrderModificationError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type OrderModificationLine = {
__typename?: 'OrderModificationLine';
modification: OrderModification;
modificationId: Scalars['ID']['output'];
orderLine: OrderLine;
orderLineId: Scalars['ID']['output'];
quantity: Scalars['Int']['output'];
};
/** Returned when attempting to modify the contents of an Order that is not in the `Modifying` state. */
export type OrderModificationStateError = ErrorResult & {
__typename?: 'OrderModificationStateError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type OrderProcessState = {
__typename?: 'OrderProcessState';
name: Scalars['String']['output'];
to: Array<Scalars['String']['output']>;
};
export type OrderSortParameter = {
aggregateOrderId?: InputMaybe<SortOrder>;
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
customerLastName?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
orderPlacedAt?: InputMaybe<SortOrder>;
shipping?: InputMaybe<SortOrder>;
shippingWithTax?: InputMaybe<SortOrder>;
state?: InputMaybe<SortOrder>;
subTotal?: InputMaybe<SortOrder>;
subTotalWithTax?: InputMaybe<SortOrder>;
total?: InputMaybe<SortOrder>;
totalQuantity?: InputMaybe<SortOrder>;
totalWithTax?: InputMaybe<SortOrder>;
transactionId?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
/** Returned if there is an error in transitioning the Order state */
export type OrderStateTransitionError = ErrorResult & {
__typename?: 'OrderStateTransitionError';
errorCode: ErrorCode;
fromState: Scalars['String']['output'];
message: Scalars['String']['output'];
toState: Scalars['String']['output'];
transitionError: Scalars['String']['output'];
};
/**
* A summary of the taxes being applied to this order, grouped
* by taxRate.
*/
export type OrderTaxSummary = {
__typename?: 'OrderTaxSummary';
/** A description of this tax */
description: Scalars['String']['output'];
/** The total net price of OrderLines to which this taxRate applies */
taxBase: Scalars['Money']['output'];
/** The taxRate as a percentage */
taxRate: Scalars['Float']['output'];
/** The total tax being applied to the Order at this taxRate */
taxTotal: Scalars['Money']['output'];
};
export enum OrderType {
Aggregate = 'Aggregate',
Regular = 'Regular',
Seller = 'Seller',
}
export type PaginatedList = {
items: Array<Node>;
totalItems: Scalars['Int']['output'];
};
export type Payment = Node & {
__typename?: 'Payment';
amount: Scalars['Money']['output'];
createdAt: Scalars['DateTime']['output'];
errorMessage?: Maybe<Scalars['String']['output']>;
id: Scalars['ID']['output'];
metadata?: Maybe<Scalars['JSON']['output']>;
method: Scalars['String']['output'];
nextStates: Array<Scalars['String']['output']>;
refunds: Array<Refund>;
state: Scalars['String']['output'];
transactionId?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type PaymentMethod = Node & {
__typename?: 'PaymentMethod';
checker?: Maybe<ConfigurableOperation>;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
enabled: Scalars['Boolean']['output'];
handler: ConfigurableOperation;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
translations: Array<PaymentMethodTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type PaymentMethodFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
enabled?: InputMaybe<BooleanOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type PaymentMethodList = PaginatedList & {
__typename?: 'PaymentMethodList';
items: Array<PaymentMethod>;
totalItems: Scalars['Int']['output'];
};
export type PaymentMethodListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<PaymentMethodFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<PaymentMethodSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
/**
* Returned when a call to modifyOrder fails to include a paymentMethod even
* though the price has increased as a result of the changes.
*/
export type PaymentMethodMissingError = ErrorResult & {
__typename?: 'PaymentMethodMissingError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type PaymentMethodQuote = {
__typename?: 'PaymentMethodQuote';
code: Scalars['String']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
eligibilityMessage?: Maybe<Scalars['String']['output']>;
id: Scalars['ID']['output'];
isEligible: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
};
export type PaymentMethodSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type PaymentMethodTranslation = {
__typename?: 'PaymentMethodTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type PaymentMethodTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
/** Returned if an attempting to refund a Payment against OrderLines from a different Order */
export type PaymentOrderMismatchError = ErrorResult & {
__typename?: 'PaymentOrderMismatchError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when there is an error in transitioning the Payment state */
export type PaymentStateTransitionError = ErrorResult & {
__typename?: 'PaymentStateTransitionError';
errorCode: ErrorCode;
fromState: Scalars['String']['output'];
message: Scalars['String']['output'];
toState: Scalars['String']['output'];
transitionError: Scalars['String']['output'];
};
/**
* @description
* Permissions for administrators and customers. Used to control access to
* GraphQL resolvers via the {@link Allow} decorator.
*
* ## Understanding Permission.Owner
*
* `Permission.Owner` is a special permission which is used in some Vendure resolvers to indicate that that resolver should only
* be accessible to the "owner" of that resource.
*
* For example, the Shop API `activeCustomer` query resolver should only return the Customer object for the "owner" of that Customer, i.e.
* based on the activeUserId of the current session. As a result, the resolver code looks like this:
*
* @example
* ```ts
* \@Query()
* \@Allow(Permission.Owner)
* async activeCustomer(\@Ctx() ctx: RequestContext): Promise<Customer | undefined> {
* const userId = ctx.activeUserId;
* if (userId) {
* return this.customerService.findOneByUserId(ctx, userId);
* }
* }
* ```
*
* Here we can see that the "ownership" must be enforced by custom logic inside the resolver. Since "ownership" cannot be defined generally
* nor statically encoded at build-time, any resolvers using `Permission.Owner` **must** include logic to enforce that only the owner
* of the resource has access. If not, then it is the equivalent of using `Permission.Public`.
*
*
* @docsCategory common
*/
export enum Permission {
/** Authenticated means simply that the user is logged in */
Authenticated = 'Authenticated',
/** Grants permission to create Administrator */
CreateAdministrator = 'CreateAdministrator',
/** Grants permission to create Asset */
CreateAsset = 'CreateAsset',
/** Grants permission to create Products, Facets, Assets, Collections */
CreateCatalog = 'CreateCatalog',
/** Grants permission to create Channel */
CreateChannel = 'CreateChannel',
/** Grants permission to create Collection */
CreateCollection = 'CreateCollection',
/** Grants permission to create Country */
CreateCountry = 'CreateCountry',
/** Grants permission to create Customer */
CreateCustomer = 'CreateCustomer',
/** Grants permission to create CustomerGroup */
CreateCustomerGroup = 'CreateCustomerGroup',
/** Grants permission to create Facet */
CreateFacet = 'CreateFacet',
/** Grants permission to create Order */
CreateOrder = 'CreateOrder',
/** Grants permission to create PaymentMethod */
CreatePaymentMethod = 'CreatePaymentMethod',
/** Grants permission to create Product */
CreateProduct = 'CreateProduct',
/** Grants permission to create Promotion */
CreatePromotion = 'CreatePromotion',
/** Grants permission to create Seller */
CreateSeller = 'CreateSeller',
/** Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
CreateSettings = 'CreateSettings',
/** Grants permission to create ShippingMethod */
CreateShippingMethod = 'CreateShippingMethod',
/** Grants permission to create StockLocation */
CreateStockLocation = 'CreateStockLocation',
/** Grants permission to create System */
CreateSystem = 'CreateSystem',
/** Grants permission to create Tag */
CreateTag = 'CreateTag',
/** Grants permission to create TaxCategory */
CreateTaxCategory = 'CreateTaxCategory',
/** Grants permission to create TaxRate */
CreateTaxRate = 'CreateTaxRate',
/** Grants permission to create Zone */
CreateZone = 'CreateZone',
/** Grants permission to delete Administrator */
DeleteAdministrator = 'DeleteAdministrator',
/** Grants permission to delete Asset */
DeleteAsset = 'DeleteAsset',
/** Grants permission to delete Products, Facets, Assets, Collections */
DeleteCatalog = 'DeleteCatalog',
/** Grants permission to delete Channel */
DeleteChannel = 'DeleteChannel',
/** Grants permission to delete Collection */
DeleteCollection = 'DeleteCollection',
/** Grants permission to delete Country */
DeleteCountry = 'DeleteCountry',
/** Grants permission to delete Customer */
DeleteCustomer = 'DeleteCustomer',
/** Grants permission to delete CustomerGroup */
DeleteCustomerGroup = 'DeleteCustomerGroup',
/** Grants permission to delete Facet */
DeleteFacet = 'DeleteFacet',
/** Grants permission to delete Order */
DeleteOrder = 'DeleteOrder',
/** Grants permission to delete PaymentMethod */
DeletePaymentMethod = 'DeletePaymentMethod',
/** Grants permission to delete Product */
DeleteProduct = 'DeleteProduct',
/** Grants permission to delete Promotion */
DeletePromotion = 'DeletePromotion',
/** Grants permission to delete Seller */
DeleteSeller = 'DeleteSeller',
/** Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
DeleteSettings = 'DeleteSettings',
/** Grants permission to delete ShippingMethod */
DeleteShippingMethod = 'DeleteShippingMethod',
/** Grants permission to delete StockLocation */
DeleteStockLocation = 'DeleteStockLocation',
/** Grants permission to delete System */
DeleteSystem = 'DeleteSystem',
/** Grants permission to delete Tag */
DeleteTag = 'DeleteTag',
/** Grants permission to delete TaxCategory */
DeleteTaxCategory = 'DeleteTaxCategory',
/** Grants permission to delete TaxRate */
DeleteTaxRate = 'DeleteTaxRate',
/** Grants permission to delete Zone */
DeleteZone = 'DeleteZone',
/** Owner means the user owns this entity, e.g. a Customer's own Order */
Owner = 'Owner',
/** Public means any unauthenticated user may perform the operation */
Public = 'Public',
/** Grants permission to read Administrator */
ReadAdministrator = 'ReadAdministrator',
/** Grants permission to read Asset */
ReadAsset = 'ReadAsset',
/** Grants permission to read Products, Facets, Assets, Collections */
ReadCatalog = 'ReadCatalog',
/** Grants permission to read Channel */
ReadChannel = 'ReadChannel',
/** Grants permission to read Collection */
ReadCollection = 'ReadCollection',
/** Grants permission to read Country */
ReadCountry = 'ReadCountry',
/** Grants permission to read Customer */
ReadCustomer = 'ReadCustomer',
/** Grants permission to read CustomerGroup */
ReadCustomerGroup = 'ReadCustomerGroup',
/** Grants permission to read Facet */
ReadFacet = 'ReadFacet',
/** Grants permission to read Order */
ReadOrder = 'ReadOrder',
/** Grants permission to read PaymentMethod */
ReadPaymentMethod = 'ReadPaymentMethod',
/** Grants permission to read Product */
ReadProduct = 'ReadProduct',
/** Grants permission to read Promotion */
ReadPromotion = 'ReadPromotion',
/** Grants permission to read Seller */
ReadSeller = 'ReadSeller',
/** Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
ReadSettings = 'ReadSettings',
/** Grants permission to read ShippingMethod */
ReadShippingMethod = 'ReadShippingMethod',
/** Grants permission to read StockLocation */
ReadStockLocation = 'ReadStockLocation',
/** Grants permission to read System */
ReadSystem = 'ReadSystem',
/** Grants permission to read Tag */
ReadTag = 'ReadTag',
/** Grants permission to read TaxCategory */
ReadTaxCategory = 'ReadTaxCategory',
/** Grants permission to read TaxRate */
ReadTaxRate = 'ReadTaxRate',
/** Grants permission to read Zone */
ReadZone = 'ReadZone',
/** SuperAdmin has unrestricted access to all operations */
SuperAdmin = 'SuperAdmin',
/** Grants permission to update Administrator */
UpdateAdministrator = 'UpdateAdministrator',
/** Grants permission to update Asset */
UpdateAsset = 'UpdateAsset',
/** Grants permission to update Products, Facets, Assets, Collections */
UpdateCatalog = 'UpdateCatalog',
/** Grants permission to update Channel */
UpdateChannel = 'UpdateChannel',
/** Grants permission to update Collection */
UpdateCollection = 'UpdateCollection',
/** Grants permission to update Country */
UpdateCountry = 'UpdateCountry',
/** Grants permission to update Customer */
UpdateCustomer = 'UpdateCustomer',
/** Grants permission to update CustomerGroup */
UpdateCustomerGroup = 'UpdateCustomerGroup',
/** Grants permission to update Facet */
UpdateFacet = 'UpdateFacet',
/** Grants permission to update GlobalSettings */
UpdateGlobalSettings = 'UpdateGlobalSettings',
/** Grants permission to update Order */
UpdateOrder = 'UpdateOrder',
/** Grants permission to update PaymentMethod */
UpdatePaymentMethod = 'UpdatePaymentMethod',
/** Grants permission to update Product */
UpdateProduct = 'UpdateProduct',
/** Grants permission to update Promotion */
UpdatePromotion = 'UpdatePromotion',
/** Grants permission to update Seller */
UpdateSeller = 'UpdateSeller',
/** Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
UpdateSettings = 'UpdateSettings',
/** Grants permission to update ShippingMethod */
UpdateShippingMethod = 'UpdateShippingMethod',
/** Grants permission to update StockLocation */
UpdateStockLocation = 'UpdateStockLocation',
/** Grants permission to update System */
UpdateSystem = 'UpdateSystem',
/** Grants permission to update Tag */
UpdateTag = 'UpdateTag',
/** Grants permission to update TaxCategory */
UpdateTaxCategory = 'UpdateTaxCategory',
/** Grants permission to update TaxRate */
UpdateTaxRate = 'UpdateTaxRate',
/** Grants permission to update Zone */
UpdateZone = 'UpdateZone',
}
export type PermissionDefinition = {
__typename?: 'PermissionDefinition';
assignable: Scalars['Boolean']['output'];
description: Scalars['String']['output'];
name: Scalars['String']['output'];
};
export type PreviewCollectionVariantsInput = {
filters: Array<ConfigurableOperationInput>;
inheritFilters: Scalars['Boolean']['input'];
parentId?: InputMaybe<Scalars['ID']['input']>;
};
/** The price range where the result has more than one price */
export type PriceRange = {
__typename?: 'PriceRange';
max: Scalars['Money']['output'];
min: Scalars['Money']['output'];
};
export type Product = Node & {
__typename?: 'Product';
assets: Array<Asset>;
channels: Array<Channel>;
collections: Array<Collection>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<ProductCustomFields>;
description: Scalars['String']['output'];
enabled: Scalars['Boolean']['output'];
facetValues: Array<FacetValue>;
featuredAsset?: Maybe<Asset>;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
optionGroups: Array<ProductOptionGroup>;
reviews: ProductReviewList;
reviewsHistogram: Array<ProductReviewHistogramItem>;
slug: Scalars['String']['output'];
translations: Array<ProductTranslation>;
updatedAt: Scalars['DateTime']['output'];
/** Returns a paginated, sortable, filterable list of ProductVariants */
variantList: ProductVariantList;
/** Returns all ProductVariants */
variants: Array<ProductVariant>;
};
export type ProductReviewsArgs = {
options?: InputMaybe<ProductReviewListOptions>;
};
export type ProductVariantListArgs = {
options?: InputMaybe<ProductVariantListOptions>;
};
export type ProductCustomFields = {
__typename?: 'ProductCustomFields';
featuredReview?: Maybe<ProductReview>;
reviewCount?: Maybe<Scalars['Float']['output']>;
reviewRating?: Maybe<Scalars['Float']['output']>;
};
export type ProductFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
enabled?: InputMaybe<BooleanOperators>;
facetValueId?: InputMaybe<IdOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
reviewCount?: InputMaybe<NumberOperators>;
reviewRating?: InputMaybe<NumberOperators>;
slug?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ProductList = PaginatedList & {
__typename?: 'ProductList';
items: Array<Product>;
totalItems: Scalars['Int']['output'];
};
export type ProductListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ProductFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ProductSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ProductOption = Node & {
__typename?: 'ProductOption';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
group: ProductOptionGroup;
groupId: Scalars['ID']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<ProductOptionTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type ProductOptionGroup = Node & {
__typename?: 'ProductOptionGroup';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
options: Array<ProductOption>;
translations: Array<ProductOptionGroupTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type ProductOptionGroupTranslation = {
__typename?: 'ProductOptionGroupTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProductOptionGroupTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type ProductOptionInUseError = ErrorResult & {
__typename?: 'ProductOptionInUseError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
optionGroupCode: Scalars['String']['output'];
productVariantCount: Scalars['Int']['output'];
};
export type ProductOptionTranslation = {
__typename?: 'ProductOptionTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProductOptionTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type ProductReview = Node & {
__typename?: 'ProductReview';
author?: Maybe<Customer>;
authorLocation?: Maybe<Scalars['String']['output']>;
authorName: Scalars['String']['output'];
body?: Maybe<Scalars['String']['output']>;
createdAt: Scalars['DateTime']['output'];
downvotes: Scalars['Int']['output'];
id: Scalars['ID']['output'];
product: Product;
productVariant?: Maybe<ProductVariant>;
rating: Scalars['Float']['output'];
response?: Maybe<Scalars['String']['output']>;
responseCreatedAt?: Maybe<Scalars['DateTime']['output']>;
state: Scalars['String']['output'];
summary: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
upvotes: Scalars['Int']['output'];
};
export type ProductReviewFilterParameter = {
authorLocation?: InputMaybe<StringOperators>;
authorName?: InputMaybe<StringOperators>;
body?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
downvotes?: InputMaybe<NumberOperators>;
id?: InputMaybe<IdOperators>;
rating?: InputMaybe<NumberOperators>;
response?: InputMaybe<StringOperators>;
responseCreatedAt?: InputMaybe<DateOperators>;
state?: InputMaybe<StringOperators>;
summary?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
upvotes?: InputMaybe<NumberOperators>;
};
export type ProductReviewHistogramItem = {
__typename?: 'ProductReviewHistogramItem';
bin: Scalars['Int']['output'];
frequency: Scalars['Int']['output'];
};
export type ProductReviewList = PaginatedList & {
__typename?: 'ProductReviewList';
items: Array<ProductReview>;
totalItems: Scalars['Int']['output'];
};
export type ProductReviewListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ProductReviewFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ProductReviewSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ProductReviewSortParameter = {
authorLocation?: InputMaybe<SortOrder>;
authorName?: InputMaybe<SortOrder>;
body?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
downvotes?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
rating?: InputMaybe<SortOrder>;
response?: InputMaybe<SortOrder>;
responseCreatedAt?: InputMaybe<SortOrder>;
state?: InputMaybe<SortOrder>;
summary?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
upvotes?: InputMaybe<SortOrder>;
};
export type ProductSortParameter = {
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
featuredReview?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
reviewCount?: InputMaybe<SortOrder>;
reviewRating?: InputMaybe<SortOrder>;
slug?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ProductTranslation = {
__typename?: 'ProductTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
slug: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProductTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
slug?: InputMaybe<Scalars['String']['input']>;
};
export type ProductVariant = Node & {
__typename?: 'ProductVariant';
assets: Array<Asset>;
channels: Array<Channel>;
createdAt: Scalars['DateTime']['output'];
currencyCode: CurrencyCode;
customFields?: Maybe<Scalars['JSON']['output']>;
enabled: Scalars['Boolean']['output'];
facetValues: Array<FacetValue>;
featuredAsset?: Maybe<Asset>;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
options: Array<ProductOption>;
outOfStockThreshold: Scalars['Int']['output'];
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
prices: Array<ProductVariantPrice>;
product: Product;
productId: Scalars['ID']['output'];
sku: Scalars['String']['output'];
/** @deprecated use stockLevels */
stockAllocated: Scalars['Int']['output'];
stockLevel: Scalars['String']['output'];
stockLevels: Array<StockLevel>;
stockMovements: StockMovementList;
/** @deprecated use stockLevels */
stockOnHand: Scalars['Int']['output'];
taxCategory: TaxCategory;
taxRateApplied: TaxRate;
trackInventory: GlobalFlag;
translations: Array<ProductVariantTranslation>;
updatedAt: Scalars['DateTime']['output'];
useGlobalOutOfStockThreshold: Scalars['Boolean']['output'];
};
export type ProductVariantStockMovementsArgs = {
options?: InputMaybe<StockMovementListOptions>;
};
export type ProductVariantFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
currencyCode?: InputMaybe<StringOperators>;
enabled?: InputMaybe<BooleanOperators>;
facetValueId?: InputMaybe<IdOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
outOfStockThreshold?: InputMaybe<NumberOperators>;
price?: InputMaybe<NumberOperators>;
priceWithTax?: InputMaybe<NumberOperators>;
productId?: InputMaybe<IdOperators>;
sku?: InputMaybe<StringOperators>;
stockAllocated?: InputMaybe<NumberOperators>;
stockLevel?: InputMaybe<StringOperators>;
stockOnHand?: InputMaybe<NumberOperators>;
trackInventory?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
useGlobalOutOfStockThreshold?: InputMaybe<BooleanOperators>;
};
export type ProductVariantList = PaginatedList & {
__typename?: 'ProductVariantList';
items: Array<ProductVariant>;
totalItems: Scalars['Int']['output'];
};
export type ProductVariantListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ProductVariantFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ProductVariantSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ProductVariantPrice = {
__typename?: 'ProductVariantPrice';
currencyCode: CurrencyCode;
price: Scalars['Int']['output'];
};
/**
* Used to set up update the price of a ProductVariant in a particular Channel.
* If the `delete` flag is `true`, the price will be deleted for the given Channel.
*/
export type ProductVariantPriceInput = {
currencyCode: CurrencyCode;
delete?: InputMaybe<Scalars['Boolean']['input']>;
price: Scalars['Money']['input'];
};
export type ProductVariantSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
outOfStockThreshold?: InputMaybe<SortOrder>;
price?: InputMaybe<SortOrder>;
priceWithTax?: InputMaybe<SortOrder>;
productId?: InputMaybe<SortOrder>;
sku?: InputMaybe<SortOrder>;
stockAllocated?: InputMaybe<SortOrder>;
stockLevel?: InputMaybe<SortOrder>;
stockOnHand?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ProductVariantTranslation = {
__typename?: 'ProductVariantTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProductVariantTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type Promotion = Node & {
__typename?: 'Promotion';
actions: Array<ConfigurableOperation>;
conditions: Array<ConfigurableOperation>;
couponCode?: Maybe<Scalars['String']['output']>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
enabled: Scalars['Boolean']['output'];
endsAt?: Maybe<Scalars['DateTime']['output']>;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
perCustomerUsageLimit?: Maybe<Scalars['Int']['output']>;
startsAt?: Maybe<Scalars['DateTime']['output']>;
translations: Array<PromotionTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type PromotionFilterParameter = {
couponCode?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
enabled?: InputMaybe<BooleanOperators>;
endsAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
perCustomerUsageLimit?: InputMaybe<NumberOperators>;
startsAt?: InputMaybe<DateOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type PromotionList = PaginatedList & {
__typename?: 'PromotionList';
items: Array<Promotion>;
totalItems: Scalars['Int']['output'];
};
export type PromotionListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<PromotionFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<PromotionSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type PromotionSortParameter = {
couponCode?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
endsAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
perCustomerUsageLimit?: InputMaybe<SortOrder>;
startsAt?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type PromotionTranslation = {
__typename?: 'PromotionTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type PromotionTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type Province = Node &
Region & {
__typename?: 'Province';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
parent?: Maybe<Region>;
parentId?: Maybe<Scalars['ID']['output']>;
translations: Array<RegionTranslation>;
type: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProvinceFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
enabled?: InputMaybe<BooleanOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
parentId?: InputMaybe<IdOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ProvinceList = PaginatedList & {
__typename?: 'ProvinceList';
items: Array<Province>;
totalItems: Scalars['Int']['output'];
};
export type ProvinceListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ProvinceFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ProvinceSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ProvinceSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
parentId?: InputMaybe<SortOrder>;
type?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ProvinceTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
/** Returned if the specified quantity of an OrderLine is greater than the number of items in that line */
export type QuantityTooGreatError = ErrorResult & {
__typename?: 'QuantityTooGreatError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Query = {
__typename?: 'Query';
activeAdministrator?: Maybe<Administrator>;
activeChannel: Channel;
administrator?: Maybe<Administrator>;
administrators: AdministratorList;
/** Get a single Asset by id */
asset?: Maybe<Asset>;
/** Get a list of Assets */
assets: AssetList;
channel?: Maybe<Channel>;
channels: ChannelList;
/** Get a Collection either by id or slug. If neither id nor slug is specified, an error will result. */
collection?: Maybe<Collection>;
collectionFilters: Array<ConfigurableOperationDefinition>;
collections: CollectionList;
countries: CountryList;
country?: Maybe<Country>;
customer?: Maybe<Customer>;
customerGroup?: Maybe<CustomerGroup>;
customerGroups: CustomerGroupList;
customers: CustomerList;
/** Returns a list of eligible shipping methods for the draft Order */
eligibleShippingMethodsForDraftOrder: Array<ShippingMethodQuote>;
facet?: Maybe<Facet>;
facetValues: FacetValueList;
facets: FacetList;
fulfillmentHandlers: Array<ConfigurableOperationDefinition>;
globalSettings: GlobalSettings;
job?: Maybe<Job>;
jobBufferSize: Array<JobBufferSize>;
jobQueues: Array<JobQueue>;
jobs: JobList;
jobsById: Array<Job>;
me?: Maybe<CurrentUser>;
/** Get metrics for the given interval and metric types. */
metricSummary: Array<MetricSummary>;
order?: Maybe<Order>;
orders: OrderList;
paymentMethod?: Maybe<PaymentMethod>;
paymentMethodEligibilityCheckers: Array<ConfigurableOperationDefinition>;
paymentMethodHandlers: Array<ConfigurableOperationDefinition>;
paymentMethods: PaymentMethodList;
pendingSearchIndexUpdates: Scalars['Int']['output'];
/** Used for real-time previews of the contents of a Collection */
previewCollectionVariants: ProductVariantList;
/** Get a Product either by id or slug. If neither id nor slug is specified, an error will result. */
product?: Maybe<Product>;
productOptionGroup?: Maybe<ProductOptionGroup>;
productOptionGroups: Array<ProductOptionGroup>;
productReview?: Maybe<ProductReview>;
productReviews: ProductReviewList;
/** Get a ProductVariant by id */
productVariant?: Maybe<ProductVariant>;
/** List ProductVariants either all or for the specific product. */
productVariants: ProductVariantList;
/** List Products */
products: ProductList;
promotion?: Maybe<Promotion>;
promotionActions: Array<ConfigurableOperationDefinition>;
promotionConditions: Array<ConfigurableOperationDefinition>;
promotions: PromotionList;
province?: Maybe<Province>;
provinces: ProvinceList;
role?: Maybe<Role>;
roles: RoleList;
search: SearchResponse;
seller?: Maybe<Seller>;
sellers: SellerList;
shippingCalculators: Array<ConfigurableOperationDefinition>;
shippingEligibilityCheckers: Array<ConfigurableOperationDefinition>;
shippingMethod?: Maybe<ShippingMethod>;
shippingMethods: ShippingMethodList;
stockLocation?: Maybe<StockLocation>;
stockLocations: StockLocationList;
tag: Tag;
tags: TagList;
taxCategories: TaxCategoryList;
taxCategory?: Maybe<TaxCategory>;
taxRate?: Maybe<TaxRate>;
taxRates: TaxRateList;
testEligibleShippingMethods: Array<ShippingMethodQuote>;
testShippingMethod: TestShippingMethodResult;
zone?: Maybe<Zone>;
zones: ZoneList;
};
export type QueryAdministratorArgs = {
id: Scalars['ID']['input'];
};
export type QueryAdministratorsArgs = {
options?: InputMaybe<AdministratorListOptions>;
};
export type QueryAssetArgs = {
id: Scalars['ID']['input'];
};
export type QueryAssetsArgs = {
options?: InputMaybe<AssetListOptions>;
};
export type QueryChannelArgs = {
id: Scalars['ID']['input'];
};
export type QueryChannelsArgs = {
options?: InputMaybe<ChannelListOptions>;
};
export type QueryCollectionArgs = {
id?: InputMaybe<Scalars['ID']['input']>;
slug?: InputMaybe<Scalars['String']['input']>;
};
export type QueryCollectionsArgs = {
options?: InputMaybe<CollectionListOptions>;
};
export type QueryCountriesArgs = {
options?: InputMaybe<CountryListOptions>;
};
export type QueryCountryArgs = {
id: Scalars['ID']['input'];
};
export type QueryCustomerArgs = {
id: Scalars['ID']['input'];
};
export type QueryCustomerGroupArgs = {
id: Scalars['ID']['input'];
};
export type QueryCustomerGroupsArgs = {
options?: InputMaybe<CustomerGroupListOptions>;
};
export type QueryCustomersArgs = {
options?: InputMaybe<CustomerListOptions>;
};
export type QueryEligibleShippingMethodsForDraftOrderArgs = {
orderId: Scalars['ID']['input'];
};
export type QueryFacetArgs = {
id: Scalars['ID']['input'];
};
export type QueryFacetValuesArgs = {
options?: InputMaybe<FacetValueListOptions>;
};
export type QueryFacetsArgs = {
options?: InputMaybe<FacetListOptions>;
};
export type QueryJobArgs = {
jobId: Scalars['ID']['input'];
};
export type QueryJobBufferSizeArgs = {
bufferIds?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type QueryJobsArgs = {
options?: InputMaybe<JobListOptions>;
};
export type QueryJobsByIdArgs = {
jobIds: Array<Scalars['ID']['input']>;
};
export type QueryMetricSummaryArgs = {
input?: InputMaybe<MetricSummaryInput>;
};
export type QueryOrderArgs = {
id: Scalars['ID']['input'];
};
export type QueryOrdersArgs = {
options?: InputMaybe<OrderListOptions>;
};
export type QueryPaymentMethodArgs = {
id: Scalars['ID']['input'];
};
export type QueryPaymentMethodsArgs = {
options?: InputMaybe<PaymentMethodListOptions>;
};
export type QueryPreviewCollectionVariantsArgs = {
input: PreviewCollectionVariantsInput;
options?: InputMaybe<ProductVariantListOptions>;
};
export type QueryProductArgs = {
id?: InputMaybe<Scalars['ID']['input']>;
slug?: InputMaybe<Scalars['String']['input']>;
};
export type QueryProductOptionGroupArgs = {
id: Scalars['ID']['input'];
};
export type QueryProductOptionGroupsArgs = {
filterTerm?: InputMaybe<Scalars['String']['input']>;
};
export type QueryProductReviewArgs = {
id: Scalars['ID']['input'];
};
export type QueryProductReviewsArgs = {
options?: InputMaybe<ProductReviewListOptions>;
};
export type QueryProductVariantArgs = {
id: Scalars['ID']['input'];
};
export type QueryProductVariantsArgs = {
options?: InputMaybe<ProductVariantListOptions>;
productId?: InputMaybe<Scalars['ID']['input']>;
};
export type QueryProductsArgs = {
options?: InputMaybe<ProductListOptions>;
};
export type QueryPromotionArgs = {
id: Scalars['ID']['input'];
};
export type QueryPromotionsArgs = {
options?: InputMaybe<PromotionListOptions>;
};
export type QueryProvinceArgs = {
id: Scalars['ID']['input'];
};
export type QueryProvincesArgs = {
options?: InputMaybe<ProvinceListOptions>;
};
export type QueryRoleArgs = {
id: Scalars['ID']['input'];
};
export type QueryRolesArgs = {
options?: InputMaybe<RoleListOptions>;
};
export type QuerySearchArgs = {
input: SearchInput;
};
export type QuerySellerArgs = {
id: Scalars['ID']['input'];
};
export type QuerySellersArgs = {
options?: InputMaybe<SellerListOptions>;
};
export type QueryShippingMethodArgs = {
id: Scalars['ID']['input'];
};
export type QueryShippingMethodsArgs = {
options?: InputMaybe<ShippingMethodListOptions>;
};
export type QueryStockLocationArgs = {
id: Scalars['ID']['input'];
};
export type QueryStockLocationsArgs = {
options?: InputMaybe<StockLocationListOptions>;
};
export type QueryTagArgs = {
id: Scalars['ID']['input'];
};
export type QueryTagsArgs = {
options?: InputMaybe<TagListOptions>;
};
export type QueryTaxCategoriesArgs = {
options?: InputMaybe<TaxCategoryListOptions>;
};
export type QueryTaxCategoryArgs = {
id: Scalars['ID']['input'];
};
export type QueryTaxRateArgs = {
id: Scalars['ID']['input'];
};
export type QueryTaxRatesArgs = {
options?: InputMaybe<TaxRateListOptions>;
};
export type QueryTestEligibleShippingMethodsArgs = {
input: TestEligibleShippingMethodsInput;
};
export type QueryTestShippingMethodArgs = {
input: TestShippingMethodInput;
};
export type QueryZoneArgs = {
id: Scalars['ID']['input'];
};
export type QueryZonesArgs = {
options?: InputMaybe<ZoneListOptions>;
};
export type Refund = Node & {
__typename?: 'Refund';
adjustment: Scalars['Money']['output'];
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
items: Scalars['Money']['output'];
lines: Array<RefundLine>;
metadata?: Maybe<Scalars['JSON']['output']>;
method?: Maybe<Scalars['String']['output']>;
paymentId: Scalars['ID']['output'];
reason?: Maybe<Scalars['String']['output']>;
shipping: Scalars['Money']['output'];
state: Scalars['String']['output'];
total: Scalars['Money']['output'];
transactionId?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type RefundLine = {
__typename?: 'RefundLine';
orderLine: OrderLine;
orderLineId: Scalars['ID']['output'];
quantity: Scalars['Int']['output'];
refund: Refund;
refundId: Scalars['ID']['output'];
};
export type RefundOrderInput = {
adjustment: Scalars['Money']['input'];
lines: Array<OrderLineInput>;
paymentId: Scalars['ID']['input'];
reason?: InputMaybe<Scalars['String']['input']>;
shipping: Scalars['Money']['input'];
};
export type RefundOrderResult =
| AlreadyRefundedError
| MultipleOrderError
| NothingToRefundError
| OrderStateTransitionError
| PaymentOrderMismatchError
| QuantityTooGreatError
| Refund
| RefundOrderStateError
| RefundStateTransitionError;
/** Returned if an attempting to refund an Order which is not in the expected state */
export type RefundOrderStateError = ErrorResult & {
__typename?: 'RefundOrderStateError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
orderState: Scalars['String']['output'];
};
/**
* Returned when a call to modifyOrder fails to include a refundPaymentId even
* though the price has decreased as a result of the changes.
*/
export type RefundPaymentIdMissingError = ErrorResult & {
__typename?: 'RefundPaymentIdMissingError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when there is an error in transitioning the Refund state */
export type RefundStateTransitionError = ErrorResult & {
__typename?: 'RefundStateTransitionError';
errorCode: ErrorCode;
fromState: Scalars['String']['output'];
message: Scalars['String']['output'];
toState: Scalars['String']['output'];
transitionError: Scalars['String']['output'];
};
export type Region = {
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
parent?: Maybe<Region>;
parentId?: Maybe<Scalars['ID']['output']>;
translations: Array<RegionTranslation>;
type: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type RegionTranslation = {
__typename?: 'RegionTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type RelationCustomFieldConfig = CustomField & {
__typename?: 'RelationCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
entity: Scalars['String']['output'];
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
scalarFields: Array<Scalars['String']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type Release = Node &
StockMovement & {
__typename?: 'Release';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type RemoveCollectionsFromChannelInput = {
channelId: Scalars['ID']['input'];
collectionIds: Array<Scalars['ID']['input']>;
};
export type RemoveFacetFromChannelResult = Facet | FacetInUseError;
export type RemoveFacetsFromChannelInput = {
channelId: Scalars['ID']['input'];
facetIds: Array<Scalars['ID']['input']>;
force?: InputMaybe<Scalars['Boolean']['input']>;
};
export type RemoveOptionGroupFromProductResult = Product | ProductOptionInUseError;
export type RemoveOrderItemsResult = Order | OrderModificationError;
export type RemovePaymentMethodsFromChannelInput = {
channelId: Scalars['ID']['input'];
paymentMethodIds: Array<Scalars['ID']['input']>;
};
export type RemoveProductVariantsFromChannelInput = {
channelId: Scalars['ID']['input'];
productVariantIds: Array<Scalars['ID']['input']>;
};
export type RemoveProductsFromChannelInput = {
channelId: Scalars['ID']['input'];
productIds: Array<Scalars['ID']['input']>;
};
export type RemovePromotionsFromChannelInput = {
channelId: Scalars['ID']['input'];
promotionIds: Array<Scalars['ID']['input']>;
};
export type RemoveShippingMethodsFromChannelInput = {
channelId: Scalars['ID']['input'];
shippingMethodIds: Array<Scalars['ID']['input']>;
};
export type RemoveStockLocationsFromChannelInput = {
channelId: Scalars['ID']['input'];
stockLocationIds: Array<Scalars['ID']['input']>;
};
export type Return = Node &
StockMovement & {
__typename?: 'Return';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type Role = Node & {
__typename?: 'Role';
channels: Array<Channel>;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
permissions: Array<Permission>;
updatedAt: Scalars['DateTime']['output'];
};
export type RoleFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type RoleList = PaginatedList & {
__typename?: 'RoleList';
items: Array<Role>;
totalItems: Scalars['Int']['output'];
};
export type RoleListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<RoleFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<RoleSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type RoleSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type Sale = Node &
StockMovement & {
__typename?: 'Sale';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type SearchInput = {
collectionId?: InputMaybe<Scalars['ID']['input']>;
collectionSlug?: InputMaybe<Scalars['String']['input']>;
facetValueFilters?: InputMaybe<Array<FacetValueFilterInput>>;
groupByProduct?: InputMaybe<Scalars['Boolean']['input']>;
skip?: InputMaybe<Scalars['Int']['input']>;
sort?: InputMaybe<SearchResultSortParameter>;
take?: InputMaybe<Scalars['Int']['input']>;
term?: InputMaybe<Scalars['String']['input']>;
};
export type SearchReindexResponse = {
__typename?: 'SearchReindexResponse';
success: Scalars['Boolean']['output'];
};
export type SearchResponse = {
__typename?: 'SearchResponse';
collections: Array<CollectionResult>;
facetValues: Array<FacetValueResult>;
items: Array<SearchResult>;
totalItems: Scalars['Int']['output'];
};
export type SearchResult = {
__typename?: 'SearchResult';
/** An array of ids of the Channels in which this result appears */
channelIds: Array<Scalars['ID']['output']>;
/** An array of ids of the Collections in which this result appears */
collectionIds: Array<Scalars['ID']['output']>;
currencyCode: CurrencyCode;
description: Scalars['String']['output'];
enabled: Scalars['Boolean']['output'];
facetIds: Array<Scalars['ID']['output']>;
facetValueIds: Array<Scalars['ID']['output']>;
price: SearchResultPrice;
priceWithTax: SearchResultPrice;
productAsset?: Maybe<SearchResultAsset>;
productId: Scalars['ID']['output'];
productName: Scalars['String']['output'];
productVariantAsset?: Maybe<SearchResultAsset>;
productVariantId: Scalars['ID']['output'];
productVariantName: Scalars['String']['output'];
/** A relevance score for the result. Differs between database implementations */
score: Scalars['Float']['output'];
sku: Scalars['String']['output'];
slug: Scalars['String']['output'];
};
export type SearchResultAsset = {
__typename?: 'SearchResultAsset';
focalPoint?: Maybe<Coordinate>;
id: Scalars['ID']['output'];
preview: Scalars['String']['output'];
};
/** The price of a search result product, either as a range or as a single price */
export type SearchResultPrice = PriceRange | SinglePrice;
export type SearchResultSortParameter = {
name?: InputMaybe<SortOrder>;
price?: InputMaybe<SortOrder>;
};
export type Seller = Node & {
__typename?: 'Seller';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type SellerFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type SellerList = PaginatedList & {
__typename?: 'SellerList';
items: Array<Seller>;
totalItems: Scalars['Int']['output'];
};
export type SellerListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<SellerFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<SellerSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type SellerSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ServerConfig = {
__typename?: 'ServerConfig';
customFieldConfig: CustomFields;
orderProcess: Array<OrderProcessState>;
permissions: Array<PermissionDefinition>;
permittedAssetTypes: Array<Scalars['String']['output']>;
};
export type SetCustomerForDraftOrderResult = EmailAddressConflictError | Order;
export type SetOrderShippingMethodResult =
| IneligibleShippingMethodError
| NoActiveOrderError
| Order
| OrderModificationError;
/** Returned if the Payment settlement fails */
export type SettlePaymentError = ErrorResult & {
__typename?: 'SettlePaymentError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
paymentErrorMessage: Scalars['String']['output'];
};
export type SettlePaymentResult =
| OrderStateTransitionError
| Payment
| PaymentStateTransitionError
| SettlePaymentError;
export type SettleRefundInput = {
id: Scalars['ID']['input'];
transactionId: Scalars['String']['input'];
};
export type SettleRefundResult = Refund | RefundStateTransitionError;
export type ShippingLine = {
__typename?: 'ShippingLine';
discountedPrice: Scalars['Money']['output'];
discountedPriceWithTax: Scalars['Money']['output'];
discounts: Array<Discount>;
id: Scalars['ID']['output'];
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
shippingMethod: ShippingMethod;
};
export type ShippingMethod = Node & {
__typename?: 'ShippingMethod';
calculator: ConfigurableOperation;
checker: ConfigurableOperation;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
fulfillmentHandlerCode: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<ShippingMethodTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type ShippingMethodFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
fulfillmentHandlerCode?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ShippingMethodList = PaginatedList & {
__typename?: 'ShippingMethodList';
items: Array<ShippingMethod>;
totalItems: Scalars['Int']['output'];
};
export type ShippingMethodListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ShippingMethodFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ShippingMethodSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ShippingMethodQuote = {
__typename?: 'ShippingMethodQuote';
code: Scalars['String']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
/** Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult */
metadata?: Maybe<Scalars['JSON']['output']>;
name: Scalars['String']['output'];
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
};
export type ShippingMethodSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
fulfillmentHandlerCode?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ShippingMethodTranslation = {
__typename?: 'ShippingMethodTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ShippingMethodTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
/** The price value where the result has a single price */
export type SinglePrice = {
__typename?: 'SinglePrice';
value: Scalars['Money']['output'];
};
export enum SortOrder {
ASC = 'ASC',
DESC = 'DESC',
}
export type StockAdjustment = Node &
StockMovement & {
__typename?: 'StockAdjustment';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type StockLevel = Node & {
__typename?: 'StockLevel';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
stockAllocated: Scalars['Int']['output'];
stockLocation: StockLocation;
stockLocationId: Scalars['ID']['output'];
stockOnHand: Scalars['Int']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type StockLevelInput = {
stockLocationId: Scalars['ID']['input'];
stockOnHand: Scalars['Int']['input'];
};
export type StockLocation = Node & {
__typename?: 'StockLocation';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type StockLocationFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type StockLocationList = PaginatedList & {
__typename?: 'StockLocationList';
items: Array<StockLocation>;
totalItems: Scalars['Int']['output'];
};
export type StockLocationListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<StockLocationFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<StockLocationSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type StockLocationSortParameter = {
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type StockMovement = {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type StockMovementItem = Allocation | Cancellation | Release | Return | Sale | StockAdjustment;
export type StockMovementList = {
__typename?: 'StockMovementList';
items: Array<StockMovementItem>;
totalItems: Scalars['Int']['output'];
};
export type StockMovementListOptions = {
skip?: InputMaybe<Scalars['Int']['input']>;
take?: InputMaybe<Scalars['Int']['input']>;
type?: InputMaybe<StockMovementType>;
};
export enum StockMovementType {
ADJUSTMENT = 'ADJUSTMENT',
ALLOCATION = 'ALLOCATION',
CANCELLATION = 'CANCELLATION',
RELEASE = 'RELEASE',
RETURN = 'RETURN',
SALE = 'SALE',
}
export type StringCustomFieldConfig = CustomField & {
__typename?: 'StringCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
length?: Maybe<Scalars['Int']['output']>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
options?: Maybe<Array<StringFieldOption>>;
pattern?: Maybe<Scalars['String']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type StringFieldOption = {
__typename?: 'StringFieldOption';
label?: Maybe<Array<LocalizedString>>;
value: Scalars['String']['output'];
};
/** Operators for filtering on a list of String fields */
export type StringListOperators = {
inList: Scalars['String']['input'];
};
/** Operators for filtering on a String field */
export type StringOperators = {
contains?: InputMaybe<Scalars['String']['input']>;
eq?: InputMaybe<Scalars['String']['input']>;
in?: InputMaybe<Array<Scalars['String']['input']>>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
notContains?: InputMaybe<Scalars['String']['input']>;
notEq?: InputMaybe<Scalars['String']['input']>;
notIn?: InputMaybe<Array<Scalars['String']['input']>>;
regex?: InputMaybe<Scalars['String']['input']>;
};
/** Indicates that an operation succeeded, where we do not want to return any more specific information. */
export type Success = {
__typename?: 'Success';
success: Scalars['Boolean']['output'];
};
export type Surcharge = Node & {
__typename?: 'Surcharge';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
sku?: Maybe<Scalars['String']['output']>;
taxLines: Array<TaxLine>;
taxRate: Scalars['Float']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type SurchargeInput = {
description: Scalars['String']['input'];
price: Scalars['Money']['input'];
priceIncludesTax: Scalars['Boolean']['input'];
sku?: InputMaybe<Scalars['String']['input']>;
taxDescription?: InputMaybe<Scalars['String']['input']>;
taxRate?: InputMaybe<Scalars['Float']['input']>;
};
export type Tag = Node & {
__typename?: 'Tag';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
updatedAt: Scalars['DateTime']['output'];
value: Scalars['String']['output'];
};
export type TagFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
updatedAt?: InputMaybe<DateOperators>;
value?: InputMaybe<StringOperators>;
};
export type TagList = PaginatedList & {
__typename?: 'TagList';
items: Array<Tag>;
totalItems: Scalars['Int']['output'];
};
export type TagListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<TagFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<TagSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type TagSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
value?: InputMaybe<SortOrder>;
};
export type TaxCategory = Node & {
__typename?: 'TaxCategory';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
isDefault: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type TaxCategoryFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
isDefault?: InputMaybe<BooleanOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type TaxCategoryList = PaginatedList & {
__typename?: 'TaxCategoryList';
items: Array<TaxCategory>;
totalItems: Scalars['Int']['output'];
};
export type TaxCategoryListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<TaxCategoryFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<TaxCategorySortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type TaxCategorySortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type TaxLine = {
__typename?: 'TaxLine';
description: Scalars['String']['output'];
taxRate: Scalars['Float']['output'];
};
export type TaxRate = Node & {
__typename?: 'TaxRate';
category: TaxCategory;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
customerGroup?: Maybe<CustomerGroup>;
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
value: Scalars['Float']['output'];
zone: Zone;
};
export type TaxRateFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
enabled?: InputMaybe<BooleanOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
value?: InputMaybe<NumberOperators>;
};
export type TaxRateList = PaginatedList & {
__typename?: 'TaxRateList';
items: Array<TaxRate>;
totalItems: Scalars['Int']['output'];
};
export type TaxRateListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<TaxRateFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<TaxRateSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type TaxRateSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
value?: InputMaybe<SortOrder>;
};
export type TestEligibleShippingMethodsInput = {
lines: Array<TestShippingMethodOrderLineInput>;
shippingAddress: CreateAddressInput;
};
export type TestShippingMethodInput = {
calculator: ConfigurableOperationInput;
checker: ConfigurableOperationInput;
lines: Array<TestShippingMethodOrderLineInput>;
shippingAddress: CreateAddressInput;
};
export type TestShippingMethodOrderLineInput = {
productVariantId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type TestShippingMethodQuote = {
__typename?: 'TestShippingMethodQuote';
metadata?: Maybe<Scalars['JSON']['output']>;
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
};
export type TestShippingMethodResult = {
__typename?: 'TestShippingMethodResult';
eligible: Scalars['Boolean']['output'];
quote?: Maybe<TestShippingMethodQuote>;
};
export type TextCustomFieldConfig = CustomField & {
__typename?: 'TextCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type TransitionFulfillmentToStateResult = Fulfillment | FulfillmentStateTransitionError;
export type TransitionOrderToStateResult = Order | OrderStateTransitionError;
export type TransitionPaymentToStateResult = Payment | PaymentStateTransitionError;
export type UpdateActiveAdministratorInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress?: InputMaybe<Scalars['String']['input']>;
firstName?: InputMaybe<Scalars['String']['input']>;
lastName?: InputMaybe<Scalars['String']['input']>;
password?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateAddressInput = {
city?: InputMaybe<Scalars['String']['input']>;
company?: InputMaybe<Scalars['String']['input']>;
countryCode?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
defaultBillingAddress?: InputMaybe<Scalars['Boolean']['input']>;
defaultShippingAddress?: InputMaybe<Scalars['Boolean']['input']>;
fullName?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
phoneNumber?: InputMaybe<Scalars['String']['input']>;
postalCode?: InputMaybe<Scalars['String']['input']>;
province?: InputMaybe<Scalars['String']['input']>;
streetLine1?: InputMaybe<Scalars['String']['input']>;
streetLine2?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateAdministratorInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress?: InputMaybe<Scalars['String']['input']>;
firstName?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
lastName?: InputMaybe<Scalars['String']['input']>;
password?: InputMaybe<Scalars['String']['input']>;
roleIds?: InputMaybe<Array<Scalars['ID']['input']>>;
};
export type UpdateAssetInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
focalPoint?: InputMaybe<CoordinateInput>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
tags?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type UpdateChannelInput = {
availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
defaultCurrencyCode?: InputMaybe<CurrencyCode>;
defaultLanguageCode?: InputMaybe<LanguageCode>;
defaultShippingZoneId?: InputMaybe<Scalars['ID']['input']>;
defaultTaxZoneId?: InputMaybe<Scalars['ID']['input']>;
id: Scalars['ID']['input'];
outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
pricesIncludeTax?: InputMaybe<Scalars['Boolean']['input']>;
sellerId?: InputMaybe<Scalars['ID']['input']>;
token?: InputMaybe<Scalars['String']['input']>;
trackInventory?: InputMaybe<Scalars['Boolean']['input']>;
};
export type UpdateChannelResult = Channel | LanguageNotAvailableError;
export type UpdateCollectionInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
filters?: InputMaybe<Array<ConfigurableOperationInput>>;
id: Scalars['ID']['input'];
inheritFilters?: InputMaybe<Scalars['Boolean']['input']>;
isPrivate?: InputMaybe<Scalars['Boolean']['input']>;
parentId?: InputMaybe<Scalars['ID']['input']>;
translations?: InputMaybe<Array<UpdateCollectionTranslationInput>>;
};
export type UpdateCollectionTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
slug?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateCountryInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<CountryTranslationInput>>;
};
export type UpdateCustomerGroupInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateCustomerInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress?: InputMaybe<Scalars['String']['input']>;
firstName?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
lastName?: InputMaybe<Scalars['String']['input']>;
phoneNumber?: InputMaybe<Scalars['String']['input']>;
title?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateCustomerNoteInput = {
note: Scalars['String']['input'];
noteId: Scalars['ID']['input'];
};
export type UpdateCustomerResult = Customer | EmailAddressConflictError;
export type UpdateFacetInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
isPrivate?: InputMaybe<Scalars['Boolean']['input']>;
translations?: InputMaybe<Array<FacetTranslationInput>>;
};
export type UpdateFacetValueInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<FacetValueTranslationInput>>;
};
export type UpdateGlobalSettingsInput = {
availableLanguages?: InputMaybe<Array<LanguageCode>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
trackInventory?: InputMaybe<Scalars['Boolean']['input']>;
};
export type UpdateGlobalSettingsResult = ChannelDefaultLanguageError | GlobalSettings;
export type UpdateOrderAddressInput = {
city?: InputMaybe<Scalars['String']['input']>;
company?: InputMaybe<Scalars['String']['input']>;
countryCode?: InputMaybe<Scalars['String']['input']>;
fullName?: InputMaybe<Scalars['String']['input']>;
phoneNumber?: InputMaybe<Scalars['String']['input']>;
postalCode?: InputMaybe<Scalars['String']['input']>;
province?: InputMaybe<Scalars['String']['input']>;
streetLine1?: InputMaybe<Scalars['String']['input']>;
streetLine2?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateOrderInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
};
export type UpdateOrderItemsResult =
| InsufficientStockError
| NegativeQuantityError
| Order
| OrderLimitError
| OrderModificationError;
export type UpdateOrderNoteInput = {
isPublic?: InputMaybe<Scalars['Boolean']['input']>;
note?: InputMaybe<Scalars['String']['input']>;
noteId: Scalars['ID']['input'];
};
export type UpdatePaymentMethodInput = {
checker?: InputMaybe<ConfigurableOperationInput>;
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
handler?: InputMaybe<ConfigurableOperationInput>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<PaymentMethodTranslationInput>>;
};
export type UpdateProductCustomFieldsInput = {
featuredReviewId?: InputMaybe<Scalars['ID']['input']>;
reviewCount?: InputMaybe<Scalars['Float']['input']>;
reviewRating?: InputMaybe<Scalars['Float']['input']>;
};
export type UpdateProductInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<UpdateProductCustomFieldsInput>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<ProductTranslationInput>>;
};
export type UpdateProductOptionGroupInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<ProductOptionGroupTranslationInput>>;
};
export type UpdateProductOptionInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<ProductOptionGroupTranslationInput>>;
};
export type UpdateProductReviewInput = {
body?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
response?: InputMaybe<Scalars['String']['input']>;
summary?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateProductVariantInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
id: Scalars['ID']['input'];
optionIds?: InputMaybe<Array<Scalars['ID']['input']>>;
outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
/** Sets the price for the ProductVariant in the Channel's default currency */
price?: InputMaybe<Scalars['Money']['input']>;
/** Allows multiple prices to be set for the ProductVariant in different currencies. */
prices?: InputMaybe<Array<ProductVariantPriceInput>>;
sku?: InputMaybe<Scalars['String']['input']>;
stockLevels?: InputMaybe<Array<StockLevelInput>>;
stockOnHand?: InputMaybe<Scalars['Int']['input']>;
taxCategoryId?: InputMaybe<Scalars['ID']['input']>;
trackInventory?: InputMaybe<GlobalFlag>;
translations?: InputMaybe<Array<ProductVariantTranslationInput>>;
useGlobalOutOfStockThreshold?: InputMaybe<Scalars['Boolean']['input']>;
};
export type UpdatePromotionInput = {
actions?: InputMaybe<Array<ConfigurableOperationInput>>;
conditions?: InputMaybe<Array<ConfigurableOperationInput>>;
couponCode?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
endsAt?: InputMaybe<Scalars['DateTime']['input']>;
id: Scalars['ID']['input'];
perCustomerUsageLimit?: InputMaybe<Scalars['Int']['input']>;
startsAt?: InputMaybe<Scalars['DateTime']['input']>;
translations?: InputMaybe<Array<PromotionTranslationInput>>;
};
export type UpdatePromotionResult = MissingConditionsError | Promotion;
export type UpdateProvinceInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<ProvinceTranslationInput>>;
};
export type UpdateRoleInput = {
channelIds?: InputMaybe<Array<Scalars['ID']['input']>>;
code?: InputMaybe<Scalars['String']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
permissions?: InputMaybe<Array<Permission>>;
};
export type UpdateSellerInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateShippingMethodInput = {
calculator?: InputMaybe<ConfigurableOperationInput>;
checker?: InputMaybe<ConfigurableOperationInput>;
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
fulfillmentHandler?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
translations: Array<ShippingMethodTranslationInput>;
};
export type UpdateStockLocationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateTagInput = {
id: Scalars['ID']['input'];
value?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateTaxCategoryInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
isDefault?: InputMaybe<Scalars['Boolean']['input']>;
name?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateTaxRateInput = {
categoryId?: InputMaybe<Scalars['ID']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
customerGroupId?: InputMaybe<Scalars['ID']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
value?: InputMaybe<Scalars['Float']['input']>;
zoneId?: InputMaybe<Scalars['ID']['input']>;
};
export type UpdateZoneInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
};
export type User = Node & {
__typename?: 'User';
authenticationMethods: Array<AuthenticationMethod>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
identifier: Scalars['String']['output'];
lastLogin?: Maybe<Scalars['DateTime']['output']>;
roles: Array<Role>;
updatedAt: Scalars['DateTime']['output'];
verified: Scalars['Boolean']['output'];
};
export type Zone = Node & {
__typename?: 'Zone';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
members: Array<Region>;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ZoneFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ZoneList = PaginatedList & {
__typename?: 'ZoneList';
items: Array<Zone>;
totalItems: Scalars['Int']['output'];
};
export type ZoneListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ZoneFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ZoneSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ZoneSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
|
/* eslint-disable */
export type Maybe<T> = T;
export type InputMaybe<T> = T;
export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
export type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]?: Maybe<T[SubKey]> };
export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]: Maybe<T[SubKey]> };
export type MakeEmpty<T extends { [key: string]: unknown }, K extends keyof T> = { [_ in K]?: never };
export type Incremental<T> =
| T
| { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
/** All built-in and custom scalars, mapped to their actual values */
export type Scalars = {
ID: { input: string | number; output: string | number };
String: { input: string; output: string };
Boolean: { input: boolean; output: boolean };
Int: { input: number; output: number };
Float: { input: number; output: number };
DateTime: { input: any; output: any };
JSON: { input: any; output: any };
Money: { input: any; output: any };
Upload: { input: any; output: any };
};
export type ActiveOrderResult = NoActiveOrderError | Order;
export type AddPaymentToOrderResult =
| IneligiblePaymentMethodError
| NoActiveOrderError
| Order
| OrderPaymentStateError
| OrderStateTransitionError
| PaymentDeclinedError
| PaymentFailedError;
export type Address = Node & {
__typename?: 'Address';
city?: Maybe<Scalars['String']['output']>;
company?: Maybe<Scalars['String']['output']>;
country: Country;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
defaultBillingAddress?: Maybe<Scalars['Boolean']['output']>;
defaultShippingAddress?: Maybe<Scalars['Boolean']['output']>;
fullName?: Maybe<Scalars['String']['output']>;
id: Scalars['ID']['output'];
phoneNumber?: Maybe<Scalars['String']['output']>;
postalCode?: Maybe<Scalars['String']['output']>;
province?: Maybe<Scalars['String']['output']>;
streetLine1: Scalars['String']['output'];
streetLine2?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type Adjustment = {
__typename?: 'Adjustment';
adjustmentSource: Scalars['String']['output'];
amount: Scalars['Money']['output'];
data?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
type: AdjustmentType;
};
export enum AdjustmentType {
DISTRIBUTED_ORDER_PROMOTION = 'DISTRIBUTED_ORDER_PROMOTION',
OTHER = 'OTHER',
PROMOTION = 'PROMOTION',
}
/** Returned when attempting to set the Customer for an Order when already logged in. */
export type AlreadyLoggedInError = ErrorResult & {
__typename?: 'AlreadyLoggedInError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type ApplyCouponCodeResult =
| CouponCodeExpiredError
| CouponCodeInvalidError
| CouponCodeLimitError
| Order;
export type Asset = Node & {
__typename?: 'Asset';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
fileSize: Scalars['Int']['output'];
focalPoint?: Maybe<Coordinate>;
height: Scalars['Int']['output'];
id: Scalars['ID']['output'];
mimeType: Scalars['String']['output'];
name: Scalars['String']['output'];
preview: Scalars['String']['output'];
source: Scalars['String']['output'];
tags: Array<Tag>;
type: AssetType;
updatedAt: Scalars['DateTime']['output'];
width: Scalars['Int']['output'];
};
export type AssetList = PaginatedList & {
__typename?: 'AssetList';
items: Array<Asset>;
totalItems: Scalars['Int']['output'];
};
export enum AssetType {
BINARY = 'BINARY',
IMAGE = 'IMAGE',
VIDEO = 'VIDEO',
}
export type AuthenticationInput = {
native?: InputMaybe<NativeAuthInput>;
};
export type AuthenticationMethod = Node & {
__typename?: 'AuthenticationMethod';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
strategy: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type AuthenticationResult = CurrentUser | InvalidCredentialsError | NotVerifiedError;
export type BooleanCustomFieldConfig = CustomField & {
__typename?: 'BooleanCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
/** Operators for filtering on a list of Boolean fields */
export type BooleanListOperators = {
inList: Scalars['Boolean']['input'];
};
/** Operators for filtering on a Boolean field */
export type BooleanOperators = {
eq?: InputMaybe<Scalars['Boolean']['input']>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
};
export type Channel = Node & {
__typename?: 'Channel';
availableCurrencyCodes: Array<CurrencyCode>;
availableLanguageCodes?: Maybe<Array<LanguageCode>>;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
/** @deprecated Use defaultCurrencyCode instead */
currencyCode: CurrencyCode;
customFields?: Maybe<Scalars['JSON']['output']>;
defaultCurrencyCode: CurrencyCode;
defaultLanguageCode: LanguageCode;
defaultShippingZone?: Maybe<Zone>;
defaultTaxZone?: Maybe<Zone>;
id: Scalars['ID']['output'];
/** Not yet used - will be implemented in a future release. */
outOfStockThreshold?: Maybe<Scalars['Int']['output']>;
pricesIncludeTax: Scalars['Boolean']['output'];
seller?: Maybe<Seller>;
token: Scalars['String']['output'];
/** Not yet used - will be implemented in a future release. */
trackInventory?: Maybe<Scalars['Boolean']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type Collection = Node & {
__typename?: 'Collection';
assets: Array<Asset>;
breadcrumbs: Array<CollectionBreadcrumb>;
children?: Maybe<Array<Collection>>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
featuredAsset?: Maybe<Asset>;
filters: Array<ConfigurableOperation>;
id: Scalars['ID']['output'];
languageCode?: Maybe<LanguageCode>;
name: Scalars['String']['output'];
parent?: Maybe<Collection>;
parentId: Scalars['ID']['output'];
position: Scalars['Int']['output'];
productVariants: ProductVariantList;
slug: Scalars['String']['output'];
translations: Array<CollectionTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type CollectionProductVariantsArgs = {
options?: InputMaybe<ProductVariantListOptions>;
};
export type CollectionBreadcrumb = {
__typename?: 'CollectionBreadcrumb';
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
slug: Scalars['String']['output'];
};
export type CollectionFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
parentId?: InputMaybe<IdOperators>;
position?: InputMaybe<NumberOperators>;
slug?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CollectionList = PaginatedList & {
__typename?: 'CollectionList';
items: Array<Collection>;
totalItems: Scalars['Int']['output'];
};
export type CollectionListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CollectionFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CollectionSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
/**
* Which Collections are present in the products returned
* by the search, and in what quantity.
*/
export type CollectionResult = {
__typename?: 'CollectionResult';
collection: Collection;
count: Scalars['Int']['output'];
};
export type CollectionSortParameter = {
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
parentId?: InputMaybe<SortOrder>;
position?: InputMaybe<SortOrder>;
slug?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type CollectionTranslation = {
__typename?: 'CollectionTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
slug: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ConfigArg = {
__typename?: 'ConfigArg';
name: Scalars['String']['output'];
value: Scalars['String']['output'];
};
export type ConfigArgDefinition = {
__typename?: 'ConfigArgDefinition';
defaultValue?: Maybe<Scalars['JSON']['output']>;
description?: Maybe<Scalars['String']['output']>;
label?: Maybe<Scalars['String']['output']>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
required: Scalars['Boolean']['output'];
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type ConfigArgInput = {
name: Scalars['String']['input'];
/** A JSON stringified representation of the actual value */
value: Scalars['String']['input'];
};
export type ConfigurableOperation = {
__typename?: 'ConfigurableOperation';
args: Array<ConfigArg>;
code: Scalars['String']['output'];
};
export type ConfigurableOperationDefinition = {
__typename?: 'ConfigurableOperationDefinition';
args: Array<ConfigArgDefinition>;
code: Scalars['String']['output'];
description: Scalars['String']['output'];
};
export type ConfigurableOperationInput = {
arguments: Array<ConfigArgInput>;
code: Scalars['String']['input'];
};
export type Coordinate = {
__typename?: 'Coordinate';
x: Scalars['Float']['output'];
y: Scalars['Float']['output'];
};
export type Country = Node &
Region & {
__typename?: 'Country';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
parent?: Maybe<Region>;
parentId?: Maybe<Scalars['ID']['output']>;
translations: Array<RegionTranslation>;
type: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type CountryList = PaginatedList & {
__typename?: 'CountryList';
items: Array<Country>;
totalItems: Scalars['Int']['output'];
};
/** Returned if the provided coupon code is invalid */
export type CouponCodeExpiredError = ErrorResult & {
__typename?: 'CouponCodeExpiredError';
couponCode: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the provided coupon code is invalid */
export type CouponCodeInvalidError = ErrorResult & {
__typename?: 'CouponCodeInvalidError';
couponCode: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the provided coupon code is invalid */
export type CouponCodeLimitError = ErrorResult & {
__typename?: 'CouponCodeLimitError';
couponCode: Scalars['String']['output'];
errorCode: ErrorCode;
limit: Scalars['Int']['output'];
message: Scalars['String']['output'];
};
export type CreateAddressInput = {
city?: InputMaybe<Scalars['String']['input']>;
company?: InputMaybe<Scalars['String']['input']>;
countryCode: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
defaultBillingAddress?: InputMaybe<Scalars['Boolean']['input']>;
defaultShippingAddress?: InputMaybe<Scalars['Boolean']['input']>;
fullName?: InputMaybe<Scalars['String']['input']>;
phoneNumber?: InputMaybe<Scalars['String']['input']>;
postalCode?: InputMaybe<Scalars['String']['input']>;
province?: InputMaybe<Scalars['String']['input']>;
streetLine1: Scalars['String']['input'];
streetLine2?: InputMaybe<Scalars['String']['input']>;
};
export type CreateCustomerInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress: Scalars['String']['input'];
firstName: Scalars['String']['input'];
lastName: Scalars['String']['input'];
phoneNumber?: InputMaybe<Scalars['String']['input']>;
title?: InputMaybe<Scalars['String']['input']>;
};
/**
* @description
* ISO 4217 currency code
*
* @docsCategory common
*/
export enum CurrencyCode {
/** United Arab Emirates dirham */
AED = 'AED',
/** Afghan afghani */
AFN = 'AFN',
/** Albanian lek */
ALL = 'ALL',
/** Armenian dram */
AMD = 'AMD',
/** Netherlands Antillean guilder */
ANG = 'ANG',
/** Angolan kwanza */
AOA = 'AOA',
/** Argentine peso */
ARS = 'ARS',
/** Australian dollar */
AUD = 'AUD',
/** Aruban florin */
AWG = 'AWG',
/** Azerbaijani manat */
AZN = 'AZN',
/** Bosnia and Herzegovina convertible mark */
BAM = 'BAM',
/** Barbados dollar */
BBD = 'BBD',
/** Bangladeshi taka */
BDT = 'BDT',
/** Bulgarian lev */
BGN = 'BGN',
/** Bahraini dinar */
BHD = 'BHD',
/** Burundian franc */
BIF = 'BIF',
/** Bermudian dollar */
BMD = 'BMD',
/** Brunei dollar */
BND = 'BND',
/** Boliviano */
BOB = 'BOB',
/** Brazilian real */
BRL = 'BRL',
/** Bahamian dollar */
BSD = 'BSD',
/** Bhutanese ngultrum */
BTN = 'BTN',
/** Botswana pula */
BWP = 'BWP',
/** Belarusian ruble */
BYN = 'BYN',
/** Belize dollar */
BZD = 'BZD',
/** Canadian dollar */
CAD = 'CAD',
/** Congolese franc */
CDF = 'CDF',
/** Swiss franc */
CHF = 'CHF',
/** Chilean peso */
CLP = 'CLP',
/** Renminbi (Chinese) yuan */
CNY = 'CNY',
/** Colombian peso */
COP = 'COP',
/** Costa Rican colon */
CRC = 'CRC',
/** Cuban convertible peso */
CUC = 'CUC',
/** Cuban peso */
CUP = 'CUP',
/** Cape Verde escudo */
CVE = 'CVE',
/** Czech koruna */
CZK = 'CZK',
/** Djiboutian franc */
DJF = 'DJF',
/** Danish krone */
DKK = 'DKK',
/** Dominican peso */
DOP = 'DOP',
/** Algerian dinar */
DZD = 'DZD',
/** Egyptian pound */
EGP = 'EGP',
/** Eritrean nakfa */
ERN = 'ERN',
/** Ethiopian birr */
ETB = 'ETB',
/** Euro */
EUR = 'EUR',
/** Fiji dollar */
FJD = 'FJD',
/** Falkland Islands pound */
FKP = 'FKP',
/** Pound sterling */
GBP = 'GBP',
/** Georgian lari */
GEL = 'GEL',
/** Ghanaian cedi */
GHS = 'GHS',
/** Gibraltar pound */
GIP = 'GIP',
/** Gambian dalasi */
GMD = 'GMD',
/** Guinean franc */
GNF = 'GNF',
/** Guatemalan quetzal */
GTQ = 'GTQ',
/** Guyanese dollar */
GYD = 'GYD',
/** Hong Kong dollar */
HKD = 'HKD',
/** Honduran lempira */
HNL = 'HNL',
/** Croatian kuna */
HRK = 'HRK',
/** Haitian gourde */
HTG = 'HTG',
/** Hungarian forint */
HUF = 'HUF',
/** Indonesian rupiah */
IDR = 'IDR',
/** Israeli new shekel */
ILS = 'ILS',
/** Indian rupee */
INR = 'INR',
/** Iraqi dinar */
IQD = 'IQD',
/** Iranian rial */
IRR = 'IRR',
/** Icelandic króna */
ISK = 'ISK',
/** Jamaican dollar */
JMD = 'JMD',
/** Jordanian dinar */
JOD = 'JOD',
/** Japanese yen */
JPY = 'JPY',
/** Kenyan shilling */
KES = 'KES',
/** Kyrgyzstani som */
KGS = 'KGS',
/** Cambodian riel */
KHR = 'KHR',
/** Comoro franc */
KMF = 'KMF',
/** North Korean won */
KPW = 'KPW',
/** South Korean won */
KRW = 'KRW',
/** Kuwaiti dinar */
KWD = 'KWD',
/** Cayman Islands dollar */
KYD = 'KYD',
/** Kazakhstani tenge */
KZT = 'KZT',
/** Lao kip */
LAK = 'LAK',
/** Lebanese pound */
LBP = 'LBP',
/** Sri Lankan rupee */
LKR = 'LKR',
/** Liberian dollar */
LRD = 'LRD',
/** Lesotho loti */
LSL = 'LSL',
/** Libyan dinar */
LYD = 'LYD',
/** Moroccan dirham */
MAD = 'MAD',
/** Moldovan leu */
MDL = 'MDL',
/** Malagasy ariary */
MGA = 'MGA',
/** Macedonian denar */
MKD = 'MKD',
/** Myanmar kyat */
MMK = 'MMK',
/** Mongolian tögrög */
MNT = 'MNT',
/** Macanese pataca */
MOP = 'MOP',
/** Mauritanian ouguiya */
MRU = 'MRU',
/** Mauritian rupee */
MUR = 'MUR',
/** Maldivian rufiyaa */
MVR = 'MVR',
/** Malawian kwacha */
MWK = 'MWK',
/** Mexican peso */
MXN = 'MXN',
/** Malaysian ringgit */
MYR = 'MYR',
/** Mozambican metical */
MZN = 'MZN',
/** Namibian dollar */
NAD = 'NAD',
/** Nigerian naira */
NGN = 'NGN',
/** Nicaraguan córdoba */
NIO = 'NIO',
/** Norwegian krone */
NOK = 'NOK',
/** Nepalese rupee */
NPR = 'NPR',
/** New Zealand dollar */
NZD = 'NZD',
/** Omani rial */
OMR = 'OMR',
/** Panamanian balboa */
PAB = 'PAB',
/** Peruvian sol */
PEN = 'PEN',
/** Papua New Guinean kina */
PGK = 'PGK',
/** Philippine peso */
PHP = 'PHP',
/** Pakistani rupee */
PKR = 'PKR',
/** Polish złoty */
PLN = 'PLN',
/** Paraguayan guaraní */
PYG = 'PYG',
/** Qatari riyal */
QAR = 'QAR',
/** Romanian leu */
RON = 'RON',
/** Serbian dinar */
RSD = 'RSD',
/** Russian ruble */
RUB = 'RUB',
/** Rwandan franc */
RWF = 'RWF',
/** Saudi riyal */
SAR = 'SAR',
/** Solomon Islands dollar */
SBD = 'SBD',
/** Seychelles rupee */
SCR = 'SCR',
/** Sudanese pound */
SDG = 'SDG',
/** Swedish krona/kronor */
SEK = 'SEK',
/** Singapore dollar */
SGD = 'SGD',
/** Saint Helena pound */
SHP = 'SHP',
/** Sierra Leonean leone */
SLL = 'SLL',
/** Somali shilling */
SOS = 'SOS',
/** Surinamese dollar */
SRD = 'SRD',
/** South Sudanese pound */
SSP = 'SSP',
/** São Tomé and Príncipe dobra */
STN = 'STN',
/** Salvadoran colón */
SVC = 'SVC',
/** Syrian pound */
SYP = 'SYP',
/** Swazi lilangeni */
SZL = 'SZL',
/** Thai baht */
THB = 'THB',
/** Tajikistani somoni */
TJS = 'TJS',
/** Turkmenistan manat */
TMT = 'TMT',
/** Tunisian dinar */
TND = 'TND',
/** Tongan paʻanga */
TOP = 'TOP',
/** Turkish lira */
TRY = 'TRY',
/** Trinidad and Tobago dollar */
TTD = 'TTD',
/** New Taiwan dollar */
TWD = 'TWD',
/** Tanzanian shilling */
TZS = 'TZS',
/** Ukrainian hryvnia */
UAH = 'UAH',
/** Ugandan shilling */
UGX = 'UGX',
/** United States dollar */
USD = 'USD',
/** Uruguayan peso */
UYU = 'UYU',
/** Uzbekistan som */
UZS = 'UZS',
/** Venezuelan bolívar soberano */
VES = 'VES',
/** Vietnamese đồng */
VND = 'VND',
/** Vanuatu vatu */
VUV = 'VUV',
/** Samoan tala */
WST = 'WST',
/** CFA franc BEAC */
XAF = 'XAF',
/** East Caribbean dollar */
XCD = 'XCD',
/** CFA franc BCEAO */
XOF = 'XOF',
/** CFP franc (franc Pacifique) */
XPF = 'XPF',
/** Yemeni rial */
YER = 'YER',
/** South African rand */
ZAR = 'ZAR',
/** Zambian kwacha */
ZMW = 'ZMW',
/** Zimbabwean dollar */
ZWL = 'ZWL',
}
export type CurrentUser = {
__typename?: 'CurrentUser';
channels: Array<CurrentUserChannel>;
id: Scalars['ID']['output'];
identifier: Scalars['String']['output'];
};
export type CurrentUserChannel = {
__typename?: 'CurrentUserChannel';
code: Scalars['String']['output'];
id: Scalars['ID']['output'];
permissions: Array<Permission>;
token: Scalars['String']['output'];
};
export type CustomField = {
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type CustomFieldConfig =
| BooleanCustomFieldConfig
| DateTimeCustomFieldConfig
| FloatCustomFieldConfig
| IntCustomFieldConfig
| LocaleStringCustomFieldConfig
| LocaleTextCustomFieldConfig
| RelationCustomFieldConfig
| StringCustomFieldConfig
| TextCustomFieldConfig;
export type Customer = Node & {
__typename?: 'Customer';
addresses?: Maybe<Array<Address>>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
emailAddress: Scalars['String']['output'];
firstName: Scalars['String']['output'];
id: Scalars['ID']['output'];
lastName: Scalars['String']['output'];
orders: OrderList;
phoneNumber?: Maybe<Scalars['String']['output']>;
title?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
user?: Maybe<User>;
};
export type CustomerOrdersArgs = {
options?: InputMaybe<OrderListOptions>;
};
export type CustomerFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
emailAddress?: InputMaybe<StringOperators>;
firstName?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
lastName?: InputMaybe<StringOperators>;
phoneNumber?: InputMaybe<StringOperators>;
title?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CustomerGroup = Node & {
__typename?: 'CustomerGroup';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
customers: CustomerList;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type CustomerGroupCustomersArgs = {
options?: InputMaybe<CustomerListOptions>;
};
export type CustomerList = PaginatedList & {
__typename?: 'CustomerList';
items: Array<Customer>;
totalItems: Scalars['Int']['output'];
};
export type CustomerListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CustomerFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CustomerSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type CustomerSortParameter = {
createdAt?: InputMaybe<SortOrder>;
emailAddress?: InputMaybe<SortOrder>;
firstName?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
lastName?: InputMaybe<SortOrder>;
phoneNumber?: InputMaybe<SortOrder>;
title?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
/** Operators for filtering on a list of Date fields */
export type DateListOperators = {
inList: Scalars['DateTime']['input'];
};
/** Operators for filtering on a DateTime field */
export type DateOperators = {
after?: InputMaybe<Scalars['DateTime']['input']>;
before?: InputMaybe<Scalars['DateTime']['input']>;
between?: InputMaybe<DateRange>;
eq?: InputMaybe<Scalars['DateTime']['input']>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
};
export type DateRange = {
end: Scalars['DateTime']['input'];
start: Scalars['DateTime']['input'];
};
/**
* Expects the same validation formats as the `<input type="datetime-local">` HTML element.
* See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes
*/
export type DateTimeCustomFieldConfig = CustomField & {
__typename?: 'DateTimeCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['String']['output']>;
min?: Maybe<Scalars['String']['output']>;
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
step?: Maybe<Scalars['Int']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type DeletionResponse = {
__typename?: 'DeletionResponse';
message?: Maybe<Scalars['String']['output']>;
result: DeletionResult;
};
export enum DeletionResult {
/** The entity was successfully deleted */
DELETED = 'DELETED',
/** Deletion did not take place, reason given in message */
NOT_DELETED = 'NOT_DELETED',
}
export type Discount = {
__typename?: 'Discount';
adjustmentSource: Scalars['String']['output'];
amount: Scalars['Money']['output'];
amountWithTax: Scalars['Money']['output'];
description: Scalars['String']['output'];
type: AdjustmentType;
};
/** Returned when attempting to create a Customer with an email address already registered to an existing User. */
export type EmailAddressConflictError = ErrorResult & {
__typename?: 'EmailAddressConflictError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export enum ErrorCode {
ALREADY_LOGGED_IN_ERROR = 'ALREADY_LOGGED_IN_ERROR',
COUPON_CODE_EXPIRED_ERROR = 'COUPON_CODE_EXPIRED_ERROR',
COUPON_CODE_INVALID_ERROR = 'COUPON_CODE_INVALID_ERROR',
COUPON_CODE_LIMIT_ERROR = 'COUPON_CODE_LIMIT_ERROR',
EMAIL_ADDRESS_CONFLICT_ERROR = 'EMAIL_ADDRESS_CONFLICT_ERROR',
GUEST_CHECKOUT_ERROR = 'GUEST_CHECKOUT_ERROR',
IDENTIFIER_CHANGE_TOKEN_EXPIRED_ERROR = 'IDENTIFIER_CHANGE_TOKEN_EXPIRED_ERROR',
IDENTIFIER_CHANGE_TOKEN_INVALID_ERROR = 'IDENTIFIER_CHANGE_TOKEN_INVALID_ERROR',
INELIGIBLE_PAYMENT_METHOD_ERROR = 'INELIGIBLE_PAYMENT_METHOD_ERROR',
INELIGIBLE_SHIPPING_METHOD_ERROR = 'INELIGIBLE_SHIPPING_METHOD_ERROR',
INSUFFICIENT_STOCK_ERROR = 'INSUFFICIENT_STOCK_ERROR',
INVALID_CREDENTIALS_ERROR = 'INVALID_CREDENTIALS_ERROR',
MISSING_PASSWORD_ERROR = 'MISSING_PASSWORD_ERROR',
NATIVE_AUTH_STRATEGY_ERROR = 'NATIVE_AUTH_STRATEGY_ERROR',
NEGATIVE_QUANTITY_ERROR = 'NEGATIVE_QUANTITY_ERROR',
NOT_VERIFIED_ERROR = 'NOT_VERIFIED_ERROR',
NO_ACTIVE_ORDER_ERROR = 'NO_ACTIVE_ORDER_ERROR',
ORDER_LIMIT_ERROR = 'ORDER_LIMIT_ERROR',
ORDER_MODIFICATION_ERROR = 'ORDER_MODIFICATION_ERROR',
ORDER_PAYMENT_STATE_ERROR = 'ORDER_PAYMENT_STATE_ERROR',
ORDER_STATE_TRANSITION_ERROR = 'ORDER_STATE_TRANSITION_ERROR',
PASSWORD_ALREADY_SET_ERROR = 'PASSWORD_ALREADY_SET_ERROR',
PASSWORD_RESET_TOKEN_EXPIRED_ERROR = 'PASSWORD_RESET_TOKEN_EXPIRED_ERROR',
PASSWORD_RESET_TOKEN_INVALID_ERROR = 'PASSWORD_RESET_TOKEN_INVALID_ERROR',
PASSWORD_VALIDATION_ERROR = 'PASSWORD_VALIDATION_ERROR',
PAYMENT_DECLINED_ERROR = 'PAYMENT_DECLINED_ERROR',
PAYMENT_FAILED_ERROR = 'PAYMENT_FAILED_ERROR',
UNKNOWN_ERROR = 'UNKNOWN_ERROR',
VERIFICATION_TOKEN_EXPIRED_ERROR = 'VERIFICATION_TOKEN_EXPIRED_ERROR',
VERIFICATION_TOKEN_INVALID_ERROR = 'VERIFICATION_TOKEN_INVALID_ERROR',
}
export type ErrorResult = {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Facet = Node & {
__typename?: 'Facet';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<FacetTranslation>;
updatedAt: Scalars['DateTime']['output'];
values: Array<FacetValue>;
};
export type FacetFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type FacetList = PaginatedList & {
__typename?: 'FacetList';
items: Array<Facet>;
totalItems: Scalars['Int']['output'];
};
export type FacetListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<FacetFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<FacetSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type FacetSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type FacetTranslation = {
__typename?: 'FacetTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type FacetValue = Node & {
__typename?: 'FacetValue';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
facet: Facet;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<FacetValueTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
/**
* Used to construct boolean expressions for filtering search results
* by FacetValue ID. Examples:
*
* * ID=1 OR ID=2: `{ facetValueFilters: [{ or: [1,2] }] }`
* * ID=1 AND ID=2: `{ facetValueFilters: [{ and: 1 }, { and: 2 }] }`
* * ID=1 AND (ID=2 OR ID=3): `{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }`
*/
export type FacetValueFilterInput = {
and?: InputMaybe<Scalars['ID']['input']>;
or?: InputMaybe<Array<Scalars['ID']['input']>>;
};
/**
* Which FacetValues are present in the products returned
* by the search, and in what quantity.
*/
export type FacetValueResult = {
__typename?: 'FacetValueResult';
count: Scalars['Int']['output'];
facetValue: FacetValue;
};
export type FacetValueTranslation = {
__typename?: 'FacetValueTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type FloatCustomFieldConfig = CustomField & {
__typename?: 'FloatCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['Float']['output']>;
min?: Maybe<Scalars['Float']['output']>;
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
step?: Maybe<Scalars['Float']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type Fulfillment = Node & {
__typename?: 'Fulfillment';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
lines: Array<FulfillmentLine>;
method: Scalars['String']['output'];
state: Scalars['String']['output'];
/** @deprecated Use the `lines` field instead */
summary: Array<FulfillmentLine>;
trackingCode?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type FulfillmentLine = {
__typename?: 'FulfillmentLine';
fulfillment: Fulfillment;
fulfillmentId: Scalars['ID']['output'];
orderLine: OrderLine;
orderLineId: Scalars['ID']['output'];
quantity: Scalars['Int']['output'];
};
export enum GlobalFlag {
FALSE = 'FALSE',
INHERIT = 'INHERIT',
TRUE = 'TRUE',
}
/** Returned when attempting to set the Customer on a guest checkout when the configured GuestCheckoutStrategy does not allow it. */
export type GuestCheckoutError = ErrorResult & {
__typename?: 'GuestCheckoutError';
errorCode: ErrorCode;
errorDetail: Scalars['String']['output'];
message: Scalars['String']['output'];
};
export type HistoryEntry = Node & {
__typename?: 'HistoryEntry';
createdAt: Scalars['DateTime']['output'];
data: Scalars['JSON']['output'];
id: Scalars['ID']['output'];
type: HistoryEntryType;
updatedAt: Scalars['DateTime']['output'];
};
export type HistoryEntryFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type HistoryEntryList = PaginatedList & {
__typename?: 'HistoryEntryList';
items: Array<HistoryEntry>;
totalItems: Scalars['Int']['output'];
};
export type HistoryEntryListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<HistoryEntryFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<HistoryEntrySortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type HistoryEntrySortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export enum HistoryEntryType {
CUSTOMER_ADDED_TO_GROUP = 'CUSTOMER_ADDED_TO_GROUP',
CUSTOMER_ADDRESS_CREATED = 'CUSTOMER_ADDRESS_CREATED',
CUSTOMER_ADDRESS_DELETED = 'CUSTOMER_ADDRESS_DELETED',
CUSTOMER_ADDRESS_UPDATED = 'CUSTOMER_ADDRESS_UPDATED',
CUSTOMER_DETAIL_UPDATED = 'CUSTOMER_DETAIL_UPDATED',
CUSTOMER_EMAIL_UPDATE_REQUESTED = 'CUSTOMER_EMAIL_UPDATE_REQUESTED',
CUSTOMER_EMAIL_UPDATE_VERIFIED = 'CUSTOMER_EMAIL_UPDATE_VERIFIED',
CUSTOMER_NOTE = 'CUSTOMER_NOTE',
CUSTOMER_PASSWORD_RESET_REQUESTED = 'CUSTOMER_PASSWORD_RESET_REQUESTED',
CUSTOMER_PASSWORD_RESET_VERIFIED = 'CUSTOMER_PASSWORD_RESET_VERIFIED',
CUSTOMER_PASSWORD_UPDATED = 'CUSTOMER_PASSWORD_UPDATED',
CUSTOMER_REGISTERED = 'CUSTOMER_REGISTERED',
CUSTOMER_REMOVED_FROM_GROUP = 'CUSTOMER_REMOVED_FROM_GROUP',
CUSTOMER_VERIFIED = 'CUSTOMER_VERIFIED',
ORDER_CANCELLATION = 'ORDER_CANCELLATION',
ORDER_COUPON_APPLIED = 'ORDER_COUPON_APPLIED',
ORDER_COUPON_REMOVED = 'ORDER_COUPON_REMOVED',
ORDER_FULFILLMENT = 'ORDER_FULFILLMENT',
ORDER_FULFILLMENT_TRANSITION = 'ORDER_FULFILLMENT_TRANSITION',
ORDER_MODIFIED = 'ORDER_MODIFIED',
ORDER_NOTE = 'ORDER_NOTE',
ORDER_PAYMENT_TRANSITION = 'ORDER_PAYMENT_TRANSITION',
ORDER_REFUND_TRANSITION = 'ORDER_REFUND_TRANSITION',
ORDER_STATE_TRANSITION = 'ORDER_STATE_TRANSITION',
}
/** Operators for filtering on a list of ID fields */
export type IdListOperators = {
inList: Scalars['ID']['input'];
};
/** Operators for filtering on an ID field */
export type IdOperators = {
eq?: InputMaybe<Scalars['String']['input']>;
in?: InputMaybe<Array<Scalars['String']['input']>>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
notEq?: InputMaybe<Scalars['String']['input']>;
notIn?: InputMaybe<Array<Scalars['String']['input']>>;
};
/**
* Returned if the token used to change a Customer's email address is valid, but has
* expired according to the `verificationTokenDuration` setting in the AuthOptions.
*/
export type IdentifierChangeTokenExpiredError = ErrorResult & {
__typename?: 'IdentifierChangeTokenExpiredError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/**
* Returned if the token used to change a Customer's email address is either
* invalid or does not match any expected tokens.
*/
export type IdentifierChangeTokenInvalidError = ErrorResult & {
__typename?: 'IdentifierChangeTokenInvalidError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when attempting to add a Payment using a PaymentMethod for which the Order is not eligible. */
export type IneligiblePaymentMethodError = ErrorResult & {
__typename?: 'IneligiblePaymentMethodError';
eligibilityCheckerMessage?: Maybe<Scalars['String']['output']>;
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when attempting to set a ShippingMethod for which the Order is not eligible */
export type IneligibleShippingMethodError = ErrorResult & {
__typename?: 'IneligibleShippingMethodError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when attempting to add more items to the Order than are available */
export type InsufficientStockError = ErrorResult & {
__typename?: 'InsufficientStockError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
order: Order;
quantityAvailable: Scalars['Int']['output'];
};
export type IntCustomFieldConfig = CustomField & {
__typename?: 'IntCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['Int']['output']>;
min?: Maybe<Scalars['Int']['output']>;
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
step?: Maybe<Scalars['Int']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
/** Returned if the user authentication credentials are not valid */
export type InvalidCredentialsError = ErrorResult & {
__typename?: 'InvalidCredentialsError';
authenticationError: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/**
* @description
* Languages in the form of a ISO 639-1 language code with optional
* region or script modifier (e.g. de_AT). The selection available is based
* on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)
* and includes the major spoken languages of the world and any widely-used variants.
*
* @docsCategory common
*/
export enum LanguageCode {
/** Afrikaans */
af = 'af',
/** Akan */
ak = 'ak',
/** Amharic */
am = 'am',
/** Arabic */
ar = 'ar',
/** Assamese */
as = 'as',
/** Azerbaijani */
az = 'az',
/** Belarusian */
be = 'be',
/** Bulgarian */
bg = 'bg',
/** Bambara */
bm = 'bm',
/** Bangla */
bn = 'bn',
/** Tibetan */
bo = 'bo',
/** Breton */
br = 'br',
/** Bosnian */
bs = 'bs',
/** Catalan */
ca = 'ca',
/** Chechen */
ce = 'ce',
/** Corsican */
co = 'co',
/** Czech */
cs = 'cs',
/** Church Slavic */
cu = 'cu',
/** Welsh */
cy = 'cy',
/** Danish */
da = 'da',
/** German */
de = 'de',
/** Austrian German */
de_AT = 'de_AT',
/** Swiss High German */
de_CH = 'de_CH',
/** Dzongkha */
dz = 'dz',
/** Ewe */
ee = 'ee',
/** Greek */
el = 'el',
/** English */
en = 'en',
/** Australian English */
en_AU = 'en_AU',
/** Canadian English */
en_CA = 'en_CA',
/** British English */
en_GB = 'en_GB',
/** American English */
en_US = 'en_US',
/** Esperanto */
eo = 'eo',
/** Spanish */
es = 'es',
/** European Spanish */
es_ES = 'es_ES',
/** Mexican Spanish */
es_MX = 'es_MX',
/** Estonian */
et = 'et',
/** Basque */
eu = 'eu',
/** Persian */
fa = 'fa',
/** Dari */
fa_AF = 'fa_AF',
/** Fulah */
ff = 'ff',
/** Finnish */
fi = 'fi',
/** Faroese */
fo = 'fo',
/** French */
fr = 'fr',
/** Canadian French */
fr_CA = 'fr_CA',
/** Swiss French */
fr_CH = 'fr_CH',
/** Western Frisian */
fy = 'fy',
/** Irish */
ga = 'ga',
/** Scottish Gaelic */
gd = 'gd',
/** Galician */
gl = 'gl',
/** Gujarati */
gu = 'gu',
/** Manx */
gv = 'gv',
/** Hausa */
ha = 'ha',
/** Hebrew */
he = 'he',
/** Hindi */
hi = 'hi',
/** Croatian */
hr = 'hr',
/** Haitian Creole */
ht = 'ht',
/** Hungarian */
hu = 'hu',
/** Armenian */
hy = 'hy',
/** Interlingua */
ia = 'ia',
/** Indonesian */
id = 'id',
/** Igbo */
ig = 'ig',
/** Sichuan Yi */
ii = 'ii',
/** Icelandic */
is = 'is',
/** Italian */
it = 'it',
/** Japanese */
ja = 'ja',
/** Javanese */
jv = 'jv',
/** Georgian */
ka = 'ka',
/** Kikuyu */
ki = 'ki',
/** Kazakh */
kk = 'kk',
/** Kalaallisut */
kl = 'kl',
/** Khmer */
km = 'km',
/** Kannada */
kn = 'kn',
/** Korean */
ko = 'ko',
/** Kashmiri */
ks = 'ks',
/** Kurdish */
ku = 'ku',
/** Cornish */
kw = 'kw',
/** Kyrgyz */
ky = 'ky',
/** Latin */
la = 'la',
/** Luxembourgish */
lb = 'lb',
/** Ganda */
lg = 'lg',
/** Lingala */
ln = 'ln',
/** Lao */
lo = 'lo',
/** Lithuanian */
lt = 'lt',
/** Luba-Katanga */
lu = 'lu',
/** Latvian */
lv = 'lv',
/** Malagasy */
mg = 'mg',
/** Maori */
mi = 'mi',
/** Macedonian */
mk = 'mk',
/** Malayalam */
ml = 'ml',
/** Mongolian */
mn = 'mn',
/** Marathi */
mr = 'mr',
/** Malay */
ms = 'ms',
/** Maltese */
mt = 'mt',
/** Burmese */
my = 'my',
/** Norwegian Bokmål */
nb = 'nb',
/** North Ndebele */
nd = 'nd',
/** Nepali */
ne = 'ne',
/** Dutch */
nl = 'nl',
/** Flemish */
nl_BE = 'nl_BE',
/** Norwegian Nynorsk */
nn = 'nn',
/** Nyanja */
ny = 'ny',
/** Oromo */
om = 'om',
/** Odia */
or = 'or',
/** Ossetic */
os = 'os',
/** Punjabi */
pa = 'pa',
/** Polish */
pl = 'pl',
/** Pashto */
ps = 'ps',
/** Portuguese */
pt = 'pt',
/** Brazilian Portuguese */
pt_BR = 'pt_BR',
/** European Portuguese */
pt_PT = 'pt_PT',
/** Quechua */
qu = 'qu',
/** Romansh */
rm = 'rm',
/** Rundi */
rn = 'rn',
/** Romanian */
ro = 'ro',
/** Moldavian */
ro_MD = 'ro_MD',
/** Russian */
ru = 'ru',
/** Kinyarwanda */
rw = 'rw',
/** Sanskrit */
sa = 'sa',
/** Sindhi */
sd = 'sd',
/** Northern Sami */
se = 'se',
/** Sango */
sg = 'sg',
/** Sinhala */
si = 'si',
/** Slovak */
sk = 'sk',
/** Slovenian */
sl = 'sl',
/** Samoan */
sm = 'sm',
/** Shona */
sn = 'sn',
/** Somali */
so = 'so',
/** Albanian */
sq = 'sq',
/** Serbian */
sr = 'sr',
/** Southern Sotho */
st = 'st',
/** Sundanese */
su = 'su',
/** Swedish */
sv = 'sv',
/** Swahili */
sw = 'sw',
/** Congo Swahili */
sw_CD = 'sw_CD',
/** Tamil */
ta = 'ta',
/** Telugu */
te = 'te',
/** Tajik */
tg = 'tg',
/** Thai */
th = 'th',
/** Tigrinya */
ti = 'ti',
/** Turkmen */
tk = 'tk',
/** Tongan */
to = 'to',
/** Turkish */
tr = 'tr',
/** Tatar */
tt = 'tt',
/** Uyghur */
ug = 'ug',
/** Ukrainian */
uk = 'uk',
/** Urdu */
ur = 'ur',
/** Uzbek */
uz = 'uz',
/** Vietnamese */
vi = 'vi',
/** Volapük */
vo = 'vo',
/** Wolof */
wo = 'wo',
/** Xhosa */
xh = 'xh',
/** Yiddish */
yi = 'yi',
/** Yoruba */
yo = 'yo',
/** Chinese */
zh = 'zh',
/** Simplified Chinese */
zh_Hans = 'zh_Hans',
/** Traditional Chinese */
zh_Hant = 'zh_Hant',
/** Zulu */
zu = 'zu',
}
export type LocaleStringCustomFieldConfig = CustomField & {
__typename?: 'LocaleStringCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
length?: Maybe<Scalars['Int']['output']>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
pattern?: Maybe<Scalars['String']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type LocaleTextCustomFieldConfig = CustomField & {
__typename?: 'LocaleTextCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type LocalizedString = {
__typename?: 'LocalizedString';
languageCode: LanguageCode;
value: Scalars['String']['output'];
};
export enum LogicalOperator {
AND = 'AND',
OR = 'OR',
}
/** Returned when attempting to register or verify a customer account without a password, when one is required. */
export type MissingPasswordError = ErrorResult & {
__typename?: 'MissingPasswordError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Mutation = {
__typename?: 'Mutation';
/** Adds an item to the order. If custom fields are defined on the OrderLine entity, a third argument 'customFields' will be available. */
addItemToOrder: UpdateOrderItemsResult;
/** Add a Payment to the Order */
addPaymentToOrder: AddPaymentToOrderResult;
/** Adjusts an OrderLine. If custom fields are defined on the OrderLine entity, a third argument 'customFields' of type `OrderLineCustomFieldsInput` will be available. */
adjustOrderLine: UpdateOrderItemsResult;
/** Applies the given coupon code to the active Order */
applyCouponCode: ApplyCouponCodeResult;
/** Authenticates the user using a named authentication strategy */
authenticate: AuthenticationResult;
/** Create a new Customer Address */
createCustomerAddress: Address;
/** Delete an existing Address */
deleteCustomerAddress: Success;
/** Authenticates the user using the native authentication strategy. This mutation is an alias for `authenticate({ native: { ... }})` */
login: NativeAuthenticationResult;
/** End the current authenticated session */
logout: Success;
/** Regenerate and send a verification token for a new Customer registration. Only applicable if `authOptions.requireVerification` is set to true. */
refreshCustomerVerification: RefreshCustomerVerificationResult;
/**
* Register a Customer account with the given credentials. There are three possible registration flows:
*
* _If `authOptions.requireVerification` is set to `true`:_
*
* 1. **The Customer is registered _with_ a password**. A verificationToken will be created (and typically emailed to the Customer). That
* verificationToken would then be passed to the `verifyCustomerAccount` mutation _without_ a password. The Customer is then
* verified and authenticated in one step.
* 2. **The Customer is registered _without_ a password**. A verificationToken will be created (and typically emailed to the Customer). That
* verificationToken would then be passed to the `verifyCustomerAccount` mutation _with_ the chosen password of the Customer. The Customer is then
* verified and authenticated in one step.
*
* _If `authOptions.requireVerification` is set to `false`:_
*
* 3. The Customer _must_ be registered _with_ a password. No further action is needed - the Customer is able to authenticate immediately.
*/
registerCustomerAccount: RegisterCustomerAccountResult;
/** Remove all OrderLine from the Order */
removeAllOrderLines: RemoveOrderItemsResult;
/** Removes the given coupon code from the active Order */
removeCouponCode?: Maybe<Order>;
/** Remove an OrderLine from the Order */
removeOrderLine: RemoveOrderItemsResult;
/** Requests a password reset email to be sent */
requestPasswordReset?: Maybe<RequestPasswordResetResult>;
/**
* Request to update the emailAddress of the active Customer. If `authOptions.requireVerification` is enabled
* (as is the default), then the `identifierChangeToken` will be assigned to the current User and
* a IdentifierChangeRequestEvent will be raised. This can then be used e.g. by the EmailPlugin to email
* that verification token to the Customer, which is then used to verify the change of email address.
*/
requestUpdateCustomerEmailAddress: RequestUpdateCustomerEmailAddressResult;
/** Resets a Customer's password based on the provided token */
resetPassword: ResetPasswordResult;
/** Set the Customer for the Order. Required only if the Customer is not currently logged in */
setCustomerForOrder: SetCustomerForOrderResult;
/** Sets the billing address for this order */
setOrderBillingAddress: ActiveOrderResult;
/** Allows any custom fields to be set for the active order */
setOrderCustomFields: ActiveOrderResult;
/** Sets the shipping address for this order */
setOrderShippingAddress: ActiveOrderResult;
/**
* Sets the shipping method by id, which can be obtained with the `eligibleShippingMethods` query.
* An Order can have multiple shipping methods, in which case you can pass an array of ids. In this case,
* you should configure a custom ShippingLineAssignmentStrategy in order to know which OrderLines each
* shipping method will apply to.
*/
setOrderShippingMethod: SetOrderShippingMethodResult;
submitProductReview: ProductReview;
/** Transitions an Order to a new state. Valid next states can be found by querying `nextOrderStates` */
transitionOrderToState?: Maybe<TransitionOrderToStateResult>;
/** Update an existing Customer */
updateCustomer: Customer;
/** Update an existing Address */
updateCustomerAddress: Address;
/**
* Confirm the update of the emailAddress with the provided token, which has been generated by the
* `requestUpdateCustomerEmailAddress` mutation.
*/
updateCustomerEmailAddress: UpdateCustomerEmailAddressResult;
/** Update the password of the active Customer */
updateCustomerPassword: UpdateCustomerPasswordResult;
/**
* Verify a Customer email address with the token sent to that address. Only applicable if `authOptions.requireVerification` is set to true.
*
* If the Customer was not registered with a password in the `registerCustomerAccount` mutation, the password _must_ be
* provided here.
*/
verifyCustomerAccount: VerifyCustomerAccountResult;
voteOnReview: ProductReview;
};
export type MutationAddItemToOrderArgs = {
productVariantId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type MutationAddPaymentToOrderArgs = {
input: PaymentInput;
};
export type MutationAdjustOrderLineArgs = {
orderLineId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type MutationApplyCouponCodeArgs = {
couponCode: Scalars['String']['input'];
};
export type MutationAuthenticateArgs = {
input: AuthenticationInput;
rememberMe?: InputMaybe<Scalars['Boolean']['input']>;
};
export type MutationCreateCustomerAddressArgs = {
input: CreateAddressInput;
};
export type MutationDeleteCustomerAddressArgs = {
id: Scalars['ID']['input'];
};
export type MutationLoginArgs = {
password: Scalars['String']['input'];
rememberMe?: InputMaybe<Scalars['Boolean']['input']>;
username: Scalars['String']['input'];
};
export type MutationRefreshCustomerVerificationArgs = {
emailAddress: Scalars['String']['input'];
};
export type MutationRegisterCustomerAccountArgs = {
input: RegisterCustomerInput;
};
export type MutationRemoveCouponCodeArgs = {
couponCode: Scalars['String']['input'];
};
export type MutationRemoveOrderLineArgs = {
orderLineId: Scalars['ID']['input'];
};
export type MutationRequestPasswordResetArgs = {
emailAddress: Scalars['String']['input'];
};
export type MutationRequestUpdateCustomerEmailAddressArgs = {
newEmailAddress: Scalars['String']['input'];
password: Scalars['String']['input'];
};
export type MutationResetPasswordArgs = {
password: Scalars['String']['input'];
token: Scalars['String']['input'];
};
export type MutationSetCustomerForOrderArgs = {
input: CreateCustomerInput;
};
export type MutationSetOrderBillingAddressArgs = {
input: CreateAddressInput;
};
export type MutationSetOrderCustomFieldsArgs = {
input: UpdateOrderInput;
};
export type MutationSetOrderShippingAddressArgs = {
input: CreateAddressInput;
};
export type MutationSetOrderShippingMethodArgs = {
shippingMethodId: Array<Scalars['ID']['input']>;
};
export type MutationSubmitProductReviewArgs = {
input: SubmitProductReviewInput;
};
export type MutationTransitionOrderToStateArgs = {
state: Scalars['String']['input'];
};
export type MutationUpdateCustomerArgs = {
input: UpdateCustomerInput;
};
export type MutationUpdateCustomerAddressArgs = {
input: UpdateAddressInput;
};
export type MutationUpdateCustomerEmailAddressArgs = {
token: Scalars['String']['input'];
};
export type MutationUpdateCustomerPasswordArgs = {
currentPassword: Scalars['String']['input'];
newPassword: Scalars['String']['input'];
};
export type MutationVerifyCustomerAccountArgs = {
password?: InputMaybe<Scalars['String']['input']>;
token: Scalars['String']['input'];
};
export type MutationVoteOnReviewArgs = {
id: Scalars['ID']['input'];
vote: Scalars['Boolean']['input'];
};
export type NativeAuthInput = {
password: Scalars['String']['input'];
username: Scalars['String']['input'];
};
/** Returned when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured. */
export type NativeAuthStrategyError = ErrorResult & {
__typename?: 'NativeAuthStrategyError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type NativeAuthenticationResult =
| CurrentUser
| InvalidCredentialsError
| NativeAuthStrategyError
| NotVerifiedError;
/** Returned when attempting to set a negative OrderLine quantity. */
export type NegativeQuantityError = ErrorResult & {
__typename?: 'NegativeQuantityError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/**
* Returned when invoking a mutation which depends on there being an active Order on the
* current session.
*/
export type NoActiveOrderError = ErrorResult & {
__typename?: 'NoActiveOrderError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Node = {
id: Scalars['ID']['output'];
};
/**
* Returned if `authOptions.requireVerification` is set to `true` (which is the default)
* and an unverified user attempts to authenticate.
*/
export type NotVerifiedError = ErrorResult & {
__typename?: 'NotVerifiedError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Operators for filtering on a list of Number fields */
export type NumberListOperators = {
inList: Scalars['Float']['input'];
};
/** Operators for filtering on a Int or Float field */
export type NumberOperators = {
between?: InputMaybe<NumberRange>;
eq?: InputMaybe<Scalars['Float']['input']>;
gt?: InputMaybe<Scalars['Float']['input']>;
gte?: InputMaybe<Scalars['Float']['input']>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
lt?: InputMaybe<Scalars['Float']['input']>;
lte?: InputMaybe<Scalars['Float']['input']>;
};
export type NumberRange = {
end: Scalars['Float']['input'];
start: Scalars['Float']['input'];
};
export type Order = Node & {
__typename?: 'Order';
/** An order is active as long as the payment process has not been completed */
active: Scalars['Boolean']['output'];
billingAddress?: Maybe<OrderAddress>;
/** A unique code for the Order */
code: Scalars['String']['output'];
/** An array of all coupon codes applied to the Order */
couponCodes: Array<Scalars['String']['output']>;
createdAt: Scalars['DateTime']['output'];
currencyCode: CurrencyCode;
customFields?: Maybe<Scalars['JSON']['output']>;
customer?: Maybe<Customer>;
discounts: Array<Discount>;
fulfillments?: Maybe<Array<Fulfillment>>;
history: HistoryEntryList;
id: Scalars['ID']['output'];
lines: Array<OrderLine>;
/**
* The date & time that the Order was placed, i.e. the Customer
* completed the checkout and the Order is no longer "active"
*/
orderPlacedAt?: Maybe<Scalars['DateTime']['output']>;
payments?: Maybe<Array<Payment>>;
/** Promotions applied to the order. Only gets populated after the payment process has completed. */
promotions: Array<Promotion>;
shipping: Scalars['Money']['output'];
shippingAddress?: Maybe<OrderAddress>;
shippingLines: Array<ShippingLine>;
shippingWithTax: Scalars['Money']['output'];
state: Scalars['String']['output'];
/**
* The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
* discounts which have been prorated (proportionally distributed) amongst the items of each OrderLine.
* To get a total of all OrderLines which does not account for prorated discounts, use the
* sum of `OrderLine.discountedLinePrice` values.
*/
subTotal: Scalars['Money']['output'];
/** Same as subTotal, but inclusive of tax */
subTotalWithTax: Scalars['Money']['output'];
/**
* Surcharges are arbitrary modifications to the Order total which are neither
* ProductVariants nor discounts resulting from applied Promotions. For example,
* one-off discounts based on customer interaction, or surcharges based on payment
* methods.
*/
surcharges: Array<Surcharge>;
/** A summary of the taxes being applied to this Order */
taxSummary: Array<OrderTaxSummary>;
/** Equal to subTotal plus shipping */
total: Scalars['Money']['output'];
totalQuantity: Scalars['Int']['output'];
/** The final payable amount. Equal to subTotalWithTax plus shippingWithTax */
totalWithTax: Scalars['Money']['output'];
type: OrderType;
updatedAt: Scalars['DateTime']['output'];
};
export type OrderHistoryArgs = {
options?: InputMaybe<HistoryEntryListOptions>;
};
export type OrderAddress = {
__typename?: 'OrderAddress';
city?: Maybe<Scalars['String']['output']>;
company?: Maybe<Scalars['String']['output']>;
country?: Maybe<Scalars['String']['output']>;
countryCode?: Maybe<Scalars['String']['output']>;
customFields?: Maybe<Scalars['JSON']['output']>;
fullName?: Maybe<Scalars['String']['output']>;
phoneNumber?: Maybe<Scalars['String']['output']>;
postalCode?: Maybe<Scalars['String']['output']>;
province?: Maybe<Scalars['String']['output']>;
streetLine1?: Maybe<Scalars['String']['output']>;
streetLine2?: Maybe<Scalars['String']['output']>;
};
export type OrderFilterParameter = {
active?: InputMaybe<BooleanOperators>;
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
currencyCode?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
orderPlacedAt?: InputMaybe<DateOperators>;
shipping?: InputMaybe<NumberOperators>;
shippingWithTax?: InputMaybe<NumberOperators>;
state?: InputMaybe<StringOperators>;
subTotal?: InputMaybe<NumberOperators>;
subTotalWithTax?: InputMaybe<NumberOperators>;
total?: InputMaybe<NumberOperators>;
totalQuantity?: InputMaybe<NumberOperators>;
totalWithTax?: InputMaybe<NumberOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
/** Returned when the maximum order size limit has been reached. */
export type OrderLimitError = ErrorResult & {
__typename?: 'OrderLimitError';
errorCode: ErrorCode;
maxItems: Scalars['Int']['output'];
message: Scalars['String']['output'];
};
export type OrderLine = Node & {
__typename?: 'OrderLine';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
/** The price of the line including discounts, excluding tax */
discountedLinePrice: Scalars['Money']['output'];
/** The price of the line including discounts and tax */
discountedLinePriceWithTax: Scalars['Money']['output'];
/**
* The price of a single unit including discounts, excluding tax.
*
* If Order-level discounts have been applied, this will not be the
* actual taxable unit price (see `proratedUnitPrice`), but is generally the
* correct price to display to customers to avoid confusion
* about the internal handling of distributed Order-level discounts.
*/
discountedUnitPrice: Scalars['Money']['output'];
/** The price of a single unit including discounts and tax */
discountedUnitPriceWithTax: Scalars['Money']['output'];
discounts: Array<Discount>;
featuredAsset?: Maybe<Asset>;
fulfillmentLines?: Maybe<Array<FulfillmentLine>>;
id: Scalars['ID']['output'];
/** The total price of the line excluding tax and discounts. */
linePrice: Scalars['Money']['output'];
/** The total price of the line including tax but excluding discounts. */
linePriceWithTax: Scalars['Money']['output'];
/** The total tax on this line */
lineTax: Scalars['Money']['output'];
order: Order;
/** The quantity at the time the Order was placed */
orderPlacedQuantity: Scalars['Int']['output'];
productVariant: ProductVariant;
/**
* The actual line price, taking into account both item discounts _and_ prorated (proportionally-distributed)
* Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax
* and refund calculations.
*/
proratedLinePrice: Scalars['Money']['output'];
/** The proratedLinePrice including tax */
proratedLinePriceWithTax: Scalars['Money']['output'];
/**
* The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed)
* Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax
* and refund calculations.
*/
proratedUnitPrice: Scalars['Money']['output'];
/** The proratedUnitPrice including tax */
proratedUnitPriceWithTax: Scalars['Money']['output'];
quantity: Scalars['Int']['output'];
taxLines: Array<TaxLine>;
taxRate: Scalars['Float']['output'];
/** The price of a single unit, excluding tax and discounts */
unitPrice: Scalars['Money']['output'];
/** Non-zero if the unitPrice has changed since it was initially added to Order */
unitPriceChangeSinceAdded: Scalars['Money']['output'];
/** The price of a single unit, including tax but excluding discounts */
unitPriceWithTax: Scalars['Money']['output'];
/** Non-zero if the unitPriceWithTax has changed since it was initially added to Order */
unitPriceWithTaxChangeSinceAdded: Scalars['Money']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type OrderList = PaginatedList & {
__typename?: 'OrderList';
items: Array<Order>;
totalItems: Scalars['Int']['output'];
};
export type OrderListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<OrderFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<OrderSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
/** Returned when attempting to modify the contents of an Order that is not in the `AddingItems` state. */
export type OrderModificationError = ErrorResult & {
__typename?: 'OrderModificationError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when attempting to add a Payment to an Order that is not in the `ArrangingPayment` state. */
export type OrderPaymentStateError = ErrorResult & {
__typename?: 'OrderPaymentStateError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type OrderSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
orderPlacedAt?: InputMaybe<SortOrder>;
shipping?: InputMaybe<SortOrder>;
shippingWithTax?: InputMaybe<SortOrder>;
state?: InputMaybe<SortOrder>;
subTotal?: InputMaybe<SortOrder>;
subTotalWithTax?: InputMaybe<SortOrder>;
total?: InputMaybe<SortOrder>;
totalQuantity?: InputMaybe<SortOrder>;
totalWithTax?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
/** Returned if there is an error in transitioning the Order state */
export type OrderStateTransitionError = ErrorResult & {
__typename?: 'OrderStateTransitionError';
errorCode: ErrorCode;
fromState: Scalars['String']['output'];
message: Scalars['String']['output'];
toState: Scalars['String']['output'];
transitionError: Scalars['String']['output'];
};
/**
* A summary of the taxes being applied to this order, grouped
* by taxRate.
*/
export type OrderTaxSummary = {
__typename?: 'OrderTaxSummary';
/** A description of this tax */
description: Scalars['String']['output'];
/** The total net price of OrderLines to which this taxRate applies */
taxBase: Scalars['Money']['output'];
/** The taxRate as a percentage */
taxRate: Scalars['Float']['output'];
/** The total tax being applied to the Order at this taxRate */
taxTotal: Scalars['Money']['output'];
};
export enum OrderType {
Aggregate = 'Aggregate',
Regular = 'Regular',
Seller = 'Seller',
}
export type PaginatedList = {
items: Array<Node>;
totalItems: Scalars['Int']['output'];
};
/** Returned when attempting to verify a customer account with a password, when a password has already been set. */
export type PasswordAlreadySetError = ErrorResult & {
__typename?: 'PasswordAlreadySetError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/**
* Returned if the token used to reset a Customer's password is valid, but has
* expired according to the `verificationTokenDuration` setting in the AuthOptions.
*/
export type PasswordResetTokenExpiredError = ErrorResult & {
__typename?: 'PasswordResetTokenExpiredError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/**
* Returned if the token used to reset a Customer's password is either
* invalid or does not match any expected tokens.
*/
export type PasswordResetTokenInvalidError = ErrorResult & {
__typename?: 'PasswordResetTokenInvalidError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when attempting to register or verify a customer account where the given password fails password validation. */
export type PasswordValidationError = ErrorResult & {
__typename?: 'PasswordValidationError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
validationErrorMessage: Scalars['String']['output'];
};
export type Payment = Node & {
__typename?: 'Payment';
amount: Scalars['Money']['output'];
createdAt: Scalars['DateTime']['output'];
errorMessage?: Maybe<Scalars['String']['output']>;
id: Scalars['ID']['output'];
metadata?: Maybe<Scalars['JSON']['output']>;
method: Scalars['String']['output'];
refunds: Array<Refund>;
state: Scalars['String']['output'];
transactionId?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
/** Returned when a Payment is declined by the payment provider. */
export type PaymentDeclinedError = ErrorResult & {
__typename?: 'PaymentDeclinedError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
paymentErrorMessage: Scalars['String']['output'];
};
/** Returned when a Payment fails due to an error. */
export type PaymentFailedError = ErrorResult & {
__typename?: 'PaymentFailedError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
paymentErrorMessage: Scalars['String']['output'];
};
/** Passed as input to the `addPaymentToOrder` mutation. */
export type PaymentInput = {
/**
* This field should contain arbitrary data passed to the specified PaymentMethodHandler's `createPayment()` method
* as the "metadata" argument. For example, it could contain an ID for the payment and other
* data generated by the payment provider.
*/
metadata: Scalars['JSON']['input'];
/** This field should correspond to the `code` property of a PaymentMethod. */
method: Scalars['String']['input'];
};
export type PaymentMethod = Node & {
__typename?: 'PaymentMethod';
checker?: Maybe<ConfigurableOperation>;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
enabled: Scalars['Boolean']['output'];
handler: ConfigurableOperation;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
translations: Array<PaymentMethodTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type PaymentMethodQuote = {
__typename?: 'PaymentMethodQuote';
code: Scalars['String']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
eligibilityMessage?: Maybe<Scalars['String']['output']>;
id: Scalars['ID']['output'];
isEligible: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
};
export type PaymentMethodTranslation = {
__typename?: 'PaymentMethodTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
/**
* @description
* Permissions for administrators and customers. Used to control access to
* GraphQL resolvers via the {@link Allow} decorator.
*
* ## Understanding Permission.Owner
*
* `Permission.Owner` is a special permission which is used in some Vendure resolvers to indicate that that resolver should only
* be accessible to the "owner" of that resource.
*
* For example, the Shop API `activeCustomer` query resolver should only return the Customer object for the "owner" of that Customer, i.e.
* based on the activeUserId of the current session. As a result, the resolver code looks like this:
*
* @example
* ```ts
* \@Query()
* \@Allow(Permission.Owner)
* async activeCustomer(\@Ctx() ctx: RequestContext): Promise<Customer | undefined> {
* const userId = ctx.activeUserId;
* if (userId) {
* return this.customerService.findOneByUserId(ctx, userId);
* }
* }
* ```
*
* Here we can see that the "ownership" must be enforced by custom logic inside the resolver. Since "ownership" cannot be defined generally
* nor statically encoded at build-time, any resolvers using `Permission.Owner` **must** include logic to enforce that only the owner
* of the resource has access. If not, then it is the equivalent of using `Permission.Public`.
*
*
* @docsCategory common
*/
export enum Permission {
/** Authenticated means simply that the user is logged in */
Authenticated = 'Authenticated',
/** Grants permission to create Administrator */
CreateAdministrator = 'CreateAdministrator',
/** Grants permission to create Asset */
CreateAsset = 'CreateAsset',
/** Grants permission to create Products, Facets, Assets, Collections */
CreateCatalog = 'CreateCatalog',
/** Grants permission to create Channel */
CreateChannel = 'CreateChannel',
/** Grants permission to create Collection */
CreateCollection = 'CreateCollection',
/** Grants permission to create Country */
CreateCountry = 'CreateCountry',
/** Grants permission to create Customer */
CreateCustomer = 'CreateCustomer',
/** Grants permission to create CustomerGroup */
CreateCustomerGroup = 'CreateCustomerGroup',
/** Grants permission to create Facet */
CreateFacet = 'CreateFacet',
/** Grants permission to create Order */
CreateOrder = 'CreateOrder',
/** Grants permission to create PaymentMethod */
CreatePaymentMethod = 'CreatePaymentMethod',
/** Grants permission to create Product */
CreateProduct = 'CreateProduct',
/** Grants permission to create Promotion */
CreatePromotion = 'CreatePromotion',
/** Grants permission to create Seller */
CreateSeller = 'CreateSeller',
/** Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
CreateSettings = 'CreateSettings',
/** Grants permission to create ShippingMethod */
CreateShippingMethod = 'CreateShippingMethod',
/** Grants permission to create StockLocation */
CreateStockLocation = 'CreateStockLocation',
/** Grants permission to create System */
CreateSystem = 'CreateSystem',
/** Grants permission to create Tag */
CreateTag = 'CreateTag',
/** Grants permission to create TaxCategory */
CreateTaxCategory = 'CreateTaxCategory',
/** Grants permission to create TaxRate */
CreateTaxRate = 'CreateTaxRate',
/** Grants permission to create Zone */
CreateZone = 'CreateZone',
/** Grants permission to delete Administrator */
DeleteAdministrator = 'DeleteAdministrator',
/** Grants permission to delete Asset */
DeleteAsset = 'DeleteAsset',
/** Grants permission to delete Products, Facets, Assets, Collections */
DeleteCatalog = 'DeleteCatalog',
/** Grants permission to delete Channel */
DeleteChannel = 'DeleteChannel',
/** Grants permission to delete Collection */
DeleteCollection = 'DeleteCollection',
/** Grants permission to delete Country */
DeleteCountry = 'DeleteCountry',
/** Grants permission to delete Customer */
DeleteCustomer = 'DeleteCustomer',
/** Grants permission to delete CustomerGroup */
DeleteCustomerGroup = 'DeleteCustomerGroup',
/** Grants permission to delete Facet */
DeleteFacet = 'DeleteFacet',
/** Grants permission to delete Order */
DeleteOrder = 'DeleteOrder',
/** Grants permission to delete PaymentMethod */
DeletePaymentMethod = 'DeletePaymentMethod',
/** Grants permission to delete Product */
DeleteProduct = 'DeleteProduct',
/** Grants permission to delete Promotion */
DeletePromotion = 'DeletePromotion',
/** Grants permission to delete Seller */
DeleteSeller = 'DeleteSeller',
/** Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
DeleteSettings = 'DeleteSettings',
/** Grants permission to delete ShippingMethod */
DeleteShippingMethod = 'DeleteShippingMethod',
/** Grants permission to delete StockLocation */
DeleteStockLocation = 'DeleteStockLocation',
/** Grants permission to delete System */
DeleteSystem = 'DeleteSystem',
/** Grants permission to delete Tag */
DeleteTag = 'DeleteTag',
/** Grants permission to delete TaxCategory */
DeleteTaxCategory = 'DeleteTaxCategory',
/** Grants permission to delete TaxRate */
DeleteTaxRate = 'DeleteTaxRate',
/** Grants permission to delete Zone */
DeleteZone = 'DeleteZone',
/** Owner means the user owns this entity, e.g. a Customer's own Order */
Owner = 'Owner',
/** Public means any unauthenticated user may perform the operation */
Public = 'Public',
/** Grants permission to read Administrator */
ReadAdministrator = 'ReadAdministrator',
/** Grants permission to read Asset */
ReadAsset = 'ReadAsset',
/** Grants permission to read Products, Facets, Assets, Collections */
ReadCatalog = 'ReadCatalog',
/** Grants permission to read Channel */
ReadChannel = 'ReadChannel',
/** Grants permission to read Collection */
ReadCollection = 'ReadCollection',
/** Grants permission to read Country */
ReadCountry = 'ReadCountry',
/** Grants permission to read Customer */
ReadCustomer = 'ReadCustomer',
/** Grants permission to read CustomerGroup */
ReadCustomerGroup = 'ReadCustomerGroup',
/** Grants permission to read Facet */
ReadFacet = 'ReadFacet',
/** Grants permission to read Order */
ReadOrder = 'ReadOrder',
/** Grants permission to read PaymentMethod */
ReadPaymentMethod = 'ReadPaymentMethod',
/** Grants permission to read Product */
ReadProduct = 'ReadProduct',
/** Grants permission to read Promotion */
ReadPromotion = 'ReadPromotion',
/** Grants permission to read Seller */
ReadSeller = 'ReadSeller',
/** Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
ReadSettings = 'ReadSettings',
/** Grants permission to read ShippingMethod */
ReadShippingMethod = 'ReadShippingMethod',
/** Grants permission to read StockLocation */
ReadStockLocation = 'ReadStockLocation',
/** Grants permission to read System */
ReadSystem = 'ReadSystem',
/** Grants permission to read Tag */
ReadTag = 'ReadTag',
/** Grants permission to read TaxCategory */
ReadTaxCategory = 'ReadTaxCategory',
/** Grants permission to read TaxRate */
ReadTaxRate = 'ReadTaxRate',
/** Grants permission to read Zone */
ReadZone = 'ReadZone',
/** SuperAdmin has unrestricted access to all operations */
SuperAdmin = 'SuperAdmin',
/** Grants permission to update Administrator */
UpdateAdministrator = 'UpdateAdministrator',
/** Grants permission to update Asset */
UpdateAsset = 'UpdateAsset',
/** Grants permission to update Products, Facets, Assets, Collections */
UpdateCatalog = 'UpdateCatalog',
/** Grants permission to update Channel */
UpdateChannel = 'UpdateChannel',
/** Grants permission to update Collection */
UpdateCollection = 'UpdateCollection',
/** Grants permission to update Country */
UpdateCountry = 'UpdateCountry',
/** Grants permission to update Customer */
UpdateCustomer = 'UpdateCustomer',
/** Grants permission to update CustomerGroup */
UpdateCustomerGroup = 'UpdateCustomerGroup',
/** Grants permission to update Facet */
UpdateFacet = 'UpdateFacet',
/** Grants permission to update GlobalSettings */
UpdateGlobalSettings = 'UpdateGlobalSettings',
/** Grants permission to update Order */
UpdateOrder = 'UpdateOrder',
/** Grants permission to update PaymentMethod */
UpdatePaymentMethod = 'UpdatePaymentMethod',
/** Grants permission to update Product */
UpdateProduct = 'UpdateProduct',
/** Grants permission to update Promotion */
UpdatePromotion = 'UpdatePromotion',
/** Grants permission to update Seller */
UpdateSeller = 'UpdateSeller',
/** Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
UpdateSettings = 'UpdateSettings',
/** Grants permission to update ShippingMethod */
UpdateShippingMethod = 'UpdateShippingMethod',
/** Grants permission to update StockLocation */
UpdateStockLocation = 'UpdateStockLocation',
/** Grants permission to update System */
UpdateSystem = 'UpdateSystem',
/** Grants permission to update Tag */
UpdateTag = 'UpdateTag',
/** Grants permission to update TaxCategory */
UpdateTaxCategory = 'UpdateTaxCategory',
/** Grants permission to update TaxRate */
UpdateTaxRate = 'UpdateTaxRate',
/** Grants permission to update Zone */
UpdateZone = 'UpdateZone',
}
/** The price range where the result has more than one price */
export type PriceRange = {
__typename?: 'PriceRange';
max: Scalars['Money']['output'];
min: Scalars['Money']['output'];
};
export type Product = Node & {
__typename?: 'Product';
assets: Array<Asset>;
collections: Array<Collection>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<ProductCustomFields>;
description: Scalars['String']['output'];
facetValues: Array<FacetValue>;
featuredAsset?: Maybe<Asset>;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
optionGroups: Array<ProductOptionGroup>;
reviews: ProductReviewList;
reviewsHistogram: Array<ProductReviewHistogramItem>;
slug: Scalars['String']['output'];
translations: Array<ProductTranslation>;
updatedAt: Scalars['DateTime']['output'];
/** Returns a paginated, sortable, filterable list of ProductVariants */
variantList: ProductVariantList;
/** Returns all ProductVariants */
variants: Array<ProductVariant>;
};
export type ProductReviewsArgs = {
options?: InputMaybe<ProductReviewListOptions>;
};
export type ProductVariantListArgs = {
options?: InputMaybe<ProductVariantListOptions>;
};
export type ProductCustomFields = {
__typename?: 'ProductCustomFields';
featuredReview?: Maybe<ProductReview>;
reviewCount?: Maybe<Scalars['Float']['output']>;
reviewRating?: Maybe<Scalars['Float']['output']>;
};
export type ProductFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
reviewCount?: InputMaybe<NumberOperators>;
reviewRating?: InputMaybe<NumberOperators>;
slug?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ProductList = PaginatedList & {
__typename?: 'ProductList';
items: Array<Product>;
totalItems: Scalars['Int']['output'];
};
export type ProductListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ProductFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ProductSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ProductOption = Node & {
__typename?: 'ProductOption';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
group: ProductOptionGroup;
groupId: Scalars['ID']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<ProductOptionTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type ProductOptionGroup = Node & {
__typename?: 'ProductOptionGroup';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
options: Array<ProductOption>;
translations: Array<ProductOptionGroupTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type ProductOptionGroupTranslation = {
__typename?: 'ProductOptionGroupTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProductOptionTranslation = {
__typename?: 'ProductOptionTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProductReview = Node & {
__typename?: 'ProductReview';
authorLocation?: Maybe<Scalars['String']['output']>;
authorName: Scalars['String']['output'];
body?: Maybe<Scalars['String']['output']>;
createdAt: Scalars['DateTime']['output'];
downvotes: Scalars['Int']['output'];
id: Scalars['ID']['output'];
product: Product;
productVariant?: Maybe<ProductVariant>;
rating: Scalars['Float']['output'];
response?: Maybe<Scalars['String']['output']>;
responseCreatedAt?: Maybe<Scalars['DateTime']['output']>;
state: Scalars['String']['output'];
summary: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
upvotes: Scalars['Int']['output'];
};
export type ProductReviewFilterParameter = {
authorLocation?: InputMaybe<StringOperators>;
authorName?: InputMaybe<StringOperators>;
body?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
downvotes?: InputMaybe<NumberOperators>;
id?: InputMaybe<IdOperators>;
rating?: InputMaybe<NumberOperators>;
response?: InputMaybe<StringOperators>;
responseCreatedAt?: InputMaybe<DateOperators>;
state?: InputMaybe<StringOperators>;
summary?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
upvotes?: InputMaybe<NumberOperators>;
};
export type ProductReviewHistogramItem = {
__typename?: 'ProductReviewHistogramItem';
bin: Scalars['Int']['output'];
frequency: Scalars['Int']['output'];
};
export type ProductReviewList = PaginatedList & {
__typename?: 'ProductReviewList';
items: Array<ProductReview>;
totalItems: Scalars['Int']['output'];
};
export type ProductReviewListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ProductReviewFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ProductReviewSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ProductReviewSortParameter = {
authorLocation?: InputMaybe<SortOrder>;
authorName?: InputMaybe<SortOrder>;
body?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
downvotes?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
rating?: InputMaybe<SortOrder>;
response?: InputMaybe<SortOrder>;
responseCreatedAt?: InputMaybe<SortOrder>;
state?: InputMaybe<SortOrder>;
summary?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
upvotes?: InputMaybe<SortOrder>;
};
export type ProductSortParameter = {
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
featuredReview?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
reviewCount?: InputMaybe<SortOrder>;
reviewRating?: InputMaybe<SortOrder>;
slug?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ProductTranslation = {
__typename?: 'ProductTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
slug: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProductVariant = Node & {
__typename?: 'ProductVariant';
assets: Array<Asset>;
createdAt: Scalars['DateTime']['output'];
currencyCode: CurrencyCode;
customFields?: Maybe<Scalars['JSON']['output']>;
facetValues: Array<FacetValue>;
featuredAsset?: Maybe<Asset>;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
options: Array<ProductOption>;
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
product: Product;
productId: Scalars['ID']['output'];
sku: Scalars['String']['output'];
stockLevel: Scalars['String']['output'];
taxCategory: TaxCategory;
taxRateApplied: TaxRate;
translations: Array<ProductVariantTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type ProductVariantFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
currencyCode?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
price?: InputMaybe<NumberOperators>;
priceWithTax?: InputMaybe<NumberOperators>;
productId?: InputMaybe<IdOperators>;
sku?: InputMaybe<StringOperators>;
stockLevel?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ProductVariantList = PaginatedList & {
__typename?: 'ProductVariantList';
items: Array<ProductVariant>;
totalItems: Scalars['Int']['output'];
};
export type ProductVariantListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ProductVariantFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ProductVariantSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ProductVariantSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
price?: InputMaybe<SortOrder>;
priceWithTax?: InputMaybe<SortOrder>;
productId?: InputMaybe<SortOrder>;
sku?: InputMaybe<SortOrder>;
stockLevel?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ProductVariantTranslation = {
__typename?: 'ProductVariantTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type Promotion = Node & {
__typename?: 'Promotion';
actions: Array<ConfigurableOperation>;
conditions: Array<ConfigurableOperation>;
couponCode?: Maybe<Scalars['String']['output']>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
enabled: Scalars['Boolean']['output'];
endsAt?: Maybe<Scalars['DateTime']['output']>;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
perCustomerUsageLimit?: Maybe<Scalars['Int']['output']>;
startsAt?: Maybe<Scalars['DateTime']['output']>;
translations: Array<PromotionTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type PromotionList = PaginatedList & {
__typename?: 'PromotionList';
items: Array<Promotion>;
totalItems: Scalars['Int']['output'];
};
export type PromotionTranslation = {
__typename?: 'PromotionTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type Province = Node &
Region & {
__typename?: 'Province';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
parent?: Maybe<Region>;
parentId?: Maybe<Scalars['ID']['output']>;
translations: Array<RegionTranslation>;
type: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProvinceList = PaginatedList & {
__typename?: 'ProvinceList';
items: Array<Province>;
totalItems: Scalars['Int']['output'];
};
export type Query = {
__typename?: 'Query';
/** The active Channel */
activeChannel: Channel;
/** The active Customer */
activeCustomer?: Maybe<Customer>;
/**
* The active Order. Will be `null` until an Order is created via `addItemToOrder`. Once an Order reaches the
* state of `PaymentAuthorized` or `PaymentSettled`, then that Order is no longer considered "active" and this
* query will once again return `null`.
*/
activeOrder?: Maybe<Order>;
/** An array of supported Countries */
availableCountries: Array<Country>;
/** Returns a Collection either by its id or slug. If neither 'id' nor 'slug' is specified, an error will result. */
collection?: Maybe<Collection>;
/** A list of Collections available to the shop */
collections: CollectionList;
/** Returns a list of payment methods and their eligibility based on the current active Order */
eligiblePaymentMethods: Array<PaymentMethodQuote>;
/** Returns a list of eligible shipping methods based on the current active Order */
eligibleShippingMethods: Array<ShippingMethodQuote>;
/** Returns a Facet by its id */
facet?: Maybe<Facet>;
/** A list of Facets available to the shop */
facets: FacetList;
/** Returns information about the current authenticated User */
me?: Maybe<CurrentUser>;
/** Returns the possible next states that the activeOrder can transition to */
nextOrderStates: Array<Scalars['String']['output']>;
/**
* Returns an Order based on the id. Note that in the Shop API, only orders belonging to the
* currently-authenticated User may be queried.
*/
order?: Maybe<Order>;
/**
* Returns an Order based on the order `code`. For guest Orders (i.e. Orders placed by non-authenticated Customers)
* this query will only return the Order within 2 hours of the Order being placed. This allows an Order confirmation
* screen to be shown immediately after completion of a guest checkout, yet prevents security risks of allowing
* general anonymous access to Order data.
*/
orderByCode?: Maybe<Order>;
/** Get a Product either by id or slug. If neither 'id' nor 'slug' is specified, an error will result. */
product?: Maybe<Product>;
/** Get a list of Products */
products: ProductList;
/** Search Products based on the criteria set by the `SearchInput` */
search: SearchResponse;
};
export type QueryCollectionArgs = {
id?: InputMaybe<Scalars['ID']['input']>;
slug?: InputMaybe<Scalars['String']['input']>;
};
export type QueryCollectionsArgs = {
options?: InputMaybe<CollectionListOptions>;
};
export type QueryFacetArgs = {
id: Scalars['ID']['input'];
};
export type QueryFacetsArgs = {
options?: InputMaybe<FacetListOptions>;
};
export type QueryOrderArgs = {
id: Scalars['ID']['input'];
};
export type QueryOrderByCodeArgs = {
code: Scalars['String']['input'];
};
export type QueryProductArgs = {
id?: InputMaybe<Scalars['ID']['input']>;
slug?: InputMaybe<Scalars['String']['input']>;
};
export type QueryProductsArgs = {
options?: InputMaybe<ProductListOptions>;
};
export type QuerySearchArgs = {
input: SearchInput;
};
export type RefreshCustomerVerificationResult = NativeAuthStrategyError | Success;
export type Refund = Node & {
__typename?: 'Refund';
adjustment: Scalars['Money']['output'];
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
items: Scalars['Money']['output'];
lines: Array<RefundLine>;
metadata?: Maybe<Scalars['JSON']['output']>;
method?: Maybe<Scalars['String']['output']>;
paymentId: Scalars['ID']['output'];
reason?: Maybe<Scalars['String']['output']>;
shipping: Scalars['Money']['output'];
state: Scalars['String']['output'];
total: Scalars['Money']['output'];
transactionId?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type RefundLine = {
__typename?: 'RefundLine';
orderLine: OrderLine;
orderLineId: Scalars['ID']['output'];
quantity: Scalars['Int']['output'];
refund: Refund;
refundId: Scalars['ID']['output'];
};
export type Region = {
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
parent?: Maybe<Region>;
parentId?: Maybe<Scalars['ID']['output']>;
translations: Array<RegionTranslation>;
type: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type RegionTranslation = {
__typename?: 'RegionTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type RegisterCustomerAccountResult =
| MissingPasswordError
| NativeAuthStrategyError
| PasswordValidationError
| Success;
export type RegisterCustomerInput = {
emailAddress: Scalars['String']['input'];
firstName?: InputMaybe<Scalars['String']['input']>;
lastName?: InputMaybe<Scalars['String']['input']>;
password?: InputMaybe<Scalars['String']['input']>;
phoneNumber?: InputMaybe<Scalars['String']['input']>;
title?: InputMaybe<Scalars['String']['input']>;
};
export type RelationCustomFieldConfig = CustomField & {
__typename?: 'RelationCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
entity: Scalars['String']['output'];
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
scalarFields: Array<Scalars['String']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type RemoveOrderItemsResult = Order | OrderModificationError;
export type RequestPasswordResetResult = NativeAuthStrategyError | Success;
export type RequestUpdateCustomerEmailAddressResult =
| EmailAddressConflictError
| InvalidCredentialsError
| NativeAuthStrategyError
| Success;
export type ResetPasswordResult =
| CurrentUser
| NativeAuthStrategyError
| NotVerifiedError
| PasswordResetTokenExpiredError
| PasswordResetTokenInvalidError
| PasswordValidationError;
export type Role = Node & {
__typename?: 'Role';
channels: Array<Channel>;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
permissions: Array<Permission>;
updatedAt: Scalars['DateTime']['output'];
};
export type RoleList = PaginatedList & {
__typename?: 'RoleList';
items: Array<Role>;
totalItems: Scalars['Int']['output'];
};
export type SearchInput = {
collectionId?: InputMaybe<Scalars['ID']['input']>;
collectionSlug?: InputMaybe<Scalars['String']['input']>;
facetValueFilters?: InputMaybe<Array<FacetValueFilterInput>>;
groupByProduct?: InputMaybe<Scalars['Boolean']['input']>;
skip?: InputMaybe<Scalars['Int']['input']>;
sort?: InputMaybe<SearchResultSortParameter>;
take?: InputMaybe<Scalars['Int']['input']>;
term?: InputMaybe<Scalars['String']['input']>;
};
export type SearchReindexResponse = {
__typename?: 'SearchReindexResponse';
success: Scalars['Boolean']['output'];
};
export type SearchResponse = {
__typename?: 'SearchResponse';
collections: Array<CollectionResult>;
facetValues: Array<FacetValueResult>;
items: Array<SearchResult>;
totalItems: Scalars['Int']['output'];
};
export type SearchResult = {
__typename?: 'SearchResult';
/** An array of ids of the Collections in which this result appears */
collectionIds: Array<Scalars['ID']['output']>;
currencyCode: CurrencyCode;
description: Scalars['String']['output'];
facetIds: Array<Scalars['ID']['output']>;
facetValueIds: Array<Scalars['ID']['output']>;
price: SearchResultPrice;
priceWithTax: SearchResultPrice;
productAsset?: Maybe<SearchResultAsset>;
productId: Scalars['ID']['output'];
productName: Scalars['String']['output'];
productVariantAsset?: Maybe<SearchResultAsset>;
productVariantId: Scalars['ID']['output'];
productVariantName: Scalars['String']['output'];
/** A relevance score for the result. Differs between database implementations */
score: Scalars['Float']['output'];
sku: Scalars['String']['output'];
slug: Scalars['String']['output'];
};
export type SearchResultAsset = {
__typename?: 'SearchResultAsset';
focalPoint?: Maybe<Coordinate>;
id: Scalars['ID']['output'];
preview: Scalars['String']['output'];
};
/** The price of a search result product, either as a range or as a single price */
export type SearchResultPrice = PriceRange | SinglePrice;
export type SearchResultSortParameter = {
name?: InputMaybe<SortOrder>;
price?: InputMaybe<SortOrder>;
};
export type Seller = Node & {
__typename?: 'Seller';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type SetCustomerForOrderResult =
| AlreadyLoggedInError
| EmailAddressConflictError
| GuestCheckoutError
| NoActiveOrderError
| Order;
export type SetOrderShippingMethodResult =
| IneligibleShippingMethodError
| NoActiveOrderError
| Order
| OrderModificationError;
export type ShippingLine = {
__typename?: 'ShippingLine';
discountedPrice: Scalars['Money']['output'];
discountedPriceWithTax: Scalars['Money']['output'];
discounts: Array<Discount>;
id: Scalars['ID']['output'];
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
shippingMethod: ShippingMethod;
};
export type ShippingMethod = Node & {
__typename?: 'ShippingMethod';
calculator: ConfigurableOperation;
checker: ConfigurableOperation;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
fulfillmentHandlerCode: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<ShippingMethodTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type ShippingMethodList = PaginatedList & {
__typename?: 'ShippingMethodList';
items: Array<ShippingMethod>;
totalItems: Scalars['Int']['output'];
};
export type ShippingMethodQuote = {
__typename?: 'ShippingMethodQuote';
code: Scalars['String']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
/** Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult */
metadata?: Maybe<Scalars['JSON']['output']>;
name: Scalars['String']['output'];
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
};
export type ShippingMethodTranslation = {
__typename?: 'ShippingMethodTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
/** The price value where the result has a single price */
export type SinglePrice = {
__typename?: 'SinglePrice';
value: Scalars['Money']['output'];
};
export enum SortOrder {
ASC = 'ASC',
DESC = 'DESC',
}
export type StringCustomFieldConfig = CustomField & {
__typename?: 'StringCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
length?: Maybe<Scalars['Int']['output']>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
options?: Maybe<Array<StringFieldOption>>;
pattern?: Maybe<Scalars['String']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type StringFieldOption = {
__typename?: 'StringFieldOption';
label?: Maybe<Array<LocalizedString>>;
value: Scalars['String']['output'];
};
/** Operators for filtering on a list of String fields */
export type StringListOperators = {
inList: Scalars['String']['input'];
};
/** Operators for filtering on a String field */
export type StringOperators = {
contains?: InputMaybe<Scalars['String']['input']>;
eq?: InputMaybe<Scalars['String']['input']>;
in?: InputMaybe<Array<Scalars['String']['input']>>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
notContains?: InputMaybe<Scalars['String']['input']>;
notEq?: InputMaybe<Scalars['String']['input']>;
notIn?: InputMaybe<Array<Scalars['String']['input']>>;
regex?: InputMaybe<Scalars['String']['input']>;
};
export type SubmitProductReviewInput = {
authorLocation?: InputMaybe<Scalars['String']['input']>;
authorName: Scalars['String']['input'];
body: Scalars['String']['input'];
customerId?: InputMaybe<Scalars['ID']['input']>;
productId: Scalars['ID']['input'];
rating: Scalars['Float']['input'];
summary: Scalars['String']['input'];
variantId?: InputMaybe<Scalars['ID']['input']>;
};
/** Indicates that an operation succeeded, where we do not want to return any more specific information. */
export type Success = {
__typename?: 'Success';
success: Scalars['Boolean']['output'];
};
export type Surcharge = Node & {
__typename?: 'Surcharge';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
sku?: Maybe<Scalars['String']['output']>;
taxLines: Array<TaxLine>;
taxRate: Scalars['Float']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type Tag = Node & {
__typename?: 'Tag';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
updatedAt: Scalars['DateTime']['output'];
value: Scalars['String']['output'];
};
export type TagList = PaginatedList & {
__typename?: 'TagList';
items: Array<Tag>;
totalItems: Scalars['Int']['output'];
};
export type TaxCategory = Node & {
__typename?: 'TaxCategory';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
isDefault: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type TaxLine = {
__typename?: 'TaxLine';
description: Scalars['String']['output'];
taxRate: Scalars['Float']['output'];
};
export type TaxRate = Node & {
__typename?: 'TaxRate';
category: TaxCategory;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
customerGroup?: Maybe<CustomerGroup>;
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
value: Scalars['Float']['output'];
zone: Zone;
};
export type TaxRateList = PaginatedList & {
__typename?: 'TaxRateList';
items: Array<TaxRate>;
totalItems: Scalars['Int']['output'];
};
export type TextCustomFieldConfig = CustomField & {
__typename?: 'TextCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type TransitionOrderToStateResult = Order | OrderStateTransitionError;
export type UpdateAddressInput = {
city?: InputMaybe<Scalars['String']['input']>;
company?: InputMaybe<Scalars['String']['input']>;
countryCode?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
defaultBillingAddress?: InputMaybe<Scalars['Boolean']['input']>;
defaultShippingAddress?: InputMaybe<Scalars['Boolean']['input']>;
fullName?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
phoneNumber?: InputMaybe<Scalars['String']['input']>;
postalCode?: InputMaybe<Scalars['String']['input']>;
province?: InputMaybe<Scalars['String']['input']>;
streetLine1?: InputMaybe<Scalars['String']['input']>;
streetLine2?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateCustomerEmailAddressResult =
| IdentifierChangeTokenExpiredError
| IdentifierChangeTokenInvalidError
| NativeAuthStrategyError
| Success;
export type UpdateCustomerInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
firstName?: InputMaybe<Scalars['String']['input']>;
lastName?: InputMaybe<Scalars['String']['input']>;
phoneNumber?: InputMaybe<Scalars['String']['input']>;
title?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateCustomerPasswordResult =
| InvalidCredentialsError
| NativeAuthStrategyError
| PasswordValidationError
| Success;
export type UpdateOrderInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
};
export type UpdateOrderItemsResult =
| InsufficientStockError
| NegativeQuantityError
| Order
| OrderLimitError
| OrderModificationError;
export type User = Node & {
__typename?: 'User';
authenticationMethods: Array<AuthenticationMethod>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
identifier: Scalars['String']['output'];
lastLogin?: Maybe<Scalars['DateTime']['output']>;
roles: Array<Role>;
updatedAt: Scalars['DateTime']['output'];
verified: Scalars['Boolean']['output'];
};
/**
* Returned if the verification token (used to verify a Customer's email address) is valid, but has
* expired according to the `verificationTokenDuration` setting in the AuthOptions.
*/
export type VerificationTokenExpiredError = ErrorResult & {
__typename?: 'VerificationTokenExpiredError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/**
* Returned if the verification token (used to verify a Customer's email address) is either
* invalid or does not match any expected tokens.
*/
export type VerificationTokenInvalidError = ErrorResult & {
__typename?: 'VerificationTokenInvalidError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type VerifyCustomerAccountResult =
| CurrentUser
| MissingPasswordError
| NativeAuthStrategyError
| PasswordAlreadySetError
| PasswordValidationError
| VerificationTokenExpiredError
| VerificationTokenInvalidError;
export type Zone = Node & {
__typename?: 'Zone';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
members: Array<Region>;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
|
import { LanguageCode, PluginCommonModule, VendurePlugin } from '@vendure/core';
import { ProductReview } from './entities/product-review.entity';
import { adminApiExtensions, shopApiExtensions } from './api/api-extensions';
import { ProductEntityResolver } from './api/product-entity.resolver';
import { ProductReviewAdminResolver } from './api/product-review-admin.resolver';
import { ProductReviewEntityResolver } from './api/product-review-entity.resolver';
import { ProductReviewShopResolver } from './api/product-review-shop.resolver';
import path from 'path';
import { AdminUiExtension } from '@vendure/ui-devkit/compiler';
@VendurePlugin({
imports: [PluginCommonModule],
entities: [ProductReview],
adminApiExtensions: {
schema: adminApiExtensions,
resolvers: [ProductEntityResolver, ProductReviewAdminResolver, ProductReviewEntityResolver],
},
shopApiExtensions: {
schema: shopApiExtensions,
resolvers: [ProductEntityResolver, ProductReviewShopResolver, ProductReviewEntityResolver],
},
configuration: config => {
config.customFields.Product.push({
name: 'reviewRating',
label: [{ languageCode: LanguageCode.en, value: 'Review rating' }],
public: true,
nullable: true,
type: 'float',
ui: { tab: 'Reviews', component: 'star-rating-form-input' },
});
config.customFields.Product.push({
name: 'reviewCount',
label: [{ languageCode: LanguageCode.en, value: 'Review count' }],
public: true,
defaultValue: 0,
type: 'float',
ui: { tab: 'Reviews', component: 'review-count-link' },
});
config.customFields.Product.push({
name: 'featuredReview',
label: [{ languageCode: LanguageCode.en, value: 'Featured review' }],
public: true,
type: 'relation',
entity: ProductReview,
ui: { tab: 'Reviews', component: 'review-selector-form-input' },
inverseSide: undefined,
});
return config;
},
})
export class ReviewsPlugin {
static uiExtensions: AdminUiExtension = {
extensionPath: path.join(__dirname, 'ui'),
routes: [{ route: 'product-reviews', filePath: 'routes.ts' }],
providers: ['providers.ts'],
};
}
|
import { ProductReview } from './entities/product-review.entity';
export type ReviewState = 'new' | 'approved' | 'rejected';
declare module '@vendure/core' {
interface CustomProductFields {
reviewCount: number;
reviewRating: number;
featuredReview?: ProductReview;
}
}
|
import { gql } from 'graphql-tag';
export const commonApiExtensions = gql`
type ProductReview implements Node {
id: ID!
createdAt: DateTime!
updatedAt: DateTime!
product: Product!
productVariant: ProductVariant
summary: String!
body: String
rating: Float!
authorName: String!
authorLocation: String
upvotes: Int!
downvotes: Int!
state: String!
response: String
responseCreatedAt: DateTime
}
type ProductReviewList implements PaginatedList {
items: [ProductReview!]!
totalItems: Int!
}
type ProductReviewHistogramItem {
bin: Int!
frequency: Int!
}
extend type Product {
reviews(options: ProductReviewListOptions): ProductReviewList!
reviewsHistogram: [ProductReviewHistogramItem!]!
}
# Auto-generated at runtime
input ProductReviewListOptions
`;
export const adminApiExtensions = gql`
${commonApiExtensions}
input UpdateProductReviewInput {
id: ID!
summary: String
body: String
response: String
}
extend type ProductReview {
author: Customer
}
extend type Query {
productReviews(options: ProductReviewListOptions): ProductReviewList!
productReview(id: ID!): ProductReview
}
extend type Mutation {
updateProductReview(input: UpdateProductReviewInput!): ProductReview!
approveProductReview(id: ID!): ProductReview
rejectProductReview(id: ID!): ProductReview
}
`;
export const shopApiExtensions = gql`
${commonApiExtensions}
input SubmitProductReviewInput {
productId: ID!
variantId: ID
customerId: ID
summary: String!
body: String!
rating: Float!
authorName: String!
authorLocation: String
}
extend type Mutation {
submitProductReview(input: SubmitProductReviewInput!): ProductReview!
voteOnReview(id: ID!, vote: Boolean!): ProductReview!
}
`;
|
import { Args, Parent, ResolveField, Resolver } from '@nestjs/graphql';
import { Api, ApiType, ListQueryBuilder, Product, TransactionalConnection } from '@vendure/core';
import { ProductReview } from '../entities/product-review.entity';
import { ProductReviewsArgs } from '../generated-shop-types';
@Resolver('Product')
export class ProductEntityResolver {
constructor(private listQueryBuilder: ListQueryBuilder, private connection: TransactionalConnection) {}
@ResolveField()
reviews(@Api() apiType: ApiType, @Parent() product: Product, @Args() args: ProductReviewsArgs) {
return this.listQueryBuilder
.build(ProductReview, args.options || undefined, {
where: {
product: { id: product.id },
...(apiType === 'shop' ? { state: 'approved' } : {}),
},
relations: ['product', 'product.featuredAsset'],
})
.getManyAndCount()
.then(([items, totalItems]) => ({
items,
totalItems,
}));
}
@ResolveField()
reviewsHistogram(@Parent() product: Product) {
return this.connection.rawConnection
.createQueryBuilder()
.select('ROUND(`rating`)', 'bin')
.addSelect('COUNT(*)', 'frequency')
.from(ProductReview, 'review')
.where('review.product = :productId', { productId: product.id })
.andWhere('review.state = :state', { state: 'approved' })
.groupBy('ROUND(`rating`)')
.getRawMany();
}
}
|
import { Args, Mutation, Query, Resolver } from '@nestjs/graphql';
import {
Allow,
Ctx,
ListQueryBuilder,
patchEntity,
Permission,
Product,
RequestContext,
Transaction,
TransactionalConnection,
} from '@vendure/core';
import { ProductReview } from '../entities/product-review.entity';
import {
MutationApproveProductReviewArgs,
MutationRejectProductReviewArgs,
MutationUpdateProductReviewArgs,
QueryProductReviewArgs,
QueryProductReviewsArgs,
} from '../generated-admin-types';
@Resolver()
export class ProductReviewAdminResolver {
constructor(private connection: TransactionalConnection, private listQueryBuilder: ListQueryBuilder) {}
@Query()
@Allow(Permission.ReadCatalog)
async productReviews(@Ctx() ctx: RequestContext, @Args() args: QueryProductReviewsArgs) {
return this.listQueryBuilder
.build(ProductReview, args.options || undefined, {
relations: ['product'],
ctx,
})
.getManyAndCount()
.then(([items, totalItems]) => ({
items,
totalItems,
}));
}
@Query()
@Allow(Permission.ReadCatalog)
async productReview(@Ctx() ctx: RequestContext, @Args() args: QueryProductReviewArgs) {
return this.connection.getRepository(ctx, ProductReview).findOne({
where: { id: args.id },
relations: {
author: true,
product: true,
productVariant: true,
},
});
}
@Transaction()
@Mutation()
@Allow(Permission.UpdateCatalog)
async updateProductReview(
@Ctx() ctx: RequestContext,
@Args() { input }: MutationUpdateProductReviewArgs,
) {
const review = await this.connection.getEntityOrThrow(ctx, ProductReview, input.id);
const originalResponse = review.response;
const updatedProductReview = patchEntity(review, input);
if (input.response !== originalResponse) {
updatedProductReview.responseCreatedAt = new Date();
}
return this.connection.getRepository(ctx, ProductReview).save(updatedProductReview);
}
@Transaction()
@Mutation()
@Allow(Permission.UpdateCatalog)
async approveProductReview(@Ctx() ctx: RequestContext, @Args() { id }: MutationApproveProductReviewArgs) {
const review = await this.connection.getEntityOrThrow(ctx, ProductReview, id, {
relations: ['product'],
});
if (review.state !== 'new') {
return review;
}
const { product } = review;
const newRating = this.calculateNewReviewAverage(review.rating, product);
product.customFields.reviewCount++;
product.customFields.reviewRating = newRating;
await this.connection.getRepository(ctx, Product).save(product);
review.state = 'approved';
return this.connection.getRepository(ctx, ProductReview).save(review);
}
@Transaction()
@Mutation()
@Allow(Permission.UpdateCatalog)
async rejectProductReview(@Ctx() ctx: RequestContext, @Args() { id }: MutationRejectProductReviewArgs) {
const review = await this.connection.getEntityOrThrow(ctx, ProductReview, id);
if (review.state !== 'new') {
return review;
}
review.state = 'rejected';
return this.connection.getRepository(ctx, ProductReview).save(review);
}
private calculateNewReviewAverage(rating: number, product: Product): number {
const count = product.customFields.reviewCount;
const currentRating = product.customFields.reviewRating || 0;
const newRating = (currentRating * count + rating) / (count + 1);
return newRating;
}
}
|
import { Parent, ResolveField, Resolver } from '@nestjs/graphql';
import {
Ctx,
Product,
ProductVariant,
RequestContext,
TransactionalConnection,
translateDeep,
} from '@vendure/core';
import { ProductReview } from '../entities/product-review.entity';
@Resolver('ProductReview')
export class ProductReviewEntityResolver {
constructor(private connection: TransactionalConnection) {}
@ResolveField()
async product(@Parent() review: ProductReview, @Ctx() ctx: RequestContext) {
let product: Product | null = review.product;
if (!product) {
const reviewWithProduct = await this.connection.getRepository(ctx, ProductReview).findOne({
where: { id: review.id },
relations: {
product: true,
},
});
if (reviewWithProduct) {
product = reviewWithProduct.product;
}
}
if (product) {
return translateDeep(product, ctx.languageCode);
}
}
@ResolveField()
async productVariant(@Parent() review: ProductReview, @Ctx() ctx: RequestContext) {
let productVariant: ProductVariant | null = review.productVariant;
if (!productVariant) {
const reviewWithProductVariant = await this.connection.getRepository(ctx, ProductReview).findOne({
where: { id: review.id },
relations: {
productVariant: true,
},
});
if (reviewWithProductVariant) {
productVariant = reviewWithProductVariant.productVariant;
}
}
if (productVariant) {
return translateDeep(productVariant, ctx.languageCode);
}
}
}
|
import { Args, Mutation, Resolver } from '@nestjs/graphql';
import {
Ctx,
Customer,
ListQueryBuilder,
Product,
ProductVariant,
RequestContext,
Transaction,
TransactionalConnection,
} from '@vendure/core';
import { ProductReview } from '../entities/product-review.entity';
import { MutationSubmitProductReviewArgs, MutationVoteOnReviewArgs } from '../generated-shop-types';
@Resolver()
export class ProductReviewShopResolver {
constructor(private connection: TransactionalConnection, private listQueryBuilder: ListQueryBuilder) {}
@Transaction()
@Mutation()
async submitProductReview(
@Ctx() ctx: RequestContext,
@Args() { input }: MutationSubmitProductReviewArgs,
) {
const review = new ProductReview(input);
const product = await this.connection.getEntityOrThrow(ctx, Product, input.productId);
review.product = product;
review.state = 'new';
if (input.variantId) {
const variant = await this.connection.getEntityOrThrow(ctx, ProductVariant, input.variantId);
review.productVariant = variant;
}
if (input.customerId) {
const customer = await this.connection.getEntityOrThrow(ctx, Customer, input.customerId);
review.author = customer;
}
return this.connection.getRepository(ctx, ProductReview).save(review);
}
@Transaction()
@Mutation()
async voteOnReview(@Ctx() ctx: RequestContext, @Args() { id, vote }: MutationVoteOnReviewArgs) {
const review = await this.connection.getEntityOrThrow(ctx, ProductReview, id, {
relations: ['product'],
where: {
state: 'approved',
},
});
if (vote) {
review.upvotes++;
} else {
review.downvotes++;
}
return this.connection.getRepository(ctx, ProductReview).save(review);
}
}
|
/* eslint-disable @typescript-eslint/no-unused-vars */
import { Customer, DeepPartial, Product, ProductVariant, VendureEntity } from '@vendure/core';
import { Column, Entity, ManyToOne } from 'typeorm';
import { ReviewState } from '../types';
@Entity()
export class ProductReview extends VendureEntity {
constructor(input?: DeepPartial<ProductReview>) {
super(input);
}
@ManyToOne(type => Product)
product: Product;
@ManyToOne(type => ProductVariant)
productVariant: ProductVariant | null;
@Column()
summary: string;
@Column('text')
body: string;
@Column()
rating: number;
@ManyToOne(type => Customer)
author: Customer;
@Column()
authorName: string;
@Column({ nullable: true })
authorLocation: string;
@Column({ default: 0 })
upvotes: number;
@Column({ default: 0 })
downvotes: number;
@Column('varchar')
state: ReviewState;
@Column('text', { nullable: true, default: null })
response: string;
@Column({ nullable: true, default: null })
responseCreatedAt: Date;
}
|
/* eslint-disable */
import { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
export type Maybe<T> = T;
export type InputMaybe<T> = T;
export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
export type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]?: Maybe<T[SubKey]> };
export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]: Maybe<T[SubKey]> };
export type MakeEmpty<T extends { [key: string]: unknown }, K extends keyof T> = { [_ in K]?: never };
export type Incremental<T> =
| T
| { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
/** All built-in and custom scalars, mapped to their actual values */
export type Scalars = {
ID: { input: string; output: string };
String: { input: string; output: string };
Boolean: { input: boolean; output: boolean };
Int: { input: number; output: number };
Float: { input: number; output: number };
DateTime: { input: any; output: any };
JSON: { input: any; output: any };
Money: { input: number; output: number };
Upload: { input: any; output: any };
};
export type AddFulfillmentToOrderResult =
| CreateFulfillmentError
| EmptyOrderLineSelectionError
| Fulfillment
| FulfillmentStateTransitionError
| InsufficientStockOnHandError
| InvalidFulfillmentHandlerError
| ItemsAlreadyFulfilledError;
export type AddItemInput = {
productVariantId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type AddItemToDraftOrderInput = {
productVariantId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type AddManualPaymentToOrderResult = ManualPaymentStateError | Order;
export type AddNoteToCustomerInput = {
id: Scalars['ID']['input'];
isPublic: Scalars['Boolean']['input'];
note: Scalars['String']['input'];
};
export type AddNoteToOrderInput = {
id: Scalars['ID']['input'];
isPublic: Scalars['Boolean']['input'];
note: Scalars['String']['input'];
};
export type Address = Node & {
__typename?: 'Address';
city?: Maybe<Scalars['String']['output']>;
company?: Maybe<Scalars['String']['output']>;
country: Country;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
defaultBillingAddress?: Maybe<Scalars['Boolean']['output']>;
defaultShippingAddress?: Maybe<Scalars['Boolean']['output']>;
fullName?: Maybe<Scalars['String']['output']>;
id: Scalars['ID']['output'];
phoneNumber?: Maybe<Scalars['String']['output']>;
postalCode?: Maybe<Scalars['String']['output']>;
province?: Maybe<Scalars['String']['output']>;
streetLine1: Scalars['String']['output'];
streetLine2?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type AdjustDraftOrderLineInput = {
orderLineId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type Adjustment = {
__typename?: 'Adjustment';
adjustmentSource: Scalars['String']['output'];
amount: Scalars['Money']['output'];
data?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
type: AdjustmentType;
};
export enum AdjustmentType {
DISTRIBUTED_ORDER_PROMOTION = 'DISTRIBUTED_ORDER_PROMOTION',
OTHER = 'OTHER',
PROMOTION = 'PROMOTION',
}
export type Administrator = Node & {
__typename?: 'Administrator';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
emailAddress: Scalars['String']['output'];
firstName: Scalars['String']['output'];
id: Scalars['ID']['output'];
lastName: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
user: User;
};
export type AdministratorFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
emailAddress?: InputMaybe<StringOperators>;
firstName?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
lastName?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type AdministratorList = PaginatedList & {
__typename?: 'AdministratorList';
items: Array<Administrator>;
totalItems: Scalars['Int']['output'];
};
export type AdministratorListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<AdministratorFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<AdministratorSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type AdministratorPaymentInput = {
metadata?: InputMaybe<Scalars['JSON']['input']>;
paymentMethod?: InputMaybe<Scalars['String']['input']>;
};
export type AdministratorRefundInput = {
paymentId: Scalars['ID']['input'];
reason?: InputMaybe<Scalars['String']['input']>;
};
export type AdministratorSortParameter = {
createdAt?: InputMaybe<SortOrder>;
emailAddress?: InputMaybe<SortOrder>;
firstName?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
lastName?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type Allocation = Node &
StockMovement & {
__typename?: 'Allocation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
orderLine: OrderLine;
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
/** Returned if an attempting to refund an OrderItem which has already been refunded */
export type AlreadyRefundedError = ErrorResult & {
__typename?: 'AlreadyRefundedError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
refundId: Scalars['ID']['output'];
};
export type ApplyCouponCodeResult =
| CouponCodeExpiredError
| CouponCodeInvalidError
| CouponCodeLimitError
| Order;
export type Asset = Node & {
__typename?: 'Asset';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
fileSize: Scalars['Int']['output'];
focalPoint?: Maybe<Coordinate>;
height: Scalars['Int']['output'];
id: Scalars['ID']['output'];
mimeType: Scalars['String']['output'];
name: Scalars['String']['output'];
preview: Scalars['String']['output'];
source: Scalars['String']['output'];
tags: Array<Tag>;
type: AssetType;
updatedAt: Scalars['DateTime']['output'];
width: Scalars['Int']['output'];
};
export type AssetFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
fileSize?: InputMaybe<NumberOperators>;
height?: InputMaybe<NumberOperators>;
id?: InputMaybe<IdOperators>;
mimeType?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
preview?: InputMaybe<StringOperators>;
source?: InputMaybe<StringOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
width?: InputMaybe<NumberOperators>;
};
export type AssetList = PaginatedList & {
__typename?: 'AssetList';
items: Array<Asset>;
totalItems: Scalars['Int']['output'];
};
export type AssetListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<AssetFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<AssetSortParameter>;
tags?: InputMaybe<Array<Scalars['String']['input']>>;
tagsOperator?: InputMaybe<LogicalOperator>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type AssetSortParameter = {
createdAt?: InputMaybe<SortOrder>;
fileSize?: InputMaybe<SortOrder>;
height?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
mimeType?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
preview?: InputMaybe<SortOrder>;
source?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
width?: InputMaybe<SortOrder>;
};
export enum AssetType {
BINARY = 'BINARY',
IMAGE = 'IMAGE',
VIDEO = 'VIDEO',
}
export type AssignAssetsToChannelInput = {
assetIds: Array<Scalars['ID']['input']>;
channelId: Scalars['ID']['input'];
};
export type AssignCollectionsToChannelInput = {
channelId: Scalars['ID']['input'];
collectionIds: Array<Scalars['ID']['input']>;
};
export type AssignFacetsToChannelInput = {
channelId: Scalars['ID']['input'];
facetIds: Array<Scalars['ID']['input']>;
};
export type AssignPaymentMethodsToChannelInput = {
channelId: Scalars['ID']['input'];
paymentMethodIds: Array<Scalars['ID']['input']>;
};
export type AssignProductVariantsToChannelInput = {
channelId: Scalars['ID']['input'];
priceFactor?: InputMaybe<Scalars['Float']['input']>;
productVariantIds: Array<Scalars['ID']['input']>;
};
export type AssignProductsToChannelInput = {
channelId: Scalars['ID']['input'];
priceFactor?: InputMaybe<Scalars['Float']['input']>;
productIds: Array<Scalars['ID']['input']>;
};
export type AssignPromotionsToChannelInput = {
channelId: Scalars['ID']['input'];
promotionIds: Array<Scalars['ID']['input']>;
};
export type AssignShippingMethodsToChannelInput = {
channelId: Scalars['ID']['input'];
shippingMethodIds: Array<Scalars['ID']['input']>;
};
export type AssignStockLocationsToChannelInput = {
channelId: Scalars['ID']['input'];
stockLocationIds: Array<Scalars['ID']['input']>;
};
export type AuthenticationInput = {
native?: InputMaybe<NativeAuthInput>;
};
export type AuthenticationMethod = Node & {
__typename?: 'AuthenticationMethod';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
strategy: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type AuthenticationResult = CurrentUser | InvalidCredentialsError;
export type BooleanCustomFieldConfig = CustomField & {
__typename?: 'BooleanCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
/** Operators for filtering on a list of Boolean fields */
export type BooleanListOperators = {
inList: Scalars['Boolean']['input'];
};
/** Operators for filtering on a Boolean field */
export type BooleanOperators = {
eq?: InputMaybe<Scalars['Boolean']['input']>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
};
/** Returned if an attempting to cancel lines from an Order which is still active */
export type CancelActiveOrderError = ErrorResult & {
__typename?: 'CancelActiveOrderError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
orderState: Scalars['String']['output'];
};
export type CancelOrderInput = {
/** Specify whether the shipping charges should also be cancelled. Defaults to false */
cancelShipping?: InputMaybe<Scalars['Boolean']['input']>;
/** Optionally specify which OrderLines to cancel. If not provided, all OrderLines will be cancelled */
lines?: InputMaybe<Array<OrderLineInput>>;
/** The id of the order to be cancelled */
orderId: Scalars['ID']['input'];
reason?: InputMaybe<Scalars['String']['input']>;
};
export type CancelOrderResult =
| CancelActiveOrderError
| EmptyOrderLineSelectionError
| MultipleOrderError
| Order
| OrderStateTransitionError
| QuantityTooGreatError;
/** Returned if the Payment cancellation fails */
export type CancelPaymentError = ErrorResult & {
__typename?: 'CancelPaymentError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
paymentErrorMessage: Scalars['String']['output'];
};
export type CancelPaymentResult = CancelPaymentError | Payment | PaymentStateTransitionError;
export type Cancellation = Node &
StockMovement & {
__typename?: 'Cancellation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
orderLine: OrderLine;
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type Channel = Node & {
__typename?: 'Channel';
availableCurrencyCodes: Array<CurrencyCode>;
availableLanguageCodes?: Maybe<Array<LanguageCode>>;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
/** @deprecated Use defaultCurrencyCode instead */
currencyCode: CurrencyCode;
customFields?: Maybe<Scalars['JSON']['output']>;
defaultCurrencyCode: CurrencyCode;
defaultLanguageCode: LanguageCode;
defaultShippingZone?: Maybe<Zone>;
defaultTaxZone?: Maybe<Zone>;
id: Scalars['ID']['output'];
/** Not yet used - will be implemented in a future release. */
outOfStockThreshold?: Maybe<Scalars['Int']['output']>;
pricesIncludeTax: Scalars['Boolean']['output'];
seller?: Maybe<Seller>;
token: Scalars['String']['output'];
/** Not yet used - will be implemented in a future release. */
trackInventory?: Maybe<Scalars['Boolean']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
/**
* Returned when the default LanguageCode of a Channel is no longer found in the `availableLanguages`
* of the GlobalSettings
*/
export type ChannelDefaultLanguageError = ErrorResult & {
__typename?: 'ChannelDefaultLanguageError';
channelCode: Scalars['String']['output'];
errorCode: ErrorCode;
language: Scalars['String']['output'];
message: Scalars['String']['output'];
};
export type ChannelFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
currencyCode?: InputMaybe<StringOperators>;
defaultCurrencyCode?: InputMaybe<StringOperators>;
defaultLanguageCode?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
outOfStockThreshold?: InputMaybe<NumberOperators>;
pricesIncludeTax?: InputMaybe<BooleanOperators>;
token?: InputMaybe<StringOperators>;
trackInventory?: InputMaybe<BooleanOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ChannelList = PaginatedList & {
__typename?: 'ChannelList';
items: Array<Channel>;
totalItems: Scalars['Int']['output'];
};
export type ChannelListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ChannelFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ChannelSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ChannelSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
outOfStockThreshold?: InputMaybe<SortOrder>;
token?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type Collection = Node & {
__typename?: 'Collection';
assets: Array<Asset>;
breadcrumbs: Array<CollectionBreadcrumb>;
children?: Maybe<Array<Collection>>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
featuredAsset?: Maybe<Asset>;
filters: Array<ConfigurableOperation>;
id: Scalars['ID']['output'];
inheritFilters: Scalars['Boolean']['output'];
isPrivate: Scalars['Boolean']['output'];
languageCode?: Maybe<LanguageCode>;
name: Scalars['String']['output'];
parent?: Maybe<Collection>;
parentId: Scalars['ID']['output'];
position: Scalars['Int']['output'];
productVariants: ProductVariantList;
slug: Scalars['String']['output'];
translations: Array<CollectionTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type CollectionProductVariantsArgs = {
options?: InputMaybe<ProductVariantListOptions>;
};
export type CollectionBreadcrumb = {
__typename?: 'CollectionBreadcrumb';
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
slug: Scalars['String']['output'];
};
export type CollectionFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
inheritFilters?: InputMaybe<BooleanOperators>;
isPrivate?: InputMaybe<BooleanOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
parentId?: InputMaybe<IdOperators>;
position?: InputMaybe<NumberOperators>;
slug?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CollectionList = PaginatedList & {
__typename?: 'CollectionList';
items: Array<Collection>;
totalItems: Scalars['Int']['output'];
};
export type CollectionListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CollectionFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CollectionSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
topLevelOnly?: InputMaybe<Scalars['Boolean']['input']>;
};
/**
* Which Collections are present in the products returned
* by the search, and in what quantity.
*/
export type CollectionResult = {
__typename?: 'CollectionResult';
collection: Collection;
count: Scalars['Int']['output'];
};
export type CollectionSortParameter = {
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
parentId?: InputMaybe<SortOrder>;
position?: InputMaybe<SortOrder>;
slug?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type CollectionTranslation = {
__typename?: 'CollectionTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
slug: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ConfigArg = {
__typename?: 'ConfigArg';
name: Scalars['String']['output'];
value: Scalars['String']['output'];
};
export type ConfigArgDefinition = {
__typename?: 'ConfigArgDefinition';
defaultValue?: Maybe<Scalars['JSON']['output']>;
description?: Maybe<Scalars['String']['output']>;
label?: Maybe<Scalars['String']['output']>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
required: Scalars['Boolean']['output'];
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type ConfigArgInput = {
name: Scalars['String']['input'];
/** A JSON stringified representation of the actual value */
value: Scalars['String']['input'];
};
export type ConfigurableOperation = {
__typename?: 'ConfigurableOperation';
args: Array<ConfigArg>;
code: Scalars['String']['output'];
};
export type ConfigurableOperationDefinition = {
__typename?: 'ConfigurableOperationDefinition';
args: Array<ConfigArgDefinition>;
code: Scalars['String']['output'];
description: Scalars['String']['output'];
};
export type ConfigurableOperationInput = {
arguments: Array<ConfigArgInput>;
code: Scalars['String']['input'];
};
export type Coordinate = {
__typename?: 'Coordinate';
x: Scalars['Float']['output'];
y: Scalars['Float']['output'];
};
export type CoordinateInput = {
x: Scalars['Float']['input'];
y: Scalars['Float']['input'];
};
export type Country = Node &
Region & {
__typename?: 'Country';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
parent?: Maybe<Region>;
parentId?: Maybe<Scalars['ID']['output']>;
translations: Array<RegionTranslation>;
type: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type CountryFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
enabled?: InputMaybe<BooleanOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
parentId?: InputMaybe<IdOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CountryList = PaginatedList & {
__typename?: 'CountryList';
items: Array<Country>;
totalItems: Scalars['Int']['output'];
};
export type CountryListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CountryFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CountrySortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type CountrySortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
parentId?: InputMaybe<SortOrder>;
type?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type CountryTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
/** Returned if the provided coupon code is invalid */
export type CouponCodeExpiredError = ErrorResult & {
__typename?: 'CouponCodeExpiredError';
couponCode: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the provided coupon code is invalid */
export type CouponCodeInvalidError = ErrorResult & {
__typename?: 'CouponCodeInvalidError';
couponCode: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the provided coupon code is invalid */
export type CouponCodeLimitError = ErrorResult & {
__typename?: 'CouponCodeLimitError';
couponCode: Scalars['String']['output'];
errorCode: ErrorCode;
limit: Scalars['Int']['output'];
message: Scalars['String']['output'];
};
export type CreateAddressInput = {
city?: InputMaybe<Scalars['String']['input']>;
company?: InputMaybe<Scalars['String']['input']>;
countryCode: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
defaultBillingAddress?: InputMaybe<Scalars['Boolean']['input']>;
defaultShippingAddress?: InputMaybe<Scalars['Boolean']['input']>;
fullName?: InputMaybe<Scalars['String']['input']>;
phoneNumber?: InputMaybe<Scalars['String']['input']>;
postalCode?: InputMaybe<Scalars['String']['input']>;
province?: InputMaybe<Scalars['String']['input']>;
streetLine1: Scalars['String']['input'];
streetLine2?: InputMaybe<Scalars['String']['input']>;
};
export type CreateAdministratorInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress: Scalars['String']['input'];
firstName: Scalars['String']['input'];
lastName: Scalars['String']['input'];
password: Scalars['String']['input'];
roleIds: Array<Scalars['ID']['input']>;
};
export type CreateAssetInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
file: Scalars['Upload']['input'];
tags?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type CreateAssetResult = Asset | MimeTypeError;
export type CreateChannelInput = {
availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
defaultCurrencyCode?: InputMaybe<CurrencyCode>;
defaultLanguageCode: LanguageCode;
defaultShippingZoneId: Scalars['ID']['input'];
defaultTaxZoneId: Scalars['ID']['input'];
outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
pricesIncludeTax: Scalars['Boolean']['input'];
sellerId?: InputMaybe<Scalars['ID']['input']>;
token: Scalars['String']['input'];
trackInventory?: InputMaybe<Scalars['Boolean']['input']>;
};
export type CreateChannelResult = Channel | LanguageNotAvailableError;
export type CreateCollectionInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
filters: Array<ConfigurableOperationInput>;
inheritFilters?: InputMaybe<Scalars['Boolean']['input']>;
isPrivate?: InputMaybe<Scalars['Boolean']['input']>;
parentId?: InputMaybe<Scalars['ID']['input']>;
translations: Array<CreateCollectionTranslationInput>;
};
export type CreateCollectionTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description: Scalars['String']['input'];
languageCode: LanguageCode;
name: Scalars['String']['input'];
slug: Scalars['String']['input'];
};
export type CreateCountryInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled: Scalars['Boolean']['input'];
translations: Array<CountryTranslationInput>;
};
export type CreateCustomerGroupInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
customerIds?: InputMaybe<Array<Scalars['ID']['input']>>;
name: Scalars['String']['input'];
};
export type CreateCustomerInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress: Scalars['String']['input'];
firstName: Scalars['String']['input'];
lastName: Scalars['String']['input'];
phoneNumber?: InputMaybe<Scalars['String']['input']>;
title?: InputMaybe<Scalars['String']['input']>;
};
export type CreateCustomerResult = Customer | EmailAddressConflictError;
export type CreateFacetInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
isPrivate: Scalars['Boolean']['input'];
translations: Array<FacetTranslationInput>;
values?: InputMaybe<Array<CreateFacetValueWithFacetInput>>;
};
export type CreateFacetValueInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
facetId: Scalars['ID']['input'];
translations: Array<FacetValueTranslationInput>;
};
export type CreateFacetValueWithFacetInput = {
code: Scalars['String']['input'];
translations: Array<FacetValueTranslationInput>;
};
/** Returned if an error is thrown in a FulfillmentHandler's createFulfillment method */
export type CreateFulfillmentError = ErrorResult & {
__typename?: 'CreateFulfillmentError';
errorCode: ErrorCode;
fulfillmentHandlerError: Scalars['String']['output'];
message: Scalars['String']['output'];
};
export type CreateGroupOptionInput = {
code: Scalars['String']['input'];
translations: Array<ProductOptionGroupTranslationInput>;
};
export type CreatePaymentMethodInput = {
checker?: InputMaybe<ConfigurableOperationInput>;
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled: Scalars['Boolean']['input'];
handler: ConfigurableOperationInput;
translations: Array<PaymentMethodTranslationInput>;
};
export type CreateProductCustomFieldsInput = {
featuredReviewId?: InputMaybe<Scalars['ID']['input']>;
reviewCount?: InputMaybe<Scalars['Float']['input']>;
reviewRating?: InputMaybe<Scalars['Float']['input']>;
};
export type CreateProductInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<CreateProductCustomFieldsInput>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
translations: Array<ProductTranslationInput>;
};
export type CreateProductOptionGroupInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
options: Array<CreateGroupOptionInput>;
translations: Array<ProductOptionGroupTranslationInput>;
};
export type CreateProductOptionInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
productOptionGroupId: Scalars['ID']['input'];
translations: Array<ProductOptionGroupTranslationInput>;
};
export type CreateProductVariantInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
optionIds?: InputMaybe<Array<Scalars['ID']['input']>>;
outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
price?: InputMaybe<Scalars['Money']['input']>;
productId: Scalars['ID']['input'];
sku: Scalars['String']['input'];
stockLevels?: InputMaybe<Array<StockLevelInput>>;
stockOnHand?: InputMaybe<Scalars['Int']['input']>;
taxCategoryId?: InputMaybe<Scalars['ID']['input']>;
trackInventory?: InputMaybe<GlobalFlag>;
translations: Array<ProductVariantTranslationInput>;
useGlobalOutOfStockThreshold?: InputMaybe<Scalars['Boolean']['input']>;
};
export type CreateProductVariantOptionInput = {
code: Scalars['String']['input'];
optionGroupId: Scalars['ID']['input'];
translations: Array<ProductOptionTranslationInput>;
};
export type CreatePromotionInput = {
actions: Array<ConfigurableOperationInput>;
conditions: Array<ConfigurableOperationInput>;
couponCode?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled: Scalars['Boolean']['input'];
endsAt?: InputMaybe<Scalars['DateTime']['input']>;
perCustomerUsageLimit?: InputMaybe<Scalars['Int']['input']>;
startsAt?: InputMaybe<Scalars['DateTime']['input']>;
translations: Array<PromotionTranslationInput>;
};
export type CreatePromotionResult = MissingConditionsError | Promotion;
export type CreateProvinceInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled: Scalars['Boolean']['input'];
translations: Array<ProvinceTranslationInput>;
};
export type CreateRoleInput = {
channelIds?: InputMaybe<Array<Scalars['ID']['input']>>;
code: Scalars['String']['input'];
description: Scalars['String']['input'];
permissions: Array<Permission>;
};
export type CreateSellerInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
name: Scalars['String']['input'];
};
export type CreateShippingMethodInput = {
calculator: ConfigurableOperationInput;
checker: ConfigurableOperationInput;
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
fulfillmentHandler: Scalars['String']['input'];
translations: Array<ShippingMethodTranslationInput>;
};
export type CreateStockLocationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
name: Scalars['String']['input'];
};
export type CreateTagInput = {
value: Scalars['String']['input'];
};
export type CreateTaxCategoryInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
isDefault?: InputMaybe<Scalars['Boolean']['input']>;
name: Scalars['String']['input'];
};
export type CreateTaxRateInput = {
categoryId: Scalars['ID']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
customerGroupId?: InputMaybe<Scalars['ID']['input']>;
enabled: Scalars['Boolean']['input'];
name: Scalars['String']['input'];
value: Scalars['Float']['input'];
zoneId: Scalars['ID']['input'];
};
export type CreateZoneInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
memberIds?: InputMaybe<Array<Scalars['ID']['input']>>;
name: Scalars['String']['input'];
};
/**
* @description
* ISO 4217 currency code
*
* @docsCategory common
*/
export enum CurrencyCode {
/** United Arab Emirates dirham */
AED = 'AED',
/** Afghan afghani */
AFN = 'AFN',
/** Albanian lek */
ALL = 'ALL',
/** Armenian dram */
AMD = 'AMD',
/** Netherlands Antillean guilder */
ANG = 'ANG',
/** Angolan kwanza */
AOA = 'AOA',
/** Argentine peso */
ARS = 'ARS',
/** Australian dollar */
AUD = 'AUD',
/** Aruban florin */
AWG = 'AWG',
/** Azerbaijani manat */
AZN = 'AZN',
/** Bosnia and Herzegovina convertible mark */
BAM = 'BAM',
/** Barbados dollar */
BBD = 'BBD',
/** Bangladeshi taka */
BDT = 'BDT',
/** Bulgarian lev */
BGN = 'BGN',
/** Bahraini dinar */
BHD = 'BHD',
/** Burundian franc */
BIF = 'BIF',
/** Bermudian dollar */
BMD = 'BMD',
/** Brunei dollar */
BND = 'BND',
/** Boliviano */
BOB = 'BOB',
/** Brazilian real */
BRL = 'BRL',
/** Bahamian dollar */
BSD = 'BSD',
/** Bhutanese ngultrum */
BTN = 'BTN',
/** Botswana pula */
BWP = 'BWP',
/** Belarusian ruble */
BYN = 'BYN',
/** Belize dollar */
BZD = 'BZD',
/** Canadian dollar */
CAD = 'CAD',
/** Congolese franc */
CDF = 'CDF',
/** Swiss franc */
CHF = 'CHF',
/** Chilean peso */
CLP = 'CLP',
/** Renminbi (Chinese) yuan */
CNY = 'CNY',
/** Colombian peso */
COP = 'COP',
/** Costa Rican colon */
CRC = 'CRC',
/** Cuban convertible peso */
CUC = 'CUC',
/** Cuban peso */
CUP = 'CUP',
/** Cape Verde escudo */
CVE = 'CVE',
/** Czech koruna */
CZK = 'CZK',
/** Djiboutian franc */
DJF = 'DJF',
/** Danish krone */
DKK = 'DKK',
/** Dominican peso */
DOP = 'DOP',
/** Algerian dinar */
DZD = 'DZD',
/** Egyptian pound */
EGP = 'EGP',
/** Eritrean nakfa */
ERN = 'ERN',
/** Ethiopian birr */
ETB = 'ETB',
/** Euro */
EUR = 'EUR',
/** Fiji dollar */
FJD = 'FJD',
/** Falkland Islands pound */
FKP = 'FKP',
/** Pound sterling */
GBP = 'GBP',
/** Georgian lari */
GEL = 'GEL',
/** Ghanaian cedi */
GHS = 'GHS',
/** Gibraltar pound */
GIP = 'GIP',
/** Gambian dalasi */
GMD = 'GMD',
/** Guinean franc */
GNF = 'GNF',
/** Guatemalan quetzal */
GTQ = 'GTQ',
/** Guyanese dollar */
GYD = 'GYD',
/** Hong Kong dollar */
HKD = 'HKD',
/** Honduran lempira */
HNL = 'HNL',
/** Croatian kuna */
HRK = 'HRK',
/** Haitian gourde */
HTG = 'HTG',
/** Hungarian forint */
HUF = 'HUF',
/** Indonesian rupiah */
IDR = 'IDR',
/** Israeli new shekel */
ILS = 'ILS',
/** Indian rupee */
INR = 'INR',
/** Iraqi dinar */
IQD = 'IQD',
/** Iranian rial */
IRR = 'IRR',
/** Icelandic króna */
ISK = 'ISK',
/** Jamaican dollar */
JMD = 'JMD',
/** Jordanian dinar */
JOD = 'JOD',
/** Japanese yen */
JPY = 'JPY',
/** Kenyan shilling */
KES = 'KES',
/** Kyrgyzstani som */
KGS = 'KGS',
/** Cambodian riel */
KHR = 'KHR',
/** Comoro franc */
KMF = 'KMF',
/** North Korean won */
KPW = 'KPW',
/** South Korean won */
KRW = 'KRW',
/** Kuwaiti dinar */
KWD = 'KWD',
/** Cayman Islands dollar */
KYD = 'KYD',
/** Kazakhstani tenge */
KZT = 'KZT',
/** Lao kip */
LAK = 'LAK',
/** Lebanese pound */
LBP = 'LBP',
/** Sri Lankan rupee */
LKR = 'LKR',
/** Liberian dollar */
LRD = 'LRD',
/** Lesotho loti */
LSL = 'LSL',
/** Libyan dinar */
LYD = 'LYD',
/** Moroccan dirham */
MAD = 'MAD',
/** Moldovan leu */
MDL = 'MDL',
/** Malagasy ariary */
MGA = 'MGA',
/** Macedonian denar */
MKD = 'MKD',
/** Myanmar kyat */
MMK = 'MMK',
/** Mongolian tögrög */
MNT = 'MNT',
/** Macanese pataca */
MOP = 'MOP',
/** Mauritanian ouguiya */
MRU = 'MRU',
/** Mauritian rupee */
MUR = 'MUR',
/** Maldivian rufiyaa */
MVR = 'MVR',
/** Malawian kwacha */
MWK = 'MWK',
/** Mexican peso */
MXN = 'MXN',
/** Malaysian ringgit */
MYR = 'MYR',
/** Mozambican metical */
MZN = 'MZN',
/** Namibian dollar */
NAD = 'NAD',
/** Nigerian naira */
NGN = 'NGN',
/** Nicaraguan córdoba */
NIO = 'NIO',
/** Norwegian krone */
NOK = 'NOK',
/** Nepalese rupee */
NPR = 'NPR',
/** New Zealand dollar */
NZD = 'NZD',
/** Omani rial */
OMR = 'OMR',
/** Panamanian balboa */
PAB = 'PAB',
/** Peruvian sol */
PEN = 'PEN',
/** Papua New Guinean kina */
PGK = 'PGK',
/** Philippine peso */
PHP = 'PHP',
/** Pakistani rupee */
PKR = 'PKR',
/** Polish złoty */
PLN = 'PLN',
/** Paraguayan guaraní */
PYG = 'PYG',
/** Qatari riyal */
QAR = 'QAR',
/** Romanian leu */
RON = 'RON',
/** Serbian dinar */
RSD = 'RSD',
/** Russian ruble */
RUB = 'RUB',
/** Rwandan franc */
RWF = 'RWF',
/** Saudi riyal */
SAR = 'SAR',
/** Solomon Islands dollar */
SBD = 'SBD',
/** Seychelles rupee */
SCR = 'SCR',
/** Sudanese pound */
SDG = 'SDG',
/** Swedish krona/kronor */
SEK = 'SEK',
/** Singapore dollar */
SGD = 'SGD',
/** Saint Helena pound */
SHP = 'SHP',
/** Sierra Leonean leone */
SLL = 'SLL',
/** Somali shilling */
SOS = 'SOS',
/** Surinamese dollar */
SRD = 'SRD',
/** South Sudanese pound */
SSP = 'SSP',
/** São Tomé and Príncipe dobra */
STN = 'STN',
/** Salvadoran colón */
SVC = 'SVC',
/** Syrian pound */
SYP = 'SYP',
/** Swazi lilangeni */
SZL = 'SZL',
/** Thai baht */
THB = 'THB',
/** Tajikistani somoni */
TJS = 'TJS',
/** Turkmenistan manat */
TMT = 'TMT',
/** Tunisian dinar */
TND = 'TND',
/** Tongan paʻanga */
TOP = 'TOP',
/** Turkish lira */
TRY = 'TRY',
/** Trinidad and Tobago dollar */
TTD = 'TTD',
/** New Taiwan dollar */
TWD = 'TWD',
/** Tanzanian shilling */
TZS = 'TZS',
/** Ukrainian hryvnia */
UAH = 'UAH',
/** Ugandan shilling */
UGX = 'UGX',
/** United States dollar */
USD = 'USD',
/** Uruguayan peso */
UYU = 'UYU',
/** Uzbekistan som */
UZS = 'UZS',
/** Venezuelan bolívar soberano */
VES = 'VES',
/** Vietnamese đồng */
VND = 'VND',
/** Vanuatu vatu */
VUV = 'VUV',
/** Samoan tala */
WST = 'WST',
/** CFA franc BEAC */
XAF = 'XAF',
/** East Caribbean dollar */
XCD = 'XCD',
/** CFA franc BCEAO */
XOF = 'XOF',
/** CFP franc (franc Pacifique) */
XPF = 'XPF',
/** Yemeni rial */
YER = 'YER',
/** South African rand */
ZAR = 'ZAR',
/** Zambian kwacha */
ZMW = 'ZMW',
/** Zimbabwean dollar */
ZWL = 'ZWL',
}
export type CurrentUser = {
__typename?: 'CurrentUser';
channels: Array<CurrentUserChannel>;
id: Scalars['ID']['output'];
identifier: Scalars['String']['output'];
};
export type CurrentUserChannel = {
__typename?: 'CurrentUserChannel';
code: Scalars['String']['output'];
id: Scalars['ID']['output'];
permissions: Array<Permission>;
token: Scalars['String']['output'];
};
export type CustomField = {
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type CustomFieldConfig =
| BooleanCustomFieldConfig
| DateTimeCustomFieldConfig
| FloatCustomFieldConfig
| IntCustomFieldConfig
| LocaleStringCustomFieldConfig
| LocaleTextCustomFieldConfig
| RelationCustomFieldConfig
| StringCustomFieldConfig
| TextCustomFieldConfig;
export type CustomFields = {
__typename?: 'CustomFields';
Address: Array<CustomFieldConfig>;
Administrator: Array<CustomFieldConfig>;
Asset: Array<CustomFieldConfig>;
Channel: Array<CustomFieldConfig>;
Collection: Array<CustomFieldConfig>;
Customer: Array<CustomFieldConfig>;
CustomerGroup: Array<CustomFieldConfig>;
Facet: Array<CustomFieldConfig>;
FacetValue: Array<CustomFieldConfig>;
Fulfillment: Array<CustomFieldConfig>;
GlobalSettings: Array<CustomFieldConfig>;
Order: Array<CustomFieldConfig>;
OrderLine: Array<CustomFieldConfig>;
PaymentMethod: Array<CustomFieldConfig>;
Product: Array<CustomFieldConfig>;
ProductOption: Array<CustomFieldConfig>;
ProductOptionGroup: Array<CustomFieldConfig>;
ProductVariant: Array<CustomFieldConfig>;
Promotion: Array<CustomFieldConfig>;
Region: Array<CustomFieldConfig>;
Seller: Array<CustomFieldConfig>;
ShippingMethod: Array<CustomFieldConfig>;
StockLocation: Array<CustomFieldConfig>;
TaxCategory: Array<CustomFieldConfig>;
TaxRate: Array<CustomFieldConfig>;
User: Array<CustomFieldConfig>;
Zone: Array<CustomFieldConfig>;
};
export type Customer = Node & {
__typename?: 'Customer';
addresses?: Maybe<Array<Address>>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
emailAddress: Scalars['String']['output'];
firstName: Scalars['String']['output'];
groups: Array<CustomerGroup>;
history: HistoryEntryList;
id: Scalars['ID']['output'];
lastName: Scalars['String']['output'];
orders: OrderList;
phoneNumber?: Maybe<Scalars['String']['output']>;
title?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
user?: Maybe<User>;
};
export type CustomerHistoryArgs = {
options?: InputMaybe<HistoryEntryListOptions>;
};
export type CustomerOrdersArgs = {
options?: InputMaybe<OrderListOptions>;
};
export type CustomerFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
emailAddress?: InputMaybe<StringOperators>;
firstName?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
lastName?: InputMaybe<StringOperators>;
phoneNumber?: InputMaybe<StringOperators>;
postalCode?: InputMaybe<StringOperators>;
title?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CustomerGroup = Node & {
__typename?: 'CustomerGroup';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
customers: CustomerList;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type CustomerGroupCustomersArgs = {
options?: InputMaybe<CustomerListOptions>;
};
export type CustomerGroupFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CustomerGroupList = PaginatedList & {
__typename?: 'CustomerGroupList';
items: Array<CustomerGroup>;
totalItems: Scalars['Int']['output'];
};
export type CustomerGroupListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CustomerGroupFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CustomerGroupSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type CustomerGroupSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type CustomerList = PaginatedList & {
__typename?: 'CustomerList';
items: Array<Customer>;
totalItems: Scalars['Int']['output'];
};
export type CustomerListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CustomerFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CustomerSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type CustomerSortParameter = {
createdAt?: InputMaybe<SortOrder>;
emailAddress?: InputMaybe<SortOrder>;
firstName?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
lastName?: InputMaybe<SortOrder>;
phoneNumber?: InputMaybe<SortOrder>;
title?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
/** Operators for filtering on a list of Date fields */
export type DateListOperators = {
inList: Scalars['DateTime']['input'];
};
/** Operators for filtering on a DateTime field */
export type DateOperators = {
after?: InputMaybe<Scalars['DateTime']['input']>;
before?: InputMaybe<Scalars['DateTime']['input']>;
between?: InputMaybe<DateRange>;
eq?: InputMaybe<Scalars['DateTime']['input']>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
};
export type DateRange = {
end: Scalars['DateTime']['input'];
start: Scalars['DateTime']['input'];
};
/**
* Expects the same validation formats as the `<input type="datetime-local">` HTML element.
* See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes
*/
export type DateTimeCustomFieldConfig = CustomField & {
__typename?: 'DateTimeCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['String']['output']>;
min?: Maybe<Scalars['String']['output']>;
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
step?: Maybe<Scalars['Int']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type DeleteAssetInput = {
assetId: Scalars['ID']['input'];
deleteFromAllChannels?: InputMaybe<Scalars['Boolean']['input']>;
force?: InputMaybe<Scalars['Boolean']['input']>;
};
export type DeleteAssetsInput = {
assetIds: Array<Scalars['ID']['input']>;
deleteFromAllChannels?: InputMaybe<Scalars['Boolean']['input']>;
force?: InputMaybe<Scalars['Boolean']['input']>;
};
export type DeleteStockLocationInput = {
id: Scalars['ID']['input'];
transferToLocationId?: InputMaybe<Scalars['ID']['input']>;
};
export type DeletionResponse = {
__typename?: 'DeletionResponse';
message?: Maybe<Scalars['String']['output']>;
result: DeletionResult;
};
export enum DeletionResult {
/** The entity was successfully deleted */
DELETED = 'DELETED',
/** Deletion did not take place, reason given in message */
NOT_DELETED = 'NOT_DELETED',
}
export type Discount = {
__typename?: 'Discount';
adjustmentSource: Scalars['String']['output'];
amount: Scalars['Money']['output'];
amountWithTax: Scalars['Money']['output'];
description: Scalars['String']['output'];
type: AdjustmentType;
};
/** Returned when attempting to create a Customer with an email address already registered to an existing User. */
export type EmailAddressConflictError = ErrorResult & {
__typename?: 'EmailAddressConflictError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if no OrderLines have been specified for the operation */
export type EmptyOrderLineSelectionError = ErrorResult & {
__typename?: 'EmptyOrderLineSelectionError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export enum ErrorCode {
ALREADY_REFUNDED_ERROR = 'ALREADY_REFUNDED_ERROR',
CANCEL_ACTIVE_ORDER_ERROR = 'CANCEL_ACTIVE_ORDER_ERROR',
CANCEL_PAYMENT_ERROR = 'CANCEL_PAYMENT_ERROR',
CHANNEL_DEFAULT_LANGUAGE_ERROR = 'CHANNEL_DEFAULT_LANGUAGE_ERROR',
COUPON_CODE_EXPIRED_ERROR = 'COUPON_CODE_EXPIRED_ERROR',
COUPON_CODE_INVALID_ERROR = 'COUPON_CODE_INVALID_ERROR',
COUPON_CODE_LIMIT_ERROR = 'COUPON_CODE_LIMIT_ERROR',
CREATE_FULFILLMENT_ERROR = 'CREATE_FULFILLMENT_ERROR',
EMAIL_ADDRESS_CONFLICT_ERROR = 'EMAIL_ADDRESS_CONFLICT_ERROR',
EMPTY_ORDER_LINE_SELECTION_ERROR = 'EMPTY_ORDER_LINE_SELECTION_ERROR',
FACET_IN_USE_ERROR = 'FACET_IN_USE_ERROR',
FULFILLMENT_STATE_TRANSITION_ERROR = 'FULFILLMENT_STATE_TRANSITION_ERROR',
GUEST_CHECKOUT_ERROR = 'GUEST_CHECKOUT_ERROR',
INELIGIBLE_SHIPPING_METHOD_ERROR = 'INELIGIBLE_SHIPPING_METHOD_ERROR',
INSUFFICIENT_STOCK_ERROR = 'INSUFFICIENT_STOCK_ERROR',
INSUFFICIENT_STOCK_ON_HAND_ERROR = 'INSUFFICIENT_STOCK_ON_HAND_ERROR',
INVALID_CREDENTIALS_ERROR = 'INVALID_CREDENTIALS_ERROR',
INVALID_FULFILLMENT_HANDLER_ERROR = 'INVALID_FULFILLMENT_HANDLER_ERROR',
ITEMS_ALREADY_FULFILLED_ERROR = 'ITEMS_ALREADY_FULFILLED_ERROR',
LANGUAGE_NOT_AVAILABLE_ERROR = 'LANGUAGE_NOT_AVAILABLE_ERROR',
MANUAL_PAYMENT_STATE_ERROR = 'MANUAL_PAYMENT_STATE_ERROR',
MIME_TYPE_ERROR = 'MIME_TYPE_ERROR',
MISSING_CONDITIONS_ERROR = 'MISSING_CONDITIONS_ERROR',
MULTIPLE_ORDER_ERROR = 'MULTIPLE_ORDER_ERROR',
NATIVE_AUTH_STRATEGY_ERROR = 'NATIVE_AUTH_STRATEGY_ERROR',
NEGATIVE_QUANTITY_ERROR = 'NEGATIVE_QUANTITY_ERROR',
NOTHING_TO_REFUND_ERROR = 'NOTHING_TO_REFUND_ERROR',
NO_ACTIVE_ORDER_ERROR = 'NO_ACTIVE_ORDER_ERROR',
NO_CHANGES_SPECIFIED_ERROR = 'NO_CHANGES_SPECIFIED_ERROR',
ORDER_LIMIT_ERROR = 'ORDER_LIMIT_ERROR',
ORDER_MODIFICATION_ERROR = 'ORDER_MODIFICATION_ERROR',
ORDER_MODIFICATION_STATE_ERROR = 'ORDER_MODIFICATION_STATE_ERROR',
ORDER_STATE_TRANSITION_ERROR = 'ORDER_STATE_TRANSITION_ERROR',
PAYMENT_METHOD_MISSING_ERROR = 'PAYMENT_METHOD_MISSING_ERROR',
PAYMENT_ORDER_MISMATCH_ERROR = 'PAYMENT_ORDER_MISMATCH_ERROR',
PAYMENT_STATE_TRANSITION_ERROR = 'PAYMENT_STATE_TRANSITION_ERROR',
PRODUCT_OPTION_IN_USE_ERROR = 'PRODUCT_OPTION_IN_USE_ERROR',
QUANTITY_TOO_GREAT_ERROR = 'QUANTITY_TOO_GREAT_ERROR',
REFUND_ORDER_STATE_ERROR = 'REFUND_ORDER_STATE_ERROR',
REFUND_PAYMENT_ID_MISSING_ERROR = 'REFUND_PAYMENT_ID_MISSING_ERROR',
REFUND_STATE_TRANSITION_ERROR = 'REFUND_STATE_TRANSITION_ERROR',
SETTLE_PAYMENT_ERROR = 'SETTLE_PAYMENT_ERROR',
UNKNOWN_ERROR = 'UNKNOWN_ERROR',
}
export type ErrorResult = {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Facet = Node & {
__typename?: 'Facet';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
isPrivate: Scalars['Boolean']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<FacetTranslation>;
updatedAt: Scalars['DateTime']['output'];
values: Array<FacetValue>;
};
export type FacetFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
isPrivate?: InputMaybe<BooleanOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type FacetInUseError = ErrorResult & {
__typename?: 'FacetInUseError';
errorCode: ErrorCode;
facetCode: Scalars['String']['output'];
message: Scalars['String']['output'];
productCount: Scalars['Int']['output'];
variantCount: Scalars['Int']['output'];
};
export type FacetList = PaginatedList & {
__typename?: 'FacetList';
items: Array<Facet>;
totalItems: Scalars['Int']['output'];
};
export type FacetListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<FacetFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<FacetSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type FacetSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type FacetTranslation = {
__typename?: 'FacetTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type FacetTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type FacetValue = Node & {
__typename?: 'FacetValue';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
facet: Facet;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<FacetValueTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
/**
* Used to construct boolean expressions for filtering search results
* by FacetValue ID. Examples:
*
* * ID=1 OR ID=2: `{ facetValueFilters: [{ or: [1,2] }] }`
* * ID=1 AND ID=2: `{ facetValueFilters: [{ and: 1 }, { and: 2 }] }`
* * ID=1 AND (ID=2 OR ID=3): `{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }`
*/
export type FacetValueFilterInput = {
and?: InputMaybe<Scalars['ID']['input']>;
or?: InputMaybe<Array<Scalars['ID']['input']>>;
};
export type FacetValueFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type FacetValueList = PaginatedList & {
__typename?: 'FacetValueList';
items: Array<FacetValue>;
totalItems: Scalars['Int']['output'];
};
export type FacetValueListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<FacetValueFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<FacetValueSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
/**
* Which FacetValues are present in the products returned
* by the search, and in what quantity.
*/
export type FacetValueResult = {
__typename?: 'FacetValueResult';
count: Scalars['Int']['output'];
facetValue: FacetValue;
};
export type FacetValueSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type FacetValueTranslation = {
__typename?: 'FacetValueTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type FacetValueTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type FloatCustomFieldConfig = CustomField & {
__typename?: 'FloatCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['Float']['output']>;
min?: Maybe<Scalars['Float']['output']>;
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
step?: Maybe<Scalars['Float']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type FulfillOrderInput = {
handler: ConfigurableOperationInput;
lines: Array<OrderLineInput>;
};
export type Fulfillment = Node & {
__typename?: 'Fulfillment';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
lines: Array<FulfillmentLine>;
method: Scalars['String']['output'];
nextStates: Array<Scalars['String']['output']>;
state: Scalars['String']['output'];
/** @deprecated Use the `lines` field instead */
summary: Array<FulfillmentLine>;
trackingCode?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type FulfillmentLine = {
__typename?: 'FulfillmentLine';
fulfillment: Fulfillment;
fulfillmentId: Scalars['ID']['output'];
orderLine: OrderLine;
orderLineId: Scalars['ID']['output'];
quantity: Scalars['Int']['output'];
};
/** Returned when there is an error in transitioning the Fulfillment state */
export type FulfillmentStateTransitionError = ErrorResult & {
__typename?: 'FulfillmentStateTransitionError';
errorCode: ErrorCode;
fromState: Scalars['String']['output'];
message: Scalars['String']['output'];
toState: Scalars['String']['output'];
transitionError: Scalars['String']['output'];
};
export enum GlobalFlag {
FALSE = 'FALSE',
INHERIT = 'INHERIT',
TRUE = 'TRUE',
}
export type GlobalSettings = {
__typename?: 'GlobalSettings';
availableLanguages: Array<LanguageCode>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
outOfStockThreshold: Scalars['Int']['output'];
serverConfig: ServerConfig;
trackInventory: Scalars['Boolean']['output'];
updatedAt: Scalars['DateTime']['output'];
};
/** Returned when attempting to set the Customer on a guest checkout when the configured GuestCheckoutStrategy does not allow it. */
export type GuestCheckoutError = ErrorResult & {
__typename?: 'GuestCheckoutError';
errorCode: ErrorCode;
errorDetail: Scalars['String']['output'];
message: Scalars['String']['output'];
};
export type HistoryEntry = Node & {
__typename?: 'HistoryEntry';
administrator?: Maybe<Administrator>;
createdAt: Scalars['DateTime']['output'];
data: Scalars['JSON']['output'];
id: Scalars['ID']['output'];
isPublic: Scalars['Boolean']['output'];
type: HistoryEntryType;
updatedAt: Scalars['DateTime']['output'];
};
export type HistoryEntryFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
isPublic?: InputMaybe<BooleanOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type HistoryEntryList = PaginatedList & {
__typename?: 'HistoryEntryList';
items: Array<HistoryEntry>;
totalItems: Scalars['Int']['output'];
};
export type HistoryEntryListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<HistoryEntryFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<HistoryEntrySortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type HistoryEntrySortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export enum HistoryEntryType {
CUSTOMER_ADDED_TO_GROUP = 'CUSTOMER_ADDED_TO_GROUP',
CUSTOMER_ADDRESS_CREATED = 'CUSTOMER_ADDRESS_CREATED',
CUSTOMER_ADDRESS_DELETED = 'CUSTOMER_ADDRESS_DELETED',
CUSTOMER_ADDRESS_UPDATED = 'CUSTOMER_ADDRESS_UPDATED',
CUSTOMER_DETAIL_UPDATED = 'CUSTOMER_DETAIL_UPDATED',
CUSTOMER_EMAIL_UPDATE_REQUESTED = 'CUSTOMER_EMAIL_UPDATE_REQUESTED',
CUSTOMER_EMAIL_UPDATE_VERIFIED = 'CUSTOMER_EMAIL_UPDATE_VERIFIED',
CUSTOMER_NOTE = 'CUSTOMER_NOTE',
CUSTOMER_PASSWORD_RESET_REQUESTED = 'CUSTOMER_PASSWORD_RESET_REQUESTED',
CUSTOMER_PASSWORD_RESET_VERIFIED = 'CUSTOMER_PASSWORD_RESET_VERIFIED',
CUSTOMER_PASSWORD_UPDATED = 'CUSTOMER_PASSWORD_UPDATED',
CUSTOMER_REGISTERED = 'CUSTOMER_REGISTERED',
CUSTOMER_REMOVED_FROM_GROUP = 'CUSTOMER_REMOVED_FROM_GROUP',
CUSTOMER_VERIFIED = 'CUSTOMER_VERIFIED',
ORDER_CANCELLATION = 'ORDER_CANCELLATION',
ORDER_COUPON_APPLIED = 'ORDER_COUPON_APPLIED',
ORDER_COUPON_REMOVED = 'ORDER_COUPON_REMOVED',
ORDER_FULFILLMENT = 'ORDER_FULFILLMENT',
ORDER_FULFILLMENT_TRANSITION = 'ORDER_FULFILLMENT_TRANSITION',
ORDER_MODIFIED = 'ORDER_MODIFIED',
ORDER_NOTE = 'ORDER_NOTE',
ORDER_PAYMENT_TRANSITION = 'ORDER_PAYMENT_TRANSITION',
ORDER_REFUND_TRANSITION = 'ORDER_REFUND_TRANSITION',
ORDER_STATE_TRANSITION = 'ORDER_STATE_TRANSITION',
}
/** Operators for filtering on a list of ID fields */
export type IdListOperators = {
inList: Scalars['ID']['input'];
};
/** Operators for filtering on an ID field */
export type IdOperators = {
eq?: InputMaybe<Scalars['String']['input']>;
in?: InputMaybe<Array<Scalars['String']['input']>>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
notEq?: InputMaybe<Scalars['String']['input']>;
notIn?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type ImportInfo = {
__typename?: 'ImportInfo';
errors?: Maybe<Array<Scalars['String']['output']>>;
imported: Scalars['Int']['output'];
processed: Scalars['Int']['output'];
};
/** Returned when attempting to set a ShippingMethod for which the Order is not eligible */
export type IneligibleShippingMethodError = ErrorResult & {
__typename?: 'IneligibleShippingMethodError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when attempting to add more items to the Order than are available */
export type InsufficientStockError = ErrorResult & {
__typename?: 'InsufficientStockError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
order: Order;
quantityAvailable: Scalars['Int']['output'];
};
/**
* Returned if attempting to create a Fulfillment when there is insufficient
* stockOnHand of a ProductVariant to satisfy the requested quantity.
*/
export type InsufficientStockOnHandError = ErrorResult & {
__typename?: 'InsufficientStockOnHandError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
productVariantId: Scalars['ID']['output'];
productVariantName: Scalars['String']['output'];
stockOnHand: Scalars['Int']['output'];
};
export type IntCustomFieldConfig = CustomField & {
__typename?: 'IntCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['Int']['output']>;
min?: Maybe<Scalars['Int']['output']>;
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
step?: Maybe<Scalars['Int']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
/** Returned if the user authentication credentials are not valid */
export type InvalidCredentialsError = ErrorResult & {
__typename?: 'InvalidCredentialsError';
authenticationError: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the specified FulfillmentHandler code is not valid */
export type InvalidFulfillmentHandlerError = ErrorResult & {
__typename?: 'InvalidFulfillmentHandlerError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the specified items are already part of a Fulfillment */
export type ItemsAlreadyFulfilledError = ErrorResult & {
__typename?: 'ItemsAlreadyFulfilledError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Job = Node & {
__typename?: 'Job';
attempts: Scalars['Int']['output'];
createdAt: Scalars['DateTime']['output'];
data?: Maybe<Scalars['JSON']['output']>;
duration: Scalars['Int']['output'];
error?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
isSettled: Scalars['Boolean']['output'];
progress: Scalars['Float']['output'];
queueName: Scalars['String']['output'];
result?: Maybe<Scalars['JSON']['output']>;
retries: Scalars['Int']['output'];
settledAt?: Maybe<Scalars['DateTime']['output']>;
startedAt?: Maybe<Scalars['DateTime']['output']>;
state: JobState;
};
export type JobBufferSize = {
__typename?: 'JobBufferSize';
bufferId: Scalars['String']['output'];
size: Scalars['Int']['output'];
};
export type JobFilterParameter = {
attempts?: InputMaybe<NumberOperators>;
createdAt?: InputMaybe<DateOperators>;
duration?: InputMaybe<NumberOperators>;
id?: InputMaybe<IdOperators>;
isSettled?: InputMaybe<BooleanOperators>;
progress?: InputMaybe<NumberOperators>;
queueName?: InputMaybe<StringOperators>;
retries?: InputMaybe<NumberOperators>;
settledAt?: InputMaybe<DateOperators>;
startedAt?: InputMaybe<DateOperators>;
state?: InputMaybe<StringOperators>;
};
export type JobList = PaginatedList & {
__typename?: 'JobList';
items: Array<Job>;
totalItems: Scalars['Int']['output'];
};
export type JobListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<JobFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<JobSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type JobQueue = {
__typename?: 'JobQueue';
name: Scalars['String']['output'];
running: Scalars['Boolean']['output'];
};
export type JobSortParameter = {
attempts?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
duration?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
progress?: InputMaybe<SortOrder>;
queueName?: InputMaybe<SortOrder>;
retries?: InputMaybe<SortOrder>;
settledAt?: InputMaybe<SortOrder>;
startedAt?: InputMaybe<SortOrder>;
};
/**
* @description
* The state of a Job in the JobQueue
*
* @docsCategory common
*/
export enum JobState {
CANCELLED = 'CANCELLED',
COMPLETED = 'COMPLETED',
FAILED = 'FAILED',
PENDING = 'PENDING',
RETRYING = 'RETRYING',
RUNNING = 'RUNNING',
}
/**
* @description
* Languages in the form of a ISO 639-1 language code with optional
* region or script modifier (e.g. de_AT). The selection available is based
* on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)
* and includes the major spoken languages of the world and any widely-used variants.
*
* @docsCategory common
*/
export enum LanguageCode {
/** Afrikaans */
af = 'af',
/** Akan */
ak = 'ak',
/** Amharic */
am = 'am',
/** Arabic */
ar = 'ar',
/** Assamese */
as = 'as',
/** Azerbaijani */
az = 'az',
/** Belarusian */
be = 'be',
/** Bulgarian */
bg = 'bg',
/** Bambara */
bm = 'bm',
/** Bangla */
bn = 'bn',
/** Tibetan */
bo = 'bo',
/** Breton */
br = 'br',
/** Bosnian */
bs = 'bs',
/** Catalan */
ca = 'ca',
/** Chechen */
ce = 'ce',
/** Corsican */
co = 'co',
/** Czech */
cs = 'cs',
/** Church Slavic */
cu = 'cu',
/** Welsh */
cy = 'cy',
/** Danish */
da = 'da',
/** German */
de = 'de',
/** Austrian German */
de_AT = 'de_AT',
/** Swiss High German */
de_CH = 'de_CH',
/** Dzongkha */
dz = 'dz',
/** Ewe */
ee = 'ee',
/** Greek */
el = 'el',
/** English */
en = 'en',
/** Australian English */
en_AU = 'en_AU',
/** Canadian English */
en_CA = 'en_CA',
/** British English */
en_GB = 'en_GB',
/** American English */
en_US = 'en_US',
/** Esperanto */
eo = 'eo',
/** Spanish */
es = 'es',
/** European Spanish */
es_ES = 'es_ES',
/** Mexican Spanish */
es_MX = 'es_MX',
/** Estonian */
et = 'et',
/** Basque */
eu = 'eu',
/** Persian */
fa = 'fa',
/** Dari */
fa_AF = 'fa_AF',
/** Fulah */
ff = 'ff',
/** Finnish */
fi = 'fi',
/** Faroese */
fo = 'fo',
/** French */
fr = 'fr',
/** Canadian French */
fr_CA = 'fr_CA',
/** Swiss French */
fr_CH = 'fr_CH',
/** Western Frisian */
fy = 'fy',
/** Irish */
ga = 'ga',
/** Scottish Gaelic */
gd = 'gd',
/** Galician */
gl = 'gl',
/** Gujarati */
gu = 'gu',
/** Manx */
gv = 'gv',
/** Hausa */
ha = 'ha',
/** Hebrew */
he = 'he',
/** Hindi */
hi = 'hi',
/** Croatian */
hr = 'hr',
/** Haitian Creole */
ht = 'ht',
/** Hungarian */
hu = 'hu',
/** Armenian */
hy = 'hy',
/** Interlingua */
ia = 'ia',
/** Indonesian */
id = 'id',
/** Igbo */
ig = 'ig',
/** Sichuan Yi */
ii = 'ii',
/** Icelandic */
is = 'is',
/** Italian */
it = 'it',
/** Japanese */
ja = 'ja',
/** Javanese */
jv = 'jv',
/** Georgian */
ka = 'ka',
/** Kikuyu */
ki = 'ki',
/** Kazakh */
kk = 'kk',
/** Kalaallisut */
kl = 'kl',
/** Khmer */
km = 'km',
/** Kannada */
kn = 'kn',
/** Korean */
ko = 'ko',
/** Kashmiri */
ks = 'ks',
/** Kurdish */
ku = 'ku',
/** Cornish */
kw = 'kw',
/** Kyrgyz */
ky = 'ky',
/** Latin */
la = 'la',
/** Luxembourgish */
lb = 'lb',
/** Ganda */
lg = 'lg',
/** Lingala */
ln = 'ln',
/** Lao */
lo = 'lo',
/** Lithuanian */
lt = 'lt',
/** Luba-Katanga */
lu = 'lu',
/** Latvian */
lv = 'lv',
/** Malagasy */
mg = 'mg',
/** Maori */
mi = 'mi',
/** Macedonian */
mk = 'mk',
/** Malayalam */
ml = 'ml',
/** Mongolian */
mn = 'mn',
/** Marathi */
mr = 'mr',
/** Malay */
ms = 'ms',
/** Maltese */
mt = 'mt',
/** Burmese */
my = 'my',
/** Norwegian Bokmål */
nb = 'nb',
/** North Ndebele */
nd = 'nd',
/** Nepali */
ne = 'ne',
/** Dutch */
nl = 'nl',
/** Flemish */
nl_BE = 'nl_BE',
/** Norwegian Nynorsk */
nn = 'nn',
/** Nyanja */
ny = 'ny',
/** Oromo */
om = 'om',
/** Odia */
or = 'or',
/** Ossetic */
os = 'os',
/** Punjabi */
pa = 'pa',
/** Polish */
pl = 'pl',
/** Pashto */
ps = 'ps',
/** Portuguese */
pt = 'pt',
/** Brazilian Portuguese */
pt_BR = 'pt_BR',
/** European Portuguese */
pt_PT = 'pt_PT',
/** Quechua */
qu = 'qu',
/** Romansh */
rm = 'rm',
/** Rundi */
rn = 'rn',
/** Romanian */
ro = 'ro',
/** Moldavian */
ro_MD = 'ro_MD',
/** Russian */
ru = 'ru',
/** Kinyarwanda */
rw = 'rw',
/** Sanskrit */
sa = 'sa',
/** Sindhi */
sd = 'sd',
/** Northern Sami */
se = 'se',
/** Sango */
sg = 'sg',
/** Sinhala */
si = 'si',
/** Slovak */
sk = 'sk',
/** Slovenian */
sl = 'sl',
/** Samoan */
sm = 'sm',
/** Shona */
sn = 'sn',
/** Somali */
so = 'so',
/** Albanian */
sq = 'sq',
/** Serbian */
sr = 'sr',
/** Southern Sotho */
st = 'st',
/** Sundanese */
su = 'su',
/** Swedish */
sv = 'sv',
/** Swahili */
sw = 'sw',
/** Congo Swahili */
sw_CD = 'sw_CD',
/** Tamil */
ta = 'ta',
/** Telugu */
te = 'te',
/** Tajik */
tg = 'tg',
/** Thai */
th = 'th',
/** Tigrinya */
ti = 'ti',
/** Turkmen */
tk = 'tk',
/** Tongan */
to = 'to',
/** Turkish */
tr = 'tr',
/** Tatar */
tt = 'tt',
/** Uyghur */
ug = 'ug',
/** Ukrainian */
uk = 'uk',
/** Urdu */
ur = 'ur',
/** Uzbek */
uz = 'uz',
/** Vietnamese */
vi = 'vi',
/** Volapük */
vo = 'vo',
/** Wolof */
wo = 'wo',
/** Xhosa */
xh = 'xh',
/** Yiddish */
yi = 'yi',
/** Yoruba */
yo = 'yo',
/** Chinese */
zh = 'zh',
/** Simplified Chinese */
zh_Hans = 'zh_Hans',
/** Traditional Chinese */
zh_Hant = 'zh_Hant',
/** Zulu */
zu = 'zu',
}
/** Returned if attempting to set a Channel's defaultLanguageCode to a language which is not enabled in GlobalSettings */
export type LanguageNotAvailableError = ErrorResult & {
__typename?: 'LanguageNotAvailableError';
errorCode: ErrorCode;
languageCode: Scalars['String']['output'];
message: Scalars['String']['output'];
};
export type LocaleStringCustomFieldConfig = CustomField & {
__typename?: 'LocaleStringCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
length?: Maybe<Scalars['Int']['output']>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
pattern?: Maybe<Scalars['String']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type LocaleTextCustomFieldConfig = CustomField & {
__typename?: 'LocaleTextCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type LocalizedString = {
__typename?: 'LocalizedString';
languageCode: LanguageCode;
value: Scalars['String']['output'];
};
export enum LogicalOperator {
AND = 'AND',
OR = 'OR',
}
export type ManualPaymentInput = {
metadata?: InputMaybe<Scalars['JSON']['input']>;
method: Scalars['String']['input'];
orderId: Scalars['ID']['input'];
transactionId?: InputMaybe<Scalars['String']['input']>;
};
/**
* Returned when a call to addManualPaymentToOrder is made but the Order
* is not in the required state.
*/
export type ManualPaymentStateError = ErrorResult & {
__typename?: 'ManualPaymentStateError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export enum MetricInterval {
Daily = 'Daily',
}
export type MetricSummary = {
__typename?: 'MetricSummary';
entries: Array<MetricSummaryEntry>;
interval: MetricInterval;
title: Scalars['String']['output'];
type: MetricType;
};
export type MetricSummaryEntry = {
__typename?: 'MetricSummaryEntry';
label: Scalars['String']['output'];
value: Scalars['Float']['output'];
};
export type MetricSummaryInput = {
interval: MetricInterval;
refresh?: InputMaybe<Scalars['Boolean']['input']>;
types: Array<MetricType>;
};
export enum MetricType {
AverageOrderValue = 'AverageOrderValue',
OrderCount = 'OrderCount',
OrderTotal = 'OrderTotal',
}
export type MimeTypeError = ErrorResult & {
__typename?: 'MimeTypeError';
errorCode: ErrorCode;
fileName: Scalars['String']['output'];
message: Scalars['String']['output'];
mimeType: Scalars['String']['output'];
};
/** Returned if a PromotionCondition has neither a couponCode nor any conditions set */
export type MissingConditionsError = ErrorResult & {
__typename?: 'MissingConditionsError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type ModifyOrderInput = {
addItems?: InputMaybe<Array<AddItemInput>>;
adjustOrderLines?: InputMaybe<Array<OrderLineInput>>;
couponCodes?: InputMaybe<Array<Scalars['String']['input']>>;
dryRun: Scalars['Boolean']['input'];
note?: InputMaybe<Scalars['String']['input']>;
options?: InputMaybe<ModifyOrderOptions>;
orderId: Scalars['ID']['input'];
refund?: InputMaybe<AdministratorRefundInput>;
surcharges?: InputMaybe<Array<SurchargeInput>>;
updateBillingAddress?: InputMaybe<UpdateOrderAddressInput>;
updateShippingAddress?: InputMaybe<UpdateOrderAddressInput>;
};
export type ModifyOrderOptions = {
freezePromotions?: InputMaybe<Scalars['Boolean']['input']>;
recalculateShipping?: InputMaybe<Scalars['Boolean']['input']>;
};
export type ModifyOrderResult =
| CouponCodeExpiredError
| CouponCodeInvalidError
| CouponCodeLimitError
| InsufficientStockError
| NegativeQuantityError
| NoChangesSpecifiedError
| Order
| OrderLimitError
| OrderModificationStateError
| PaymentMethodMissingError
| RefundPaymentIdMissingError;
export type MoveCollectionInput = {
collectionId: Scalars['ID']['input'];
index: Scalars['Int']['input'];
parentId: Scalars['ID']['input'];
};
/** Returned if an operation has specified OrderLines from multiple Orders */
export type MultipleOrderError = ErrorResult & {
__typename?: 'MultipleOrderError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Mutation = {
__typename?: 'Mutation';
/** Add Customers to a CustomerGroup */
addCustomersToGroup: CustomerGroup;
addFulfillmentToOrder: AddFulfillmentToOrderResult;
/** Adds an item to the draft Order. */
addItemToDraftOrder: UpdateOrderItemsResult;
/**
* Used to manually create a new Payment against an Order.
* This can be used by an Administrator when an Order is in the ArrangingPayment state.
*
* It is also used when a completed Order
* has been modified (using `modifyOrder`) and the price has increased. The extra payment
* can then be manually arranged by the administrator, and the details used to create a new
* Payment.
*/
addManualPaymentToOrder: AddManualPaymentToOrderResult;
/** Add members to a Zone */
addMembersToZone: Zone;
addNoteToCustomer: Customer;
addNoteToOrder: Order;
/** Add an OptionGroup to a Product */
addOptionGroupToProduct: Product;
/** Adjusts a draft OrderLine. If custom fields are defined on the OrderLine entity, a third argument 'customFields' of type `OrderLineCustomFieldsInput` will be available. */
adjustDraftOrderLine: UpdateOrderItemsResult;
/** Applies the given coupon code to the draft Order */
applyCouponCodeToDraftOrder: ApplyCouponCodeResult;
approveProductReview?: Maybe<ProductReview>;
/** Assign assets to channel */
assignAssetsToChannel: Array<Asset>;
/** Assigns Collections to the specified Channel */
assignCollectionsToChannel: Array<Collection>;
/** Assigns Facets to the specified Channel */
assignFacetsToChannel: Array<Facet>;
/** Assigns PaymentMethods to the specified Channel */
assignPaymentMethodsToChannel: Array<PaymentMethod>;
/** Assigns ProductVariants to the specified Channel */
assignProductVariantsToChannel: Array<ProductVariant>;
/** Assigns all ProductVariants of Product to the specified Channel */
assignProductsToChannel: Array<Product>;
/** Assigns Promotions to the specified Channel */
assignPromotionsToChannel: Array<Promotion>;
/** Assign a Role to an Administrator */
assignRoleToAdministrator: Administrator;
/** Assigns ShippingMethods to the specified Channel */
assignShippingMethodsToChannel: Array<ShippingMethod>;
/** Assigns StockLocations to the specified Channel */
assignStockLocationsToChannel: Array<StockLocation>;
/** Authenticates the user using a named authentication strategy */
authenticate: AuthenticationResult;
cancelJob: Job;
cancelOrder: CancelOrderResult;
cancelPayment: CancelPaymentResult;
/** Create a new Administrator */
createAdministrator: Administrator;
/** Create a new Asset */
createAssets: Array<CreateAssetResult>;
/** Create a new Channel */
createChannel: CreateChannelResult;
/** Create a new Collection */
createCollection: Collection;
/** Create a new Country */
createCountry: Country;
/** Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer. */
createCustomer: CreateCustomerResult;
/** Create a new Address and associate it with the Customer specified by customerId */
createCustomerAddress: Address;
/** Create a new CustomerGroup */
createCustomerGroup: CustomerGroup;
/** Creates a draft Order */
createDraftOrder: Order;
/** Create a new Facet */
createFacet: Facet;
/** Create one or more FacetValues */
createFacetValues: Array<FacetValue>;
/** Create existing PaymentMethod */
createPaymentMethod: PaymentMethod;
/** Create a new Product */
createProduct: Product;
/** Create a new ProductOption within a ProductOptionGroup */
createProductOption: ProductOption;
/** Create a new ProductOptionGroup */
createProductOptionGroup: ProductOptionGroup;
/** Create a set of ProductVariants based on the OptionGroups assigned to the given Product */
createProductVariants: Array<Maybe<ProductVariant>>;
createPromotion: CreatePromotionResult;
/** Create a new Province */
createProvince: Province;
/** Create a new Role */
createRole: Role;
/** Create a new Seller */
createSeller: Seller;
/** Create a new ShippingMethod */
createShippingMethod: ShippingMethod;
createStockLocation: StockLocation;
/** Create a new Tag */
createTag: Tag;
/** Create a new TaxCategory */
createTaxCategory: TaxCategory;
/** Create a new TaxRate */
createTaxRate: TaxRate;
/** Create a new Zone */
createZone: Zone;
/** Delete an Administrator */
deleteAdministrator: DeletionResponse;
/** Delete multiple Administrators */
deleteAdministrators: Array<DeletionResponse>;
/** Delete an Asset */
deleteAsset: DeletionResponse;
/** Delete multiple Assets */
deleteAssets: DeletionResponse;
/** Delete a Channel */
deleteChannel: DeletionResponse;
/** Delete multiple Channels */
deleteChannels: Array<DeletionResponse>;
/** Delete a Collection and all of its descendants */
deleteCollection: DeletionResponse;
/** Delete multiple Collections and all of their descendants */
deleteCollections: Array<DeletionResponse>;
/** Delete multiple Countries */
deleteCountries: Array<DeletionResponse>;
/** Delete a Country */
deleteCountry: DeletionResponse;
/** Delete a Customer */
deleteCustomer: DeletionResponse;
/** Update an existing Address */
deleteCustomerAddress: Success;
/** Delete a CustomerGroup */
deleteCustomerGroup: DeletionResponse;
/** Delete multiple CustomerGroups */
deleteCustomerGroups: Array<DeletionResponse>;
deleteCustomerNote: DeletionResponse;
/** Deletes Customers */
deleteCustomers: Array<DeletionResponse>;
/** Deletes a draft Order */
deleteDraftOrder: DeletionResponse;
/** Delete an existing Facet */
deleteFacet: DeletionResponse;
/** Delete one or more FacetValues */
deleteFacetValues: Array<DeletionResponse>;
/** Delete multiple existing Facets */
deleteFacets: Array<DeletionResponse>;
deleteOrderNote: DeletionResponse;
/** Delete a PaymentMethod */
deletePaymentMethod: DeletionResponse;
/** Delete multiple PaymentMethods */
deletePaymentMethods: Array<DeletionResponse>;
/** Delete a Product */
deleteProduct: DeletionResponse;
/** Delete a ProductOption */
deleteProductOption: DeletionResponse;
/** Delete a ProductVariant */
deleteProductVariant: DeletionResponse;
/** Delete multiple ProductVariants */
deleteProductVariants: Array<DeletionResponse>;
/** Delete multiple Products */
deleteProducts: Array<DeletionResponse>;
deletePromotion: DeletionResponse;
deletePromotions: Array<DeletionResponse>;
/** Delete a Province */
deleteProvince: DeletionResponse;
/** Delete an existing Role */
deleteRole: DeletionResponse;
/** Delete multiple Roles */
deleteRoles: Array<DeletionResponse>;
/** Delete a Seller */
deleteSeller: DeletionResponse;
/** Delete multiple Sellers */
deleteSellers: Array<DeletionResponse>;
/** Delete a ShippingMethod */
deleteShippingMethod: DeletionResponse;
/** Delete multiple ShippingMethods */
deleteShippingMethods: Array<DeletionResponse>;
deleteStockLocation: DeletionResponse;
deleteStockLocations: Array<DeletionResponse>;
/** Delete an existing Tag */
deleteTag: DeletionResponse;
/** Deletes multiple TaxCategories */
deleteTaxCategories: Array<DeletionResponse>;
/** Deletes a TaxCategory */
deleteTaxCategory: DeletionResponse;
/** Delete a TaxRate */
deleteTaxRate: DeletionResponse;
/** Delete multiple TaxRates */
deleteTaxRates: Array<DeletionResponse>;
/** Delete a Zone */
deleteZone: DeletionResponse;
/** Delete a Zone */
deleteZones: Array<DeletionResponse>;
flushBufferedJobs: Success;
importProducts?: Maybe<ImportInfo>;
/** Authenticates the user using the native authentication strategy. This mutation is an alias for `authenticate({ native: { ... }})` */
login: NativeAuthenticationResult;
logout: Success;
/**
* Allows an Order to be modified after it has been completed by the Customer. The Order must first
* be in the `Modifying` state.
*/
modifyOrder: ModifyOrderResult;
/** Move a Collection to a different parent or index */
moveCollection: Collection;
refundOrder: RefundOrderResult;
reindex: Job;
rejectProductReview?: Maybe<ProductReview>;
/** Removes Collections from the specified Channel */
removeCollectionsFromChannel: Array<Collection>;
/** Removes the given coupon code from the draft Order */
removeCouponCodeFromDraftOrder?: Maybe<Order>;
/** Remove Customers from a CustomerGroup */
removeCustomersFromGroup: CustomerGroup;
/** Remove an OrderLine from the draft Order */
removeDraftOrderLine: RemoveOrderItemsResult;
/** Removes Facets from the specified Channel */
removeFacetsFromChannel: Array<RemoveFacetFromChannelResult>;
/** Remove members from a Zone */
removeMembersFromZone: Zone;
/**
* Remove an OptionGroup from a Product. If the OptionGroup is in use by any ProductVariants
* the mutation will return a ProductOptionInUseError, and the OptionGroup will not be removed.
* Setting the `force` argument to `true` will override this and remove the OptionGroup anyway,
* as well as removing any of the group's options from the Product's ProductVariants.
*/
removeOptionGroupFromProduct: RemoveOptionGroupFromProductResult;
/** Removes PaymentMethods from the specified Channel */
removePaymentMethodsFromChannel: Array<PaymentMethod>;
/** Removes ProductVariants from the specified Channel */
removeProductVariantsFromChannel: Array<ProductVariant>;
/** Removes all ProductVariants of Product from the specified Channel */
removeProductsFromChannel: Array<Product>;
/** Removes Promotions from the specified Channel */
removePromotionsFromChannel: Array<Promotion>;
/** Remove all settled jobs in the given queues older than the given date. Returns the number of jobs deleted. */
removeSettledJobs: Scalars['Int']['output'];
/** Removes ShippingMethods from the specified Channel */
removeShippingMethodsFromChannel: Array<ShippingMethod>;
/** Removes StockLocations from the specified Channel */
removeStockLocationsFromChannel: Array<StockLocation>;
runPendingSearchIndexUpdates: Success;
setCustomerForDraftOrder: SetCustomerForDraftOrderResult;
/** Sets the billing address for a draft Order */
setDraftOrderBillingAddress: Order;
/** Allows any custom fields to be set for the active order */
setDraftOrderCustomFields: Order;
/** Sets the shipping address for a draft Order */
setDraftOrderShippingAddress: Order;
/** Sets the shipping method by id, which can be obtained with the `eligibleShippingMethodsForDraftOrder` query */
setDraftOrderShippingMethod: SetOrderShippingMethodResult;
setOrderCustomFields?: Maybe<Order>;
settlePayment: SettlePaymentResult;
settleRefund: SettleRefundResult;
transitionFulfillmentToState: TransitionFulfillmentToStateResult;
transitionOrderToState?: Maybe<TransitionOrderToStateResult>;
transitionPaymentToState: TransitionPaymentToStateResult;
/** Update the active (currently logged-in) Administrator */
updateActiveAdministrator: Administrator;
/** Update an existing Administrator */
updateAdministrator: Administrator;
/** Update an existing Asset */
updateAsset: Asset;
/** Update an existing Channel */
updateChannel: UpdateChannelResult;
/** Update an existing Collection */
updateCollection: Collection;
/** Update an existing Country */
updateCountry: Country;
/** Update an existing Customer */
updateCustomer: UpdateCustomerResult;
/** Update an existing Address */
updateCustomerAddress: Address;
/** Update an existing CustomerGroup */
updateCustomerGroup: CustomerGroup;
updateCustomerNote: HistoryEntry;
/** Update an existing Facet */
updateFacet: Facet;
/** Update one or more FacetValues */
updateFacetValues: Array<FacetValue>;
updateGlobalSettings: UpdateGlobalSettingsResult;
updateOrderNote: HistoryEntry;
/** Update an existing PaymentMethod */
updatePaymentMethod: PaymentMethod;
/** Update an existing Product */
updateProduct: Product;
/** Create a new ProductOption within a ProductOptionGroup */
updateProductOption: ProductOption;
/** Update an existing ProductOptionGroup */
updateProductOptionGroup: ProductOptionGroup;
updateProductReview: ProductReview;
/** Update existing ProductVariants */
updateProductVariants: Array<Maybe<ProductVariant>>;
/** Update multiple existing Products */
updateProducts: Array<Product>;
updatePromotion: UpdatePromotionResult;
/** Update an existing Province */
updateProvince: Province;
/** Update an existing Role */
updateRole: Role;
/** Update an existing Seller */
updateSeller: Seller;
/** Update an existing ShippingMethod */
updateShippingMethod: ShippingMethod;
updateStockLocation: StockLocation;
/** Update an existing Tag */
updateTag: Tag;
/** Update an existing TaxCategory */
updateTaxCategory: TaxCategory;
/** Update an existing TaxRate */
updateTaxRate: TaxRate;
/** Update an existing Zone */
updateZone: Zone;
};
export type MutationAddCustomersToGroupArgs = {
customerGroupId: Scalars['ID']['input'];
customerIds: Array<Scalars['ID']['input']>;
};
export type MutationAddFulfillmentToOrderArgs = {
input: FulfillOrderInput;
};
export type MutationAddItemToDraftOrderArgs = {
input: AddItemToDraftOrderInput;
orderId: Scalars['ID']['input'];
};
export type MutationAddManualPaymentToOrderArgs = {
input: ManualPaymentInput;
};
export type MutationAddMembersToZoneArgs = {
memberIds: Array<Scalars['ID']['input']>;
zoneId: Scalars['ID']['input'];
};
export type MutationAddNoteToCustomerArgs = {
input: AddNoteToCustomerInput;
};
export type MutationAddNoteToOrderArgs = {
input: AddNoteToOrderInput;
};
export type MutationAddOptionGroupToProductArgs = {
optionGroupId: Scalars['ID']['input'];
productId: Scalars['ID']['input'];
};
export type MutationAdjustDraftOrderLineArgs = {
input: AdjustDraftOrderLineInput;
orderId: Scalars['ID']['input'];
};
export type MutationApplyCouponCodeToDraftOrderArgs = {
couponCode: Scalars['String']['input'];
orderId: Scalars['ID']['input'];
};
export type MutationApproveProductReviewArgs = {
id: Scalars['ID']['input'];
};
export type MutationAssignAssetsToChannelArgs = {
input: AssignAssetsToChannelInput;
};
export type MutationAssignCollectionsToChannelArgs = {
input: AssignCollectionsToChannelInput;
};
export type MutationAssignFacetsToChannelArgs = {
input: AssignFacetsToChannelInput;
};
export type MutationAssignPaymentMethodsToChannelArgs = {
input: AssignPaymentMethodsToChannelInput;
};
export type MutationAssignProductVariantsToChannelArgs = {
input: AssignProductVariantsToChannelInput;
};
export type MutationAssignProductsToChannelArgs = {
input: AssignProductsToChannelInput;
};
export type MutationAssignPromotionsToChannelArgs = {
input: AssignPromotionsToChannelInput;
};
export type MutationAssignRoleToAdministratorArgs = {
administratorId: Scalars['ID']['input'];
roleId: Scalars['ID']['input'];
};
export type MutationAssignShippingMethodsToChannelArgs = {
input: AssignShippingMethodsToChannelInput;
};
export type MutationAssignStockLocationsToChannelArgs = {
input: AssignStockLocationsToChannelInput;
};
export type MutationAuthenticateArgs = {
input: AuthenticationInput;
rememberMe?: InputMaybe<Scalars['Boolean']['input']>;
};
export type MutationCancelJobArgs = {
jobId: Scalars['ID']['input'];
};
export type MutationCancelOrderArgs = {
input: CancelOrderInput;
};
export type MutationCancelPaymentArgs = {
id: Scalars['ID']['input'];
};
export type MutationCreateAdministratorArgs = {
input: CreateAdministratorInput;
};
export type MutationCreateAssetsArgs = {
input: Array<CreateAssetInput>;
};
export type MutationCreateChannelArgs = {
input: CreateChannelInput;
};
export type MutationCreateCollectionArgs = {
input: CreateCollectionInput;
};
export type MutationCreateCountryArgs = {
input: CreateCountryInput;
};
export type MutationCreateCustomerArgs = {
input: CreateCustomerInput;
password?: InputMaybe<Scalars['String']['input']>;
};
export type MutationCreateCustomerAddressArgs = {
customerId: Scalars['ID']['input'];
input: CreateAddressInput;
};
export type MutationCreateCustomerGroupArgs = {
input: CreateCustomerGroupInput;
};
export type MutationCreateFacetArgs = {
input: CreateFacetInput;
};
export type MutationCreateFacetValuesArgs = {
input: Array<CreateFacetValueInput>;
};
export type MutationCreatePaymentMethodArgs = {
input: CreatePaymentMethodInput;
};
export type MutationCreateProductArgs = {
input: CreateProductInput;
};
export type MutationCreateProductOptionArgs = {
input: CreateProductOptionInput;
};
export type MutationCreateProductOptionGroupArgs = {
input: CreateProductOptionGroupInput;
};
export type MutationCreateProductVariantsArgs = {
input: Array<CreateProductVariantInput>;
};
export type MutationCreatePromotionArgs = {
input: CreatePromotionInput;
};
export type MutationCreateProvinceArgs = {
input: CreateProvinceInput;
};
export type MutationCreateRoleArgs = {
input: CreateRoleInput;
};
export type MutationCreateSellerArgs = {
input: CreateSellerInput;
};
export type MutationCreateShippingMethodArgs = {
input: CreateShippingMethodInput;
};
export type MutationCreateStockLocationArgs = {
input: CreateStockLocationInput;
};
export type MutationCreateTagArgs = {
input: CreateTagInput;
};
export type MutationCreateTaxCategoryArgs = {
input: CreateTaxCategoryInput;
};
export type MutationCreateTaxRateArgs = {
input: CreateTaxRateInput;
};
export type MutationCreateZoneArgs = {
input: CreateZoneInput;
};
export type MutationDeleteAdministratorArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteAdministratorsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteAssetArgs = {
input: DeleteAssetInput;
};
export type MutationDeleteAssetsArgs = {
input: DeleteAssetsInput;
};
export type MutationDeleteChannelArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteChannelsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteCollectionArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCollectionsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteCountriesArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteCountryArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCustomerArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCustomerAddressArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCustomerGroupArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCustomerGroupsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteCustomerNoteArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCustomersArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteDraftOrderArgs = {
orderId: Scalars['ID']['input'];
};
export type MutationDeleteFacetArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
id: Scalars['ID']['input'];
};
export type MutationDeleteFacetValuesArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteFacetsArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteOrderNoteArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeletePaymentMethodArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
id: Scalars['ID']['input'];
};
export type MutationDeletePaymentMethodsArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteProductArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteProductOptionArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteProductVariantArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteProductVariantsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteProductsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeletePromotionArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeletePromotionsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteProvinceArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteRoleArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteRolesArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteSellerArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteSellersArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteShippingMethodArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteShippingMethodsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteStockLocationArgs = {
input: DeleteStockLocationInput;
};
export type MutationDeleteStockLocationsArgs = {
input: Array<DeleteStockLocationInput>;
};
export type MutationDeleteTagArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteTaxCategoriesArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteTaxCategoryArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteTaxRateArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteTaxRatesArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteZoneArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteZonesArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationFlushBufferedJobsArgs = {
bufferIds?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type MutationImportProductsArgs = {
csvFile: Scalars['Upload']['input'];
};
export type MutationLoginArgs = {
password: Scalars['String']['input'];
rememberMe?: InputMaybe<Scalars['Boolean']['input']>;
username: Scalars['String']['input'];
};
export type MutationModifyOrderArgs = {
input: ModifyOrderInput;
};
export type MutationMoveCollectionArgs = {
input: MoveCollectionInput;
};
export type MutationRefundOrderArgs = {
input: RefundOrderInput;
};
export type MutationRejectProductReviewArgs = {
id: Scalars['ID']['input'];
};
export type MutationRemoveCollectionsFromChannelArgs = {
input: RemoveCollectionsFromChannelInput;
};
export type MutationRemoveCouponCodeFromDraftOrderArgs = {
couponCode: Scalars['String']['input'];
orderId: Scalars['ID']['input'];
};
export type MutationRemoveCustomersFromGroupArgs = {
customerGroupId: Scalars['ID']['input'];
customerIds: Array<Scalars['ID']['input']>;
};
export type MutationRemoveDraftOrderLineArgs = {
orderId: Scalars['ID']['input'];
orderLineId: Scalars['ID']['input'];
};
export type MutationRemoveFacetsFromChannelArgs = {
input: RemoveFacetsFromChannelInput;
};
export type MutationRemoveMembersFromZoneArgs = {
memberIds: Array<Scalars['ID']['input']>;
zoneId: Scalars['ID']['input'];
};
export type MutationRemoveOptionGroupFromProductArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
optionGroupId: Scalars['ID']['input'];
productId: Scalars['ID']['input'];
};
export type MutationRemovePaymentMethodsFromChannelArgs = {
input: RemovePaymentMethodsFromChannelInput;
};
export type MutationRemoveProductVariantsFromChannelArgs = {
input: RemoveProductVariantsFromChannelInput;
};
export type MutationRemoveProductsFromChannelArgs = {
input: RemoveProductsFromChannelInput;
};
export type MutationRemovePromotionsFromChannelArgs = {
input: RemovePromotionsFromChannelInput;
};
export type MutationRemoveSettledJobsArgs = {
olderThan?: InputMaybe<Scalars['DateTime']['input']>;
queueNames?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type MutationRemoveShippingMethodsFromChannelArgs = {
input: RemoveShippingMethodsFromChannelInput;
};
export type MutationRemoveStockLocationsFromChannelArgs = {
input: RemoveStockLocationsFromChannelInput;
};
export type MutationSetCustomerForDraftOrderArgs = {
customerId?: InputMaybe<Scalars['ID']['input']>;
input?: InputMaybe<CreateCustomerInput>;
orderId: Scalars['ID']['input'];
};
export type MutationSetDraftOrderBillingAddressArgs = {
input: CreateAddressInput;
orderId: Scalars['ID']['input'];
};
export type MutationSetDraftOrderCustomFieldsArgs = {
input: UpdateOrderInput;
orderId: Scalars['ID']['input'];
};
export type MutationSetDraftOrderShippingAddressArgs = {
input: CreateAddressInput;
orderId: Scalars['ID']['input'];
};
export type MutationSetDraftOrderShippingMethodArgs = {
orderId: Scalars['ID']['input'];
shippingMethodId: Scalars['ID']['input'];
};
export type MutationSetOrderCustomFieldsArgs = {
input: UpdateOrderInput;
};
export type MutationSettlePaymentArgs = {
id: Scalars['ID']['input'];
};
export type MutationSettleRefundArgs = {
input: SettleRefundInput;
};
export type MutationTransitionFulfillmentToStateArgs = {
id: Scalars['ID']['input'];
state: Scalars['String']['input'];
};
export type MutationTransitionOrderToStateArgs = {
id: Scalars['ID']['input'];
state: Scalars['String']['input'];
};
export type MutationTransitionPaymentToStateArgs = {
id: Scalars['ID']['input'];
state: Scalars['String']['input'];
};
export type MutationUpdateActiveAdministratorArgs = {
input: UpdateActiveAdministratorInput;
};
export type MutationUpdateAdministratorArgs = {
input: UpdateAdministratorInput;
};
export type MutationUpdateAssetArgs = {
input: UpdateAssetInput;
};
export type MutationUpdateChannelArgs = {
input: UpdateChannelInput;
};
export type MutationUpdateCollectionArgs = {
input: UpdateCollectionInput;
};
export type MutationUpdateCountryArgs = {
input: UpdateCountryInput;
};
export type MutationUpdateCustomerArgs = {
input: UpdateCustomerInput;
};
export type MutationUpdateCustomerAddressArgs = {
input: UpdateAddressInput;
};
export type MutationUpdateCustomerGroupArgs = {
input: UpdateCustomerGroupInput;
};
export type MutationUpdateCustomerNoteArgs = {
input: UpdateCustomerNoteInput;
};
export type MutationUpdateFacetArgs = {
input: UpdateFacetInput;
};
export type MutationUpdateFacetValuesArgs = {
input: Array<UpdateFacetValueInput>;
};
export type MutationUpdateGlobalSettingsArgs = {
input: UpdateGlobalSettingsInput;
};
export type MutationUpdateOrderNoteArgs = {
input: UpdateOrderNoteInput;
};
export type MutationUpdatePaymentMethodArgs = {
input: UpdatePaymentMethodInput;
};
export type MutationUpdateProductArgs = {
input: UpdateProductInput;
};
export type MutationUpdateProductOptionArgs = {
input: UpdateProductOptionInput;
};
export type MutationUpdateProductOptionGroupArgs = {
input: UpdateProductOptionGroupInput;
};
export type MutationUpdateProductReviewArgs = {
input: UpdateProductReviewInput;
};
export type MutationUpdateProductVariantsArgs = {
input: Array<UpdateProductVariantInput>;
};
export type MutationUpdateProductsArgs = {
input: Array<UpdateProductInput>;
};
export type MutationUpdatePromotionArgs = {
input: UpdatePromotionInput;
};
export type MutationUpdateProvinceArgs = {
input: UpdateProvinceInput;
};
export type MutationUpdateRoleArgs = {
input: UpdateRoleInput;
};
export type MutationUpdateSellerArgs = {
input: UpdateSellerInput;
};
export type MutationUpdateShippingMethodArgs = {
input: UpdateShippingMethodInput;
};
export type MutationUpdateStockLocationArgs = {
input: UpdateStockLocationInput;
};
export type MutationUpdateTagArgs = {
input: UpdateTagInput;
};
export type MutationUpdateTaxCategoryArgs = {
input: UpdateTaxCategoryInput;
};
export type MutationUpdateTaxRateArgs = {
input: UpdateTaxRateInput;
};
export type MutationUpdateZoneArgs = {
input: UpdateZoneInput;
};
export type NativeAuthInput = {
password: Scalars['String']['input'];
username: Scalars['String']['input'];
};
/** Returned when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured. */
export type NativeAuthStrategyError = ErrorResult & {
__typename?: 'NativeAuthStrategyError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type NativeAuthenticationResult = CurrentUser | InvalidCredentialsError | NativeAuthStrategyError;
/** Returned when attempting to set a negative OrderLine quantity. */
export type NegativeQuantityError = ErrorResult & {
__typename?: 'NegativeQuantityError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/**
* Returned when invoking a mutation which depends on there being an active Order on the
* current session.
*/
export type NoActiveOrderError = ErrorResult & {
__typename?: 'NoActiveOrderError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when a call to modifyOrder fails to specify any changes */
export type NoChangesSpecifiedError = ErrorResult & {
__typename?: 'NoChangesSpecifiedError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Node = {
id: Scalars['ID']['output'];
};
/** Returned if an attempting to refund an Order but neither items nor shipping refund was specified */
export type NothingToRefundError = ErrorResult & {
__typename?: 'NothingToRefundError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Operators for filtering on a list of Number fields */
export type NumberListOperators = {
inList: Scalars['Float']['input'];
};
/** Operators for filtering on a Int or Float field */
export type NumberOperators = {
between?: InputMaybe<NumberRange>;
eq?: InputMaybe<Scalars['Float']['input']>;
gt?: InputMaybe<Scalars['Float']['input']>;
gte?: InputMaybe<Scalars['Float']['input']>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
lt?: InputMaybe<Scalars['Float']['input']>;
lte?: InputMaybe<Scalars['Float']['input']>;
};
export type NumberRange = {
end: Scalars['Float']['input'];
start: Scalars['Float']['input'];
};
export type Order = Node & {
__typename?: 'Order';
/** An order is active as long as the payment process has not been completed */
active: Scalars['Boolean']['output'];
aggregateOrder?: Maybe<Order>;
aggregateOrderId?: Maybe<Scalars['ID']['output']>;
billingAddress?: Maybe<OrderAddress>;
channels: Array<Channel>;
/** A unique code for the Order */
code: Scalars['String']['output'];
/** An array of all coupon codes applied to the Order */
couponCodes: Array<Scalars['String']['output']>;
createdAt: Scalars['DateTime']['output'];
currencyCode: CurrencyCode;
customFields?: Maybe<Scalars['JSON']['output']>;
customer?: Maybe<Customer>;
discounts: Array<Discount>;
fulfillments?: Maybe<Array<Fulfillment>>;
history: HistoryEntryList;
id: Scalars['ID']['output'];
lines: Array<OrderLine>;
modifications: Array<OrderModification>;
nextStates: Array<Scalars['String']['output']>;
/**
* The date & time that the Order was placed, i.e. the Customer
* completed the checkout and the Order is no longer "active"
*/
orderPlacedAt?: Maybe<Scalars['DateTime']['output']>;
payments?: Maybe<Array<Payment>>;
/** Promotions applied to the order. Only gets populated after the payment process has completed. */
promotions: Array<Promotion>;
sellerOrders?: Maybe<Array<Order>>;
shipping: Scalars['Money']['output'];
shippingAddress?: Maybe<OrderAddress>;
shippingLines: Array<ShippingLine>;
shippingWithTax: Scalars['Money']['output'];
state: Scalars['String']['output'];
/**
* The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
* discounts which have been prorated (proportionally distributed) amongst the items of each OrderLine.
* To get a total of all OrderLines which does not account for prorated discounts, use the
* sum of `OrderLine.discountedLinePrice` values.
*/
subTotal: Scalars['Money']['output'];
/** Same as subTotal, but inclusive of tax */
subTotalWithTax: Scalars['Money']['output'];
/**
* Surcharges are arbitrary modifications to the Order total which are neither
* ProductVariants nor discounts resulting from applied Promotions. For example,
* one-off discounts based on customer interaction, or surcharges based on payment
* methods.
*/
surcharges: Array<Surcharge>;
/** A summary of the taxes being applied to this Order */
taxSummary: Array<OrderTaxSummary>;
/** Equal to subTotal plus shipping */
total: Scalars['Money']['output'];
totalQuantity: Scalars['Int']['output'];
/** The final payable amount. Equal to subTotalWithTax plus shippingWithTax */
totalWithTax: Scalars['Money']['output'];
type: OrderType;
updatedAt: Scalars['DateTime']['output'];
};
export type OrderHistoryArgs = {
options?: InputMaybe<HistoryEntryListOptions>;
};
export type OrderAddress = {
__typename?: 'OrderAddress';
city?: Maybe<Scalars['String']['output']>;
company?: Maybe<Scalars['String']['output']>;
country?: Maybe<Scalars['String']['output']>;
countryCode?: Maybe<Scalars['String']['output']>;
customFields?: Maybe<Scalars['JSON']['output']>;
fullName?: Maybe<Scalars['String']['output']>;
phoneNumber?: Maybe<Scalars['String']['output']>;
postalCode?: Maybe<Scalars['String']['output']>;
province?: Maybe<Scalars['String']['output']>;
streetLine1?: Maybe<Scalars['String']['output']>;
streetLine2?: Maybe<Scalars['String']['output']>;
};
export type OrderFilterParameter = {
active?: InputMaybe<BooleanOperators>;
aggregateOrderId?: InputMaybe<IdOperators>;
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
currencyCode?: InputMaybe<StringOperators>;
customerLastName?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
orderPlacedAt?: InputMaybe<DateOperators>;
shipping?: InputMaybe<NumberOperators>;
shippingWithTax?: InputMaybe<NumberOperators>;
state?: InputMaybe<StringOperators>;
subTotal?: InputMaybe<NumberOperators>;
subTotalWithTax?: InputMaybe<NumberOperators>;
total?: InputMaybe<NumberOperators>;
totalQuantity?: InputMaybe<NumberOperators>;
totalWithTax?: InputMaybe<NumberOperators>;
transactionId?: InputMaybe<StringOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
/** Returned when the maximum order size limit has been reached. */
export type OrderLimitError = ErrorResult & {
__typename?: 'OrderLimitError';
errorCode: ErrorCode;
maxItems: Scalars['Int']['output'];
message: Scalars['String']['output'];
};
export type OrderLine = Node & {
__typename?: 'OrderLine';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
/** The price of the line including discounts, excluding tax */
discountedLinePrice: Scalars['Money']['output'];
/** The price of the line including discounts and tax */
discountedLinePriceWithTax: Scalars['Money']['output'];
/**
* The price of a single unit including discounts, excluding tax.
*
* If Order-level discounts have been applied, this will not be the
* actual taxable unit price (see `proratedUnitPrice`), but is generally the
* correct price to display to customers to avoid confusion
* about the internal handling of distributed Order-level discounts.
*/
discountedUnitPrice: Scalars['Money']['output'];
/** The price of a single unit including discounts and tax */
discountedUnitPriceWithTax: Scalars['Money']['output'];
discounts: Array<Discount>;
featuredAsset?: Maybe<Asset>;
fulfillmentLines?: Maybe<Array<FulfillmentLine>>;
id: Scalars['ID']['output'];
/** The total price of the line excluding tax and discounts. */
linePrice: Scalars['Money']['output'];
/** The total price of the line including tax but excluding discounts. */
linePriceWithTax: Scalars['Money']['output'];
/** The total tax on this line */
lineTax: Scalars['Money']['output'];
order: Order;
/** The quantity at the time the Order was placed */
orderPlacedQuantity: Scalars['Int']['output'];
productVariant: ProductVariant;
/**
* The actual line price, taking into account both item discounts _and_ prorated (proportionally-distributed)
* Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax
* and refund calculations.
*/
proratedLinePrice: Scalars['Money']['output'];
/** The proratedLinePrice including tax */
proratedLinePriceWithTax: Scalars['Money']['output'];
/**
* The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed)
* Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax
* and refund calculations.
*/
proratedUnitPrice: Scalars['Money']['output'];
/** The proratedUnitPrice including tax */
proratedUnitPriceWithTax: Scalars['Money']['output'];
quantity: Scalars['Int']['output'];
taxLines: Array<TaxLine>;
taxRate: Scalars['Float']['output'];
/** The price of a single unit, excluding tax and discounts */
unitPrice: Scalars['Money']['output'];
/** Non-zero if the unitPrice has changed since it was initially added to Order */
unitPriceChangeSinceAdded: Scalars['Money']['output'];
/** The price of a single unit, including tax but excluding discounts */
unitPriceWithTax: Scalars['Money']['output'];
/** Non-zero if the unitPriceWithTax has changed since it was initially added to Order */
unitPriceWithTaxChangeSinceAdded: Scalars['Money']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type OrderLineInput = {
orderLineId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type OrderList = PaginatedList & {
__typename?: 'OrderList';
items: Array<Order>;
totalItems: Scalars['Int']['output'];
};
export type OrderListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<OrderFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<OrderSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type OrderModification = Node & {
__typename?: 'OrderModification';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
isSettled: Scalars['Boolean']['output'];
lines: Array<OrderModificationLine>;
note: Scalars['String']['output'];
payment?: Maybe<Payment>;
priceChange: Scalars['Money']['output'];
refund?: Maybe<Refund>;
surcharges?: Maybe<Array<Surcharge>>;
updatedAt: Scalars['DateTime']['output'];
};
/** Returned when attempting to modify the contents of an Order that is not in the `AddingItems` state. */
export type OrderModificationError = ErrorResult & {
__typename?: 'OrderModificationError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type OrderModificationLine = {
__typename?: 'OrderModificationLine';
modification: OrderModification;
modificationId: Scalars['ID']['output'];
orderLine: OrderLine;
orderLineId: Scalars['ID']['output'];
quantity: Scalars['Int']['output'];
};
/** Returned when attempting to modify the contents of an Order that is not in the `Modifying` state. */
export type OrderModificationStateError = ErrorResult & {
__typename?: 'OrderModificationStateError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type OrderProcessState = {
__typename?: 'OrderProcessState';
name: Scalars['String']['output'];
to: Array<Scalars['String']['output']>;
};
export type OrderSortParameter = {
aggregateOrderId?: InputMaybe<SortOrder>;
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
customerLastName?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
orderPlacedAt?: InputMaybe<SortOrder>;
shipping?: InputMaybe<SortOrder>;
shippingWithTax?: InputMaybe<SortOrder>;
state?: InputMaybe<SortOrder>;
subTotal?: InputMaybe<SortOrder>;
subTotalWithTax?: InputMaybe<SortOrder>;
total?: InputMaybe<SortOrder>;
totalQuantity?: InputMaybe<SortOrder>;
totalWithTax?: InputMaybe<SortOrder>;
transactionId?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
/** Returned if there is an error in transitioning the Order state */
export type OrderStateTransitionError = ErrorResult & {
__typename?: 'OrderStateTransitionError';
errorCode: ErrorCode;
fromState: Scalars['String']['output'];
message: Scalars['String']['output'];
toState: Scalars['String']['output'];
transitionError: Scalars['String']['output'];
};
/**
* A summary of the taxes being applied to this order, grouped
* by taxRate.
*/
export type OrderTaxSummary = {
__typename?: 'OrderTaxSummary';
/** A description of this tax */
description: Scalars['String']['output'];
/** The total net price of OrderLines to which this taxRate applies */
taxBase: Scalars['Money']['output'];
/** The taxRate as a percentage */
taxRate: Scalars['Float']['output'];
/** The total tax being applied to the Order at this taxRate */
taxTotal: Scalars['Money']['output'];
};
export enum OrderType {
Aggregate = 'Aggregate',
Regular = 'Regular',
Seller = 'Seller',
}
export type PaginatedList = {
items: Array<Node>;
totalItems: Scalars['Int']['output'];
};
export type Payment = Node & {
__typename?: 'Payment';
amount: Scalars['Money']['output'];
createdAt: Scalars['DateTime']['output'];
errorMessage?: Maybe<Scalars['String']['output']>;
id: Scalars['ID']['output'];
metadata?: Maybe<Scalars['JSON']['output']>;
method: Scalars['String']['output'];
nextStates: Array<Scalars['String']['output']>;
refunds: Array<Refund>;
state: Scalars['String']['output'];
transactionId?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type PaymentMethod = Node & {
__typename?: 'PaymentMethod';
checker?: Maybe<ConfigurableOperation>;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
enabled: Scalars['Boolean']['output'];
handler: ConfigurableOperation;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
translations: Array<PaymentMethodTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type PaymentMethodFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
enabled?: InputMaybe<BooleanOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type PaymentMethodList = PaginatedList & {
__typename?: 'PaymentMethodList';
items: Array<PaymentMethod>;
totalItems: Scalars['Int']['output'];
};
export type PaymentMethodListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<PaymentMethodFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<PaymentMethodSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
/**
* Returned when a call to modifyOrder fails to include a paymentMethod even
* though the price has increased as a result of the changes.
*/
export type PaymentMethodMissingError = ErrorResult & {
__typename?: 'PaymentMethodMissingError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type PaymentMethodQuote = {
__typename?: 'PaymentMethodQuote';
code: Scalars['String']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
eligibilityMessage?: Maybe<Scalars['String']['output']>;
id: Scalars['ID']['output'];
isEligible: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
};
export type PaymentMethodSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type PaymentMethodTranslation = {
__typename?: 'PaymentMethodTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type PaymentMethodTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
/** Returned if an attempting to refund a Payment against OrderLines from a different Order */
export type PaymentOrderMismatchError = ErrorResult & {
__typename?: 'PaymentOrderMismatchError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when there is an error in transitioning the Payment state */
export type PaymentStateTransitionError = ErrorResult & {
__typename?: 'PaymentStateTransitionError';
errorCode: ErrorCode;
fromState: Scalars['String']['output'];
message: Scalars['String']['output'];
toState: Scalars['String']['output'];
transitionError: Scalars['String']['output'];
};
/**
* @description
* Permissions for administrators and customers. Used to control access to
* GraphQL resolvers via the {@link Allow} decorator.
*
* ## Understanding Permission.Owner
*
* `Permission.Owner` is a special permission which is used in some Vendure resolvers to indicate that that resolver should only
* be accessible to the "owner" of that resource.
*
* For example, the Shop API `activeCustomer` query resolver should only return the Customer object for the "owner" of that Customer, i.e.
* based on the activeUserId of the current session. As a result, the resolver code looks like this:
*
* @example
* ```ts
* \@Query()
* \@Allow(Permission.Owner)
* async activeCustomer(\@Ctx() ctx: RequestContext): Promise<Customer | undefined> {
* const userId = ctx.activeUserId;
* if (userId) {
* return this.customerService.findOneByUserId(ctx, userId);
* }
* }
* ```
*
* Here we can see that the "ownership" must be enforced by custom logic inside the resolver. Since "ownership" cannot be defined generally
* nor statically encoded at build-time, any resolvers using `Permission.Owner` **must** include logic to enforce that only the owner
* of the resource has access. If not, then it is the equivalent of using `Permission.Public`.
*
*
* @docsCategory common
*/
export enum Permission {
/** Authenticated means simply that the user is logged in */
Authenticated = 'Authenticated',
/** Grants permission to create Administrator */
CreateAdministrator = 'CreateAdministrator',
/** Grants permission to create Asset */
CreateAsset = 'CreateAsset',
/** Grants permission to create Products, Facets, Assets, Collections */
CreateCatalog = 'CreateCatalog',
/** Grants permission to create Channel */
CreateChannel = 'CreateChannel',
/** Grants permission to create Collection */
CreateCollection = 'CreateCollection',
/** Grants permission to create Country */
CreateCountry = 'CreateCountry',
/** Grants permission to create Customer */
CreateCustomer = 'CreateCustomer',
/** Grants permission to create CustomerGroup */
CreateCustomerGroup = 'CreateCustomerGroup',
/** Grants permission to create Facet */
CreateFacet = 'CreateFacet',
/** Grants permission to create Order */
CreateOrder = 'CreateOrder',
/** Grants permission to create PaymentMethod */
CreatePaymentMethod = 'CreatePaymentMethod',
/** Grants permission to create Product */
CreateProduct = 'CreateProduct',
/** Grants permission to create Promotion */
CreatePromotion = 'CreatePromotion',
/** Grants permission to create Seller */
CreateSeller = 'CreateSeller',
/** Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
CreateSettings = 'CreateSettings',
/** Grants permission to create ShippingMethod */
CreateShippingMethod = 'CreateShippingMethod',
/** Grants permission to create StockLocation */
CreateStockLocation = 'CreateStockLocation',
/** Grants permission to create System */
CreateSystem = 'CreateSystem',
/** Grants permission to create Tag */
CreateTag = 'CreateTag',
/** Grants permission to create TaxCategory */
CreateTaxCategory = 'CreateTaxCategory',
/** Grants permission to create TaxRate */
CreateTaxRate = 'CreateTaxRate',
/** Grants permission to create Zone */
CreateZone = 'CreateZone',
/** Grants permission to delete Administrator */
DeleteAdministrator = 'DeleteAdministrator',
/** Grants permission to delete Asset */
DeleteAsset = 'DeleteAsset',
/** Grants permission to delete Products, Facets, Assets, Collections */
DeleteCatalog = 'DeleteCatalog',
/** Grants permission to delete Channel */
DeleteChannel = 'DeleteChannel',
/** Grants permission to delete Collection */
DeleteCollection = 'DeleteCollection',
/** Grants permission to delete Country */
DeleteCountry = 'DeleteCountry',
/** Grants permission to delete Customer */
DeleteCustomer = 'DeleteCustomer',
/** Grants permission to delete CustomerGroup */
DeleteCustomerGroup = 'DeleteCustomerGroup',
/** Grants permission to delete Facet */
DeleteFacet = 'DeleteFacet',
/** Grants permission to delete Order */
DeleteOrder = 'DeleteOrder',
/** Grants permission to delete PaymentMethod */
DeletePaymentMethod = 'DeletePaymentMethod',
/** Grants permission to delete Product */
DeleteProduct = 'DeleteProduct',
/** Grants permission to delete Promotion */
DeletePromotion = 'DeletePromotion',
/** Grants permission to delete Seller */
DeleteSeller = 'DeleteSeller',
/** Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
DeleteSettings = 'DeleteSettings',
/** Grants permission to delete ShippingMethod */
DeleteShippingMethod = 'DeleteShippingMethod',
/** Grants permission to delete StockLocation */
DeleteStockLocation = 'DeleteStockLocation',
/** Grants permission to delete System */
DeleteSystem = 'DeleteSystem',
/** Grants permission to delete Tag */
DeleteTag = 'DeleteTag',
/** Grants permission to delete TaxCategory */
DeleteTaxCategory = 'DeleteTaxCategory',
/** Grants permission to delete TaxRate */
DeleteTaxRate = 'DeleteTaxRate',
/** Grants permission to delete Zone */
DeleteZone = 'DeleteZone',
/** Owner means the user owns this entity, e.g. a Customer's own Order */
Owner = 'Owner',
/** Public means any unauthenticated user may perform the operation */
Public = 'Public',
/** Grants permission to read Administrator */
ReadAdministrator = 'ReadAdministrator',
/** Grants permission to read Asset */
ReadAsset = 'ReadAsset',
/** Grants permission to read Products, Facets, Assets, Collections */
ReadCatalog = 'ReadCatalog',
/** Grants permission to read Channel */
ReadChannel = 'ReadChannel',
/** Grants permission to read Collection */
ReadCollection = 'ReadCollection',
/** Grants permission to read Country */
ReadCountry = 'ReadCountry',
/** Grants permission to read Customer */
ReadCustomer = 'ReadCustomer',
/** Grants permission to read CustomerGroup */
ReadCustomerGroup = 'ReadCustomerGroup',
/** Grants permission to read Facet */
ReadFacet = 'ReadFacet',
/** Grants permission to read Order */
ReadOrder = 'ReadOrder',
/** Grants permission to read PaymentMethod */
ReadPaymentMethod = 'ReadPaymentMethod',
/** Grants permission to read Product */
ReadProduct = 'ReadProduct',
/** Grants permission to read Promotion */
ReadPromotion = 'ReadPromotion',
/** Grants permission to read Seller */
ReadSeller = 'ReadSeller',
/** Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
ReadSettings = 'ReadSettings',
/** Grants permission to read ShippingMethod */
ReadShippingMethod = 'ReadShippingMethod',
/** Grants permission to read StockLocation */
ReadStockLocation = 'ReadStockLocation',
/** Grants permission to read System */
ReadSystem = 'ReadSystem',
/** Grants permission to read Tag */
ReadTag = 'ReadTag',
/** Grants permission to read TaxCategory */
ReadTaxCategory = 'ReadTaxCategory',
/** Grants permission to read TaxRate */
ReadTaxRate = 'ReadTaxRate',
/** Grants permission to read Zone */
ReadZone = 'ReadZone',
/** SuperAdmin has unrestricted access to all operations */
SuperAdmin = 'SuperAdmin',
/** Grants permission to update Administrator */
UpdateAdministrator = 'UpdateAdministrator',
/** Grants permission to update Asset */
UpdateAsset = 'UpdateAsset',
/** Grants permission to update Products, Facets, Assets, Collections */
UpdateCatalog = 'UpdateCatalog',
/** Grants permission to update Channel */
UpdateChannel = 'UpdateChannel',
/** Grants permission to update Collection */
UpdateCollection = 'UpdateCollection',
/** Grants permission to update Country */
UpdateCountry = 'UpdateCountry',
/** Grants permission to update Customer */
UpdateCustomer = 'UpdateCustomer',
/** Grants permission to update CustomerGroup */
UpdateCustomerGroup = 'UpdateCustomerGroup',
/** Grants permission to update Facet */
UpdateFacet = 'UpdateFacet',
/** Grants permission to update GlobalSettings */
UpdateGlobalSettings = 'UpdateGlobalSettings',
/** Grants permission to update Order */
UpdateOrder = 'UpdateOrder',
/** Grants permission to update PaymentMethod */
UpdatePaymentMethod = 'UpdatePaymentMethod',
/** Grants permission to update Product */
UpdateProduct = 'UpdateProduct',
/** Grants permission to update Promotion */
UpdatePromotion = 'UpdatePromotion',
/** Grants permission to update Seller */
UpdateSeller = 'UpdateSeller',
/** Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
UpdateSettings = 'UpdateSettings',
/** Grants permission to update ShippingMethod */
UpdateShippingMethod = 'UpdateShippingMethod',
/** Grants permission to update StockLocation */
UpdateStockLocation = 'UpdateStockLocation',
/** Grants permission to update System */
UpdateSystem = 'UpdateSystem',
/** Grants permission to update Tag */
UpdateTag = 'UpdateTag',
/** Grants permission to update TaxCategory */
UpdateTaxCategory = 'UpdateTaxCategory',
/** Grants permission to update TaxRate */
UpdateTaxRate = 'UpdateTaxRate',
/** Grants permission to update Zone */
UpdateZone = 'UpdateZone',
}
export type PermissionDefinition = {
__typename?: 'PermissionDefinition';
assignable: Scalars['Boolean']['output'];
description: Scalars['String']['output'];
name: Scalars['String']['output'];
};
export type PreviewCollectionVariantsInput = {
filters: Array<ConfigurableOperationInput>;
inheritFilters: Scalars['Boolean']['input'];
parentId?: InputMaybe<Scalars['ID']['input']>;
};
/** The price range where the result has more than one price */
export type PriceRange = {
__typename?: 'PriceRange';
max: Scalars['Money']['output'];
min: Scalars['Money']['output'];
};
export type Product = Node & {
__typename?: 'Product';
assets: Array<Asset>;
channels: Array<Channel>;
collections: Array<Collection>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<ProductCustomFields>;
description: Scalars['String']['output'];
enabled: Scalars['Boolean']['output'];
facetValues: Array<FacetValue>;
featuredAsset?: Maybe<Asset>;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
optionGroups: Array<ProductOptionGroup>;
reviews: ProductReviewList;
reviewsHistogram: Array<ProductReviewHistogramItem>;
slug: Scalars['String']['output'];
translations: Array<ProductTranslation>;
updatedAt: Scalars['DateTime']['output'];
/** Returns a paginated, sortable, filterable list of ProductVariants */
variantList: ProductVariantList;
/** Returns all ProductVariants */
variants: Array<ProductVariant>;
};
export type ProductReviewsArgs = {
options?: InputMaybe<ProductReviewListOptions>;
};
export type ProductVariantListArgs = {
options?: InputMaybe<ProductVariantListOptions>;
};
export type ProductCustomFields = {
__typename?: 'ProductCustomFields';
featuredReview?: Maybe<ProductReview>;
reviewCount?: Maybe<Scalars['Float']['output']>;
reviewRating?: Maybe<Scalars['Float']['output']>;
};
export type ProductFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
enabled?: InputMaybe<BooleanOperators>;
facetValueId?: InputMaybe<IdOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
reviewCount?: InputMaybe<NumberOperators>;
reviewRating?: InputMaybe<NumberOperators>;
slug?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ProductList = PaginatedList & {
__typename?: 'ProductList';
items: Array<Product>;
totalItems: Scalars['Int']['output'];
};
export type ProductListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ProductFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ProductSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ProductOption = Node & {
__typename?: 'ProductOption';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
group: ProductOptionGroup;
groupId: Scalars['ID']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<ProductOptionTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type ProductOptionGroup = Node & {
__typename?: 'ProductOptionGroup';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
options: Array<ProductOption>;
translations: Array<ProductOptionGroupTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type ProductOptionGroupTranslation = {
__typename?: 'ProductOptionGroupTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProductOptionGroupTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type ProductOptionInUseError = ErrorResult & {
__typename?: 'ProductOptionInUseError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
optionGroupCode: Scalars['String']['output'];
productVariantCount: Scalars['Int']['output'];
};
export type ProductOptionTranslation = {
__typename?: 'ProductOptionTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProductOptionTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type ProductReview = Node & {
__typename?: 'ProductReview';
author?: Maybe<Customer>;
authorLocation?: Maybe<Scalars['String']['output']>;
authorName: Scalars['String']['output'];
body?: Maybe<Scalars['String']['output']>;
createdAt: Scalars['DateTime']['output'];
downvotes: Scalars['Int']['output'];
id: Scalars['ID']['output'];
product: Product;
productVariant?: Maybe<ProductVariant>;
rating: Scalars['Float']['output'];
response?: Maybe<Scalars['String']['output']>;
responseCreatedAt?: Maybe<Scalars['DateTime']['output']>;
state: Scalars['String']['output'];
summary: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
upvotes: Scalars['Int']['output'];
};
export type ProductReviewFilterParameter = {
authorLocation?: InputMaybe<StringOperators>;
authorName?: InputMaybe<StringOperators>;
body?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
downvotes?: InputMaybe<NumberOperators>;
id?: InputMaybe<IdOperators>;
rating?: InputMaybe<NumberOperators>;
response?: InputMaybe<StringOperators>;
responseCreatedAt?: InputMaybe<DateOperators>;
state?: InputMaybe<StringOperators>;
summary?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
upvotes?: InputMaybe<NumberOperators>;
};
export type ProductReviewHistogramItem = {
__typename?: 'ProductReviewHistogramItem';
bin: Scalars['Int']['output'];
frequency: Scalars['Int']['output'];
};
export type ProductReviewList = PaginatedList & {
__typename?: 'ProductReviewList';
items: Array<ProductReview>;
totalItems: Scalars['Int']['output'];
};
export type ProductReviewListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ProductReviewFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ProductReviewSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ProductReviewSortParameter = {
authorLocation?: InputMaybe<SortOrder>;
authorName?: InputMaybe<SortOrder>;
body?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
downvotes?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
rating?: InputMaybe<SortOrder>;
response?: InputMaybe<SortOrder>;
responseCreatedAt?: InputMaybe<SortOrder>;
state?: InputMaybe<SortOrder>;
summary?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
upvotes?: InputMaybe<SortOrder>;
};
export type ProductSortParameter = {
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
featuredReview?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
reviewCount?: InputMaybe<SortOrder>;
reviewRating?: InputMaybe<SortOrder>;
slug?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ProductTranslation = {
__typename?: 'ProductTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
slug: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProductTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
slug?: InputMaybe<Scalars['String']['input']>;
};
export type ProductVariant = Node & {
__typename?: 'ProductVariant';
assets: Array<Asset>;
channels: Array<Channel>;
createdAt: Scalars['DateTime']['output'];
currencyCode: CurrencyCode;
customFields?: Maybe<Scalars['JSON']['output']>;
enabled: Scalars['Boolean']['output'];
facetValues: Array<FacetValue>;
featuredAsset?: Maybe<Asset>;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
options: Array<ProductOption>;
outOfStockThreshold: Scalars['Int']['output'];
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
prices: Array<ProductVariantPrice>;
product: Product;
productId: Scalars['ID']['output'];
sku: Scalars['String']['output'];
/** @deprecated use stockLevels */
stockAllocated: Scalars['Int']['output'];
stockLevel: Scalars['String']['output'];
stockLevels: Array<StockLevel>;
stockMovements: StockMovementList;
/** @deprecated use stockLevels */
stockOnHand: Scalars['Int']['output'];
taxCategory: TaxCategory;
taxRateApplied: TaxRate;
trackInventory: GlobalFlag;
translations: Array<ProductVariantTranslation>;
updatedAt: Scalars['DateTime']['output'];
useGlobalOutOfStockThreshold: Scalars['Boolean']['output'];
};
export type ProductVariantStockMovementsArgs = {
options?: InputMaybe<StockMovementListOptions>;
};
export type ProductVariantFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
currencyCode?: InputMaybe<StringOperators>;
enabled?: InputMaybe<BooleanOperators>;
facetValueId?: InputMaybe<IdOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
outOfStockThreshold?: InputMaybe<NumberOperators>;
price?: InputMaybe<NumberOperators>;
priceWithTax?: InputMaybe<NumberOperators>;
productId?: InputMaybe<IdOperators>;
sku?: InputMaybe<StringOperators>;
stockAllocated?: InputMaybe<NumberOperators>;
stockLevel?: InputMaybe<StringOperators>;
stockOnHand?: InputMaybe<NumberOperators>;
trackInventory?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
useGlobalOutOfStockThreshold?: InputMaybe<BooleanOperators>;
};
export type ProductVariantList = PaginatedList & {
__typename?: 'ProductVariantList';
items: Array<ProductVariant>;
totalItems: Scalars['Int']['output'];
};
export type ProductVariantListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ProductVariantFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ProductVariantSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ProductVariantPrice = {
__typename?: 'ProductVariantPrice';
currencyCode: CurrencyCode;
price: Scalars['Int']['output'];
};
/**
* Used to set up update the price of a ProductVariant in a particular Channel.
* If the `delete` flag is `true`, the price will be deleted for the given Channel.
*/
export type ProductVariantPriceInput = {
currencyCode: CurrencyCode;
delete?: InputMaybe<Scalars['Boolean']['input']>;
price: Scalars['Money']['input'];
};
export type ProductVariantSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
outOfStockThreshold?: InputMaybe<SortOrder>;
price?: InputMaybe<SortOrder>;
priceWithTax?: InputMaybe<SortOrder>;
productId?: InputMaybe<SortOrder>;
sku?: InputMaybe<SortOrder>;
stockAllocated?: InputMaybe<SortOrder>;
stockLevel?: InputMaybe<SortOrder>;
stockOnHand?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ProductVariantTranslation = {
__typename?: 'ProductVariantTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProductVariantTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type Promotion = Node & {
__typename?: 'Promotion';
actions: Array<ConfigurableOperation>;
conditions: Array<ConfigurableOperation>;
couponCode?: Maybe<Scalars['String']['output']>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
enabled: Scalars['Boolean']['output'];
endsAt?: Maybe<Scalars['DateTime']['output']>;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
perCustomerUsageLimit?: Maybe<Scalars['Int']['output']>;
startsAt?: Maybe<Scalars['DateTime']['output']>;
translations: Array<PromotionTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type PromotionFilterParameter = {
couponCode?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
enabled?: InputMaybe<BooleanOperators>;
endsAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
perCustomerUsageLimit?: InputMaybe<NumberOperators>;
startsAt?: InputMaybe<DateOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type PromotionList = PaginatedList & {
__typename?: 'PromotionList';
items: Array<Promotion>;
totalItems: Scalars['Int']['output'];
};
export type PromotionListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<PromotionFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<PromotionSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type PromotionSortParameter = {
couponCode?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
endsAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
perCustomerUsageLimit?: InputMaybe<SortOrder>;
startsAt?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type PromotionTranslation = {
__typename?: 'PromotionTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type PromotionTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type Province = Node &
Region & {
__typename?: 'Province';
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
parent?: Maybe<Region>;
parentId?: Maybe<Scalars['ID']['output']>;
translations: Array<RegionTranslation>;
type: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProvinceFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
enabled?: InputMaybe<BooleanOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
parentId?: InputMaybe<IdOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ProvinceList = PaginatedList & {
__typename?: 'ProvinceList';
items: Array<Province>;
totalItems: Scalars['Int']['output'];
};
export type ProvinceListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ProvinceFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ProvinceSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ProvinceSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
parentId?: InputMaybe<SortOrder>;
type?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ProvinceTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
/** Returned if the specified quantity of an OrderLine is greater than the number of items in that line */
export type QuantityTooGreatError = ErrorResult & {
__typename?: 'QuantityTooGreatError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Query = {
__typename?: 'Query';
activeAdministrator?: Maybe<Administrator>;
activeChannel: Channel;
administrator?: Maybe<Administrator>;
administrators: AdministratorList;
/** Get a single Asset by id */
asset?: Maybe<Asset>;
/** Get a list of Assets */
assets: AssetList;
channel?: Maybe<Channel>;
channels: ChannelList;
/** Get a Collection either by id or slug. If neither id nor slug is specified, an error will result. */
collection?: Maybe<Collection>;
collectionFilters: Array<ConfigurableOperationDefinition>;
collections: CollectionList;
countries: CountryList;
country?: Maybe<Country>;
customer?: Maybe<Customer>;
customerGroup?: Maybe<CustomerGroup>;
customerGroups: CustomerGroupList;
customers: CustomerList;
/** Returns a list of eligible shipping methods for the draft Order */
eligibleShippingMethodsForDraftOrder: Array<ShippingMethodQuote>;
facet?: Maybe<Facet>;
facetValues: FacetValueList;
facets: FacetList;
fulfillmentHandlers: Array<ConfigurableOperationDefinition>;
globalSettings: GlobalSettings;
job?: Maybe<Job>;
jobBufferSize: Array<JobBufferSize>;
jobQueues: Array<JobQueue>;
jobs: JobList;
jobsById: Array<Job>;
me?: Maybe<CurrentUser>;
/** Get metrics for the given interval and metric types. */
metricSummary: Array<MetricSummary>;
order?: Maybe<Order>;
orders: OrderList;
paymentMethod?: Maybe<PaymentMethod>;
paymentMethodEligibilityCheckers: Array<ConfigurableOperationDefinition>;
paymentMethodHandlers: Array<ConfigurableOperationDefinition>;
paymentMethods: PaymentMethodList;
pendingSearchIndexUpdates: Scalars['Int']['output'];
/** Used for real-time previews of the contents of a Collection */
previewCollectionVariants: ProductVariantList;
/** Get a Product either by id or slug. If neither id nor slug is specified, an error will result. */
product?: Maybe<Product>;
productOptionGroup?: Maybe<ProductOptionGroup>;
productOptionGroups: Array<ProductOptionGroup>;
productReview?: Maybe<ProductReview>;
productReviews: ProductReviewList;
/** Get a ProductVariant by id */
productVariant?: Maybe<ProductVariant>;
/** List ProductVariants either all or for the specific product. */
productVariants: ProductVariantList;
/** List Products */
products: ProductList;
promotion?: Maybe<Promotion>;
promotionActions: Array<ConfigurableOperationDefinition>;
promotionConditions: Array<ConfigurableOperationDefinition>;
promotions: PromotionList;
province?: Maybe<Province>;
provinces: ProvinceList;
role?: Maybe<Role>;
roles: RoleList;
search: SearchResponse;
seller?: Maybe<Seller>;
sellers: SellerList;
shippingCalculators: Array<ConfigurableOperationDefinition>;
shippingEligibilityCheckers: Array<ConfigurableOperationDefinition>;
shippingMethod?: Maybe<ShippingMethod>;
shippingMethods: ShippingMethodList;
stockLocation?: Maybe<StockLocation>;
stockLocations: StockLocationList;
tag: Tag;
tags: TagList;
taxCategories: TaxCategoryList;
taxCategory?: Maybe<TaxCategory>;
taxRate?: Maybe<TaxRate>;
taxRates: TaxRateList;
testEligibleShippingMethods: Array<ShippingMethodQuote>;
testShippingMethod: TestShippingMethodResult;
zone?: Maybe<Zone>;
zones: ZoneList;
};
export type QueryAdministratorArgs = {
id: Scalars['ID']['input'];
};
export type QueryAdministratorsArgs = {
options?: InputMaybe<AdministratorListOptions>;
};
export type QueryAssetArgs = {
id: Scalars['ID']['input'];
};
export type QueryAssetsArgs = {
options?: InputMaybe<AssetListOptions>;
};
export type QueryChannelArgs = {
id: Scalars['ID']['input'];
};
export type QueryChannelsArgs = {
options?: InputMaybe<ChannelListOptions>;
};
export type QueryCollectionArgs = {
id?: InputMaybe<Scalars['ID']['input']>;
slug?: InputMaybe<Scalars['String']['input']>;
};
export type QueryCollectionsArgs = {
options?: InputMaybe<CollectionListOptions>;
};
export type QueryCountriesArgs = {
options?: InputMaybe<CountryListOptions>;
};
export type QueryCountryArgs = {
id: Scalars['ID']['input'];
};
export type QueryCustomerArgs = {
id: Scalars['ID']['input'];
};
export type QueryCustomerGroupArgs = {
id: Scalars['ID']['input'];
};
export type QueryCustomerGroupsArgs = {
options?: InputMaybe<CustomerGroupListOptions>;
};
export type QueryCustomersArgs = {
options?: InputMaybe<CustomerListOptions>;
};
export type QueryEligibleShippingMethodsForDraftOrderArgs = {
orderId: Scalars['ID']['input'];
};
export type QueryFacetArgs = {
id: Scalars['ID']['input'];
};
export type QueryFacetValuesArgs = {
options?: InputMaybe<FacetValueListOptions>;
};
export type QueryFacetsArgs = {
options?: InputMaybe<FacetListOptions>;
};
export type QueryJobArgs = {
jobId: Scalars['ID']['input'];
};
export type QueryJobBufferSizeArgs = {
bufferIds?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type QueryJobsArgs = {
options?: InputMaybe<JobListOptions>;
};
export type QueryJobsByIdArgs = {
jobIds: Array<Scalars['ID']['input']>;
};
export type QueryMetricSummaryArgs = {
input?: InputMaybe<MetricSummaryInput>;
};
export type QueryOrderArgs = {
id: Scalars['ID']['input'];
};
export type QueryOrdersArgs = {
options?: InputMaybe<OrderListOptions>;
};
export type QueryPaymentMethodArgs = {
id: Scalars['ID']['input'];
};
export type QueryPaymentMethodsArgs = {
options?: InputMaybe<PaymentMethodListOptions>;
};
export type QueryPreviewCollectionVariantsArgs = {
input: PreviewCollectionVariantsInput;
options?: InputMaybe<ProductVariantListOptions>;
};
export type QueryProductArgs = {
id?: InputMaybe<Scalars['ID']['input']>;
slug?: InputMaybe<Scalars['String']['input']>;
};
export type QueryProductOptionGroupArgs = {
id: Scalars['ID']['input'];
};
export type QueryProductOptionGroupsArgs = {
filterTerm?: InputMaybe<Scalars['String']['input']>;
};
export type QueryProductReviewArgs = {
id: Scalars['ID']['input'];
};
export type QueryProductReviewsArgs = {
options?: InputMaybe<ProductReviewListOptions>;
};
export type QueryProductVariantArgs = {
id: Scalars['ID']['input'];
};
export type QueryProductVariantsArgs = {
options?: InputMaybe<ProductVariantListOptions>;
productId?: InputMaybe<Scalars['ID']['input']>;
};
export type QueryProductsArgs = {
options?: InputMaybe<ProductListOptions>;
};
export type QueryPromotionArgs = {
id: Scalars['ID']['input'];
};
export type QueryPromotionsArgs = {
options?: InputMaybe<PromotionListOptions>;
};
export type QueryProvinceArgs = {
id: Scalars['ID']['input'];
};
export type QueryProvincesArgs = {
options?: InputMaybe<ProvinceListOptions>;
};
export type QueryRoleArgs = {
id: Scalars['ID']['input'];
};
export type QueryRolesArgs = {
options?: InputMaybe<RoleListOptions>;
};
export type QuerySearchArgs = {
input: SearchInput;
};
export type QuerySellerArgs = {
id: Scalars['ID']['input'];
};
export type QuerySellersArgs = {
options?: InputMaybe<SellerListOptions>;
};
export type QueryShippingMethodArgs = {
id: Scalars['ID']['input'];
};
export type QueryShippingMethodsArgs = {
options?: InputMaybe<ShippingMethodListOptions>;
};
export type QueryStockLocationArgs = {
id: Scalars['ID']['input'];
};
export type QueryStockLocationsArgs = {
options?: InputMaybe<StockLocationListOptions>;
};
export type QueryTagArgs = {
id: Scalars['ID']['input'];
};
export type QueryTagsArgs = {
options?: InputMaybe<TagListOptions>;
};
export type QueryTaxCategoriesArgs = {
options?: InputMaybe<TaxCategoryListOptions>;
};
export type QueryTaxCategoryArgs = {
id: Scalars['ID']['input'];
};
export type QueryTaxRateArgs = {
id: Scalars['ID']['input'];
};
export type QueryTaxRatesArgs = {
options?: InputMaybe<TaxRateListOptions>;
};
export type QueryTestEligibleShippingMethodsArgs = {
input: TestEligibleShippingMethodsInput;
};
export type QueryTestShippingMethodArgs = {
input: TestShippingMethodInput;
};
export type QueryZoneArgs = {
id: Scalars['ID']['input'];
};
export type QueryZonesArgs = {
options?: InputMaybe<ZoneListOptions>;
};
export type Refund = Node & {
__typename?: 'Refund';
adjustment: Scalars['Money']['output'];
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
items: Scalars['Money']['output'];
lines: Array<RefundLine>;
metadata?: Maybe<Scalars['JSON']['output']>;
method?: Maybe<Scalars['String']['output']>;
paymentId: Scalars['ID']['output'];
reason?: Maybe<Scalars['String']['output']>;
shipping: Scalars['Money']['output'];
state: Scalars['String']['output'];
total: Scalars['Money']['output'];
transactionId?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type RefundLine = {
__typename?: 'RefundLine';
orderLine: OrderLine;
orderLineId: Scalars['ID']['output'];
quantity: Scalars['Int']['output'];
refund: Refund;
refundId: Scalars['ID']['output'];
};
export type RefundOrderInput = {
adjustment: Scalars['Money']['input'];
lines: Array<OrderLineInput>;
paymentId: Scalars['ID']['input'];
reason?: InputMaybe<Scalars['String']['input']>;
shipping: Scalars['Money']['input'];
};
export type RefundOrderResult =
| AlreadyRefundedError
| MultipleOrderError
| NothingToRefundError
| OrderStateTransitionError
| PaymentOrderMismatchError
| QuantityTooGreatError
| Refund
| RefundOrderStateError
| RefundStateTransitionError;
/** Returned if an attempting to refund an Order which is not in the expected state */
export type RefundOrderStateError = ErrorResult & {
__typename?: 'RefundOrderStateError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
orderState: Scalars['String']['output'];
};
/**
* Returned when a call to modifyOrder fails to include a refundPaymentId even
* though the price has decreased as a result of the changes.
*/
export type RefundPaymentIdMissingError = ErrorResult & {
__typename?: 'RefundPaymentIdMissingError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when there is an error in transitioning the Refund state */
export type RefundStateTransitionError = ErrorResult & {
__typename?: 'RefundStateTransitionError';
errorCode: ErrorCode;
fromState: Scalars['String']['output'];
message: Scalars['String']['output'];
toState: Scalars['String']['output'];
transitionError: Scalars['String']['output'];
};
export type Region = {
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
parent?: Maybe<Region>;
parentId?: Maybe<Scalars['ID']['output']>;
translations: Array<RegionTranslation>;
type: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type RegionTranslation = {
__typename?: 'RegionTranslation';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type RelationCustomFieldConfig = CustomField & {
__typename?: 'RelationCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
entity: Scalars['String']['output'];
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
scalarFields: Array<Scalars['String']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type Release = Node &
StockMovement & {
__typename?: 'Release';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type RemoveCollectionsFromChannelInput = {
channelId: Scalars['ID']['input'];
collectionIds: Array<Scalars['ID']['input']>;
};
export type RemoveFacetFromChannelResult = Facet | FacetInUseError;
export type RemoveFacetsFromChannelInput = {
channelId: Scalars['ID']['input'];
facetIds: Array<Scalars['ID']['input']>;
force?: InputMaybe<Scalars['Boolean']['input']>;
};
export type RemoveOptionGroupFromProductResult = Product | ProductOptionInUseError;
export type RemoveOrderItemsResult = Order | OrderModificationError;
export type RemovePaymentMethodsFromChannelInput = {
channelId: Scalars['ID']['input'];
paymentMethodIds: Array<Scalars['ID']['input']>;
};
export type RemoveProductVariantsFromChannelInput = {
channelId: Scalars['ID']['input'];
productVariantIds: Array<Scalars['ID']['input']>;
};
export type RemoveProductsFromChannelInput = {
channelId: Scalars['ID']['input'];
productIds: Array<Scalars['ID']['input']>;
};
export type RemovePromotionsFromChannelInput = {
channelId: Scalars['ID']['input'];
promotionIds: Array<Scalars['ID']['input']>;
};
export type RemoveShippingMethodsFromChannelInput = {
channelId: Scalars['ID']['input'];
shippingMethodIds: Array<Scalars['ID']['input']>;
};
export type RemoveStockLocationsFromChannelInput = {
channelId: Scalars['ID']['input'];
stockLocationIds: Array<Scalars['ID']['input']>;
};
export type Return = Node &
StockMovement & {
__typename?: 'Return';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type Role = Node & {
__typename?: 'Role';
channels: Array<Channel>;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
permissions: Array<Permission>;
updatedAt: Scalars['DateTime']['output'];
};
export type RoleFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type RoleList = PaginatedList & {
__typename?: 'RoleList';
items: Array<Role>;
totalItems: Scalars['Int']['output'];
};
export type RoleListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<RoleFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<RoleSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type RoleSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type Sale = Node &
StockMovement & {
__typename?: 'Sale';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type SearchInput = {
collectionId?: InputMaybe<Scalars['ID']['input']>;
collectionSlug?: InputMaybe<Scalars['String']['input']>;
facetValueFilters?: InputMaybe<Array<FacetValueFilterInput>>;
groupByProduct?: InputMaybe<Scalars['Boolean']['input']>;
skip?: InputMaybe<Scalars['Int']['input']>;
sort?: InputMaybe<SearchResultSortParameter>;
take?: InputMaybe<Scalars['Int']['input']>;
term?: InputMaybe<Scalars['String']['input']>;
};
export type SearchReindexResponse = {
__typename?: 'SearchReindexResponse';
success: Scalars['Boolean']['output'];
};
export type SearchResponse = {
__typename?: 'SearchResponse';
collections: Array<CollectionResult>;
facetValues: Array<FacetValueResult>;
items: Array<SearchResult>;
totalItems: Scalars['Int']['output'];
};
export type SearchResult = {
__typename?: 'SearchResult';
/** An array of ids of the Channels in which this result appears */
channelIds: Array<Scalars['ID']['output']>;
/** An array of ids of the Collections in which this result appears */
collectionIds: Array<Scalars['ID']['output']>;
currencyCode: CurrencyCode;
description: Scalars['String']['output'];
enabled: Scalars['Boolean']['output'];
facetIds: Array<Scalars['ID']['output']>;
facetValueIds: Array<Scalars['ID']['output']>;
price: SearchResultPrice;
priceWithTax: SearchResultPrice;
productAsset?: Maybe<SearchResultAsset>;
productId: Scalars['ID']['output'];
productName: Scalars['String']['output'];
productVariantAsset?: Maybe<SearchResultAsset>;
productVariantId: Scalars['ID']['output'];
productVariantName: Scalars['String']['output'];
/** A relevance score for the result. Differs between database implementations */
score: Scalars['Float']['output'];
sku: Scalars['String']['output'];
slug: Scalars['String']['output'];
};
export type SearchResultAsset = {
__typename?: 'SearchResultAsset';
focalPoint?: Maybe<Coordinate>;
id: Scalars['ID']['output'];
preview: Scalars['String']['output'];
};
/** The price of a search result product, either as a range or as a single price */
export type SearchResultPrice = PriceRange | SinglePrice;
export type SearchResultSortParameter = {
name?: InputMaybe<SortOrder>;
price?: InputMaybe<SortOrder>;
};
export type Seller = Node & {
__typename?: 'Seller';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type SellerFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type SellerList = PaginatedList & {
__typename?: 'SellerList';
items: Array<Seller>;
totalItems: Scalars['Int']['output'];
};
export type SellerListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<SellerFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<SellerSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type SellerSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ServerConfig = {
__typename?: 'ServerConfig';
customFieldConfig: CustomFields;
orderProcess: Array<OrderProcessState>;
permissions: Array<PermissionDefinition>;
permittedAssetTypes: Array<Scalars['String']['output']>;
};
export type SetCustomerForDraftOrderResult = EmailAddressConflictError | Order;
export type SetOrderShippingMethodResult =
| IneligibleShippingMethodError
| NoActiveOrderError
| Order
| OrderModificationError;
/** Returned if the Payment settlement fails */
export type SettlePaymentError = ErrorResult & {
__typename?: 'SettlePaymentError';
errorCode: ErrorCode;
message: Scalars['String']['output'];
paymentErrorMessage: Scalars['String']['output'];
};
export type SettlePaymentResult =
| OrderStateTransitionError
| Payment
| PaymentStateTransitionError
| SettlePaymentError;
export type SettleRefundInput = {
id: Scalars['ID']['input'];
transactionId: Scalars['String']['input'];
};
export type SettleRefundResult = Refund | RefundStateTransitionError;
export type ShippingLine = {
__typename?: 'ShippingLine';
discountedPrice: Scalars['Money']['output'];
discountedPriceWithTax: Scalars['Money']['output'];
discounts: Array<Discount>;
id: Scalars['ID']['output'];
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
shippingMethod: ShippingMethod;
};
export type ShippingMethod = Node & {
__typename?: 'ShippingMethod';
calculator: ConfigurableOperation;
checker: ConfigurableOperation;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
fulfillmentHandlerCode: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<ShippingMethodTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type ShippingMethodFilterParameter = {
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
fulfillmentHandlerCode?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ShippingMethodList = PaginatedList & {
__typename?: 'ShippingMethodList';
items: Array<ShippingMethod>;
totalItems: Scalars['Int']['output'];
};
export type ShippingMethodListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ShippingMethodFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ShippingMethodSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ShippingMethodQuote = {
__typename?: 'ShippingMethodQuote';
code: Scalars['String']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
/** Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult */
metadata?: Maybe<Scalars['JSON']['output']>;
name: Scalars['String']['output'];
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
};
export type ShippingMethodSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
fulfillmentHandlerCode?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ShippingMethodTranslation = {
__typename?: 'ShippingMethodTranslation';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ShippingMethodTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
/** The price value where the result has a single price */
export type SinglePrice = {
__typename?: 'SinglePrice';
value: Scalars['Money']['output'];
};
export enum SortOrder {
ASC = 'ASC',
DESC = 'DESC',
}
export type StockAdjustment = Node &
StockMovement & {
__typename?: 'StockAdjustment';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type StockLevel = Node & {
__typename?: 'StockLevel';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
stockAllocated: Scalars['Int']['output'];
stockLocation: StockLocation;
stockLocationId: Scalars['ID']['output'];
stockOnHand: Scalars['Int']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type StockLevelInput = {
stockLocationId: Scalars['ID']['input'];
stockOnHand: Scalars['Int']['input'];
};
export type StockLocation = Node & {
__typename?: 'StockLocation';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type StockLocationFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type StockLocationList = PaginatedList & {
__typename?: 'StockLocationList';
items: Array<StockLocation>;
totalItems: Scalars['Int']['output'];
};
export type StockLocationListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<StockLocationFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<StockLocationSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type StockLocationSortParameter = {
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type StockMovement = {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type StockMovementItem = Allocation | Cancellation | Release | Return | Sale | StockAdjustment;
export type StockMovementList = {
__typename?: 'StockMovementList';
items: Array<StockMovementItem>;
totalItems: Scalars['Int']['output'];
};
export type StockMovementListOptions = {
skip?: InputMaybe<Scalars['Int']['input']>;
take?: InputMaybe<Scalars['Int']['input']>;
type?: InputMaybe<StockMovementType>;
};
export enum StockMovementType {
ADJUSTMENT = 'ADJUSTMENT',
ALLOCATION = 'ALLOCATION',
CANCELLATION = 'CANCELLATION',
RELEASE = 'RELEASE',
RETURN = 'RETURN',
SALE = 'SALE',
}
export type StringCustomFieldConfig = CustomField & {
__typename?: 'StringCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
length?: Maybe<Scalars['Int']['output']>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
options?: Maybe<Array<StringFieldOption>>;
pattern?: Maybe<Scalars['String']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type StringFieldOption = {
__typename?: 'StringFieldOption';
label?: Maybe<Array<LocalizedString>>;
value: Scalars['String']['output'];
};
/** Operators for filtering on a list of String fields */
export type StringListOperators = {
inList: Scalars['String']['input'];
};
/** Operators for filtering on a String field */
export type StringOperators = {
contains?: InputMaybe<Scalars['String']['input']>;
eq?: InputMaybe<Scalars['String']['input']>;
in?: InputMaybe<Array<Scalars['String']['input']>>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
notContains?: InputMaybe<Scalars['String']['input']>;
notEq?: InputMaybe<Scalars['String']['input']>;
notIn?: InputMaybe<Array<Scalars['String']['input']>>;
regex?: InputMaybe<Scalars['String']['input']>;
};
/** Indicates that an operation succeeded, where we do not want to return any more specific information. */
export type Success = {
__typename?: 'Success';
success: Scalars['Boolean']['output'];
};
export type Surcharge = Node & {
__typename?: 'Surcharge';
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
sku?: Maybe<Scalars['String']['output']>;
taxLines: Array<TaxLine>;
taxRate: Scalars['Float']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type SurchargeInput = {
description: Scalars['String']['input'];
price: Scalars['Money']['input'];
priceIncludesTax: Scalars['Boolean']['input'];
sku?: InputMaybe<Scalars['String']['input']>;
taxDescription?: InputMaybe<Scalars['String']['input']>;
taxRate?: InputMaybe<Scalars['Float']['input']>;
};
export type Tag = Node & {
__typename?: 'Tag';
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
updatedAt: Scalars['DateTime']['output'];
value: Scalars['String']['output'];
};
export type TagFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
updatedAt?: InputMaybe<DateOperators>;
value?: InputMaybe<StringOperators>;
};
export type TagList = PaginatedList & {
__typename?: 'TagList';
items: Array<Tag>;
totalItems: Scalars['Int']['output'];
};
export type TagListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<TagFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<TagSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type TagSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
value?: InputMaybe<SortOrder>;
};
export type TaxCategory = Node & {
__typename?: 'TaxCategory';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
isDefault: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type TaxCategoryFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
isDefault?: InputMaybe<BooleanOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type TaxCategoryList = PaginatedList & {
__typename?: 'TaxCategoryList';
items: Array<TaxCategory>;
totalItems: Scalars['Int']['output'];
};
export type TaxCategoryListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<TaxCategoryFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<TaxCategorySortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type TaxCategorySortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type TaxLine = {
__typename?: 'TaxLine';
description: Scalars['String']['output'];
taxRate: Scalars['Float']['output'];
};
export type TaxRate = Node & {
__typename?: 'TaxRate';
category: TaxCategory;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
customerGroup?: Maybe<CustomerGroup>;
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
value: Scalars['Float']['output'];
zone: Zone;
};
export type TaxRateFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
enabled?: InputMaybe<BooleanOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
value?: InputMaybe<NumberOperators>;
};
export type TaxRateList = PaginatedList & {
__typename?: 'TaxRateList';
items: Array<TaxRate>;
totalItems: Scalars['Int']['output'];
};
export type TaxRateListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<TaxRateFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<TaxRateSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type TaxRateSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
value?: InputMaybe<SortOrder>;
};
export type TestEligibleShippingMethodsInput = {
lines: Array<TestShippingMethodOrderLineInput>;
shippingAddress: CreateAddressInput;
};
export type TestShippingMethodInput = {
calculator: ConfigurableOperationInput;
checker: ConfigurableOperationInput;
lines: Array<TestShippingMethodOrderLineInput>;
shippingAddress: CreateAddressInput;
};
export type TestShippingMethodOrderLineInput = {
productVariantId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type TestShippingMethodQuote = {
__typename?: 'TestShippingMethodQuote';
metadata?: Maybe<Scalars['JSON']['output']>;
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
};
export type TestShippingMethodResult = {
__typename?: 'TestShippingMethodResult';
eligible: Scalars['Boolean']['output'];
quote?: Maybe<TestShippingMethodQuote>;
};
export type TextCustomFieldConfig = CustomField & {
__typename?: 'TextCustomFieldConfig';
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type TransitionFulfillmentToStateResult = Fulfillment | FulfillmentStateTransitionError;
export type TransitionOrderToStateResult = Order | OrderStateTransitionError;
export type TransitionPaymentToStateResult = Payment | PaymentStateTransitionError;
export type UpdateActiveAdministratorInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress?: InputMaybe<Scalars['String']['input']>;
firstName?: InputMaybe<Scalars['String']['input']>;
lastName?: InputMaybe<Scalars['String']['input']>;
password?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateAddressInput = {
city?: InputMaybe<Scalars['String']['input']>;
company?: InputMaybe<Scalars['String']['input']>;
countryCode?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
defaultBillingAddress?: InputMaybe<Scalars['Boolean']['input']>;
defaultShippingAddress?: InputMaybe<Scalars['Boolean']['input']>;
fullName?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
phoneNumber?: InputMaybe<Scalars['String']['input']>;
postalCode?: InputMaybe<Scalars['String']['input']>;
province?: InputMaybe<Scalars['String']['input']>;
streetLine1?: InputMaybe<Scalars['String']['input']>;
streetLine2?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateAdministratorInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress?: InputMaybe<Scalars['String']['input']>;
firstName?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
lastName?: InputMaybe<Scalars['String']['input']>;
password?: InputMaybe<Scalars['String']['input']>;
roleIds?: InputMaybe<Array<Scalars['ID']['input']>>;
};
export type UpdateAssetInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
focalPoint?: InputMaybe<CoordinateInput>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
tags?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type UpdateChannelInput = {
availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
defaultCurrencyCode?: InputMaybe<CurrencyCode>;
defaultLanguageCode?: InputMaybe<LanguageCode>;
defaultShippingZoneId?: InputMaybe<Scalars['ID']['input']>;
defaultTaxZoneId?: InputMaybe<Scalars['ID']['input']>;
id: Scalars['ID']['input'];
outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
pricesIncludeTax?: InputMaybe<Scalars['Boolean']['input']>;
sellerId?: InputMaybe<Scalars['ID']['input']>;
token?: InputMaybe<Scalars['String']['input']>;
trackInventory?: InputMaybe<Scalars['Boolean']['input']>;
};
export type UpdateChannelResult = Channel | LanguageNotAvailableError;
export type UpdateCollectionInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
filters?: InputMaybe<Array<ConfigurableOperationInput>>;
id: Scalars['ID']['input'];
inheritFilters?: InputMaybe<Scalars['Boolean']['input']>;
isPrivate?: InputMaybe<Scalars['Boolean']['input']>;
parentId?: InputMaybe<Scalars['ID']['input']>;
translations?: InputMaybe<Array<UpdateCollectionTranslationInput>>;
};
export type UpdateCollectionTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
slug?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateCountryInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<CountryTranslationInput>>;
};
export type UpdateCustomerGroupInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateCustomerInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress?: InputMaybe<Scalars['String']['input']>;
firstName?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
lastName?: InputMaybe<Scalars['String']['input']>;
phoneNumber?: InputMaybe<Scalars['String']['input']>;
title?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateCustomerNoteInput = {
note: Scalars['String']['input'];
noteId: Scalars['ID']['input'];
};
export type UpdateCustomerResult = Customer | EmailAddressConflictError;
export type UpdateFacetInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
isPrivate?: InputMaybe<Scalars['Boolean']['input']>;
translations?: InputMaybe<Array<FacetTranslationInput>>;
};
export type UpdateFacetValueInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<FacetValueTranslationInput>>;
};
export type UpdateGlobalSettingsInput = {
availableLanguages?: InputMaybe<Array<LanguageCode>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
trackInventory?: InputMaybe<Scalars['Boolean']['input']>;
};
export type UpdateGlobalSettingsResult = ChannelDefaultLanguageError | GlobalSettings;
export type UpdateOrderAddressInput = {
city?: InputMaybe<Scalars['String']['input']>;
company?: InputMaybe<Scalars['String']['input']>;
countryCode?: InputMaybe<Scalars['String']['input']>;
fullName?: InputMaybe<Scalars['String']['input']>;
phoneNumber?: InputMaybe<Scalars['String']['input']>;
postalCode?: InputMaybe<Scalars['String']['input']>;
province?: InputMaybe<Scalars['String']['input']>;
streetLine1?: InputMaybe<Scalars['String']['input']>;
streetLine2?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateOrderInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
};
export type UpdateOrderItemsResult =
| InsufficientStockError
| NegativeQuantityError
| Order
| OrderLimitError
| OrderModificationError;
export type UpdateOrderNoteInput = {
isPublic?: InputMaybe<Scalars['Boolean']['input']>;
note?: InputMaybe<Scalars['String']['input']>;
noteId: Scalars['ID']['input'];
};
export type UpdatePaymentMethodInput = {
checker?: InputMaybe<ConfigurableOperationInput>;
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
handler?: InputMaybe<ConfigurableOperationInput>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<PaymentMethodTranslationInput>>;
};
export type UpdateProductCustomFieldsInput = {
featuredReviewId?: InputMaybe<Scalars['ID']['input']>;
reviewCount?: InputMaybe<Scalars['Float']['input']>;
reviewRating?: InputMaybe<Scalars['Float']['input']>;
};
export type UpdateProductInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<UpdateProductCustomFieldsInput>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<ProductTranslationInput>>;
};
export type UpdateProductOptionGroupInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<ProductOptionGroupTranslationInput>>;
};
export type UpdateProductOptionInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<ProductOptionGroupTranslationInput>>;
};
export type UpdateProductReviewInput = {
body?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
response?: InputMaybe<Scalars['String']['input']>;
summary?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateProductVariantInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
id: Scalars['ID']['input'];
optionIds?: InputMaybe<Array<Scalars['ID']['input']>>;
outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
/** Sets the price for the ProductVariant in the Channel's default currency */
price?: InputMaybe<Scalars['Money']['input']>;
/** Allows multiple prices to be set for the ProductVariant in different currencies. */
prices?: InputMaybe<Array<ProductVariantPriceInput>>;
sku?: InputMaybe<Scalars['String']['input']>;
stockLevels?: InputMaybe<Array<StockLevelInput>>;
stockOnHand?: InputMaybe<Scalars['Int']['input']>;
taxCategoryId?: InputMaybe<Scalars['ID']['input']>;
trackInventory?: InputMaybe<GlobalFlag>;
translations?: InputMaybe<Array<ProductVariantTranslationInput>>;
useGlobalOutOfStockThreshold?: InputMaybe<Scalars['Boolean']['input']>;
};
export type UpdatePromotionInput = {
actions?: InputMaybe<Array<ConfigurableOperationInput>>;
conditions?: InputMaybe<Array<ConfigurableOperationInput>>;
couponCode?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
endsAt?: InputMaybe<Scalars['DateTime']['input']>;
id: Scalars['ID']['input'];
perCustomerUsageLimit?: InputMaybe<Scalars['Int']['input']>;
startsAt?: InputMaybe<Scalars['DateTime']['input']>;
translations?: InputMaybe<Array<PromotionTranslationInput>>;
};
export type UpdatePromotionResult = MissingConditionsError | Promotion;
export type UpdateProvinceInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<ProvinceTranslationInput>>;
};
export type UpdateRoleInput = {
channelIds?: InputMaybe<Array<Scalars['ID']['input']>>;
code?: InputMaybe<Scalars['String']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
permissions?: InputMaybe<Array<Permission>>;
};
export type UpdateSellerInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateShippingMethodInput = {
calculator?: InputMaybe<ConfigurableOperationInput>;
checker?: InputMaybe<ConfigurableOperationInput>;
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
fulfillmentHandler?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
translations: Array<ShippingMethodTranslationInput>;
};
export type UpdateStockLocationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateTagInput = {
id: Scalars['ID']['input'];
value?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateTaxCategoryInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
isDefault?: InputMaybe<Scalars['Boolean']['input']>;
name?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateTaxRateInput = {
categoryId?: InputMaybe<Scalars['ID']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
customerGroupId?: InputMaybe<Scalars['ID']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
value?: InputMaybe<Scalars['Float']['input']>;
zoneId?: InputMaybe<Scalars['ID']['input']>;
};
export type UpdateZoneInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
};
export type User = Node & {
__typename?: 'User';
authenticationMethods: Array<AuthenticationMethod>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
identifier: Scalars['String']['output'];
lastLogin?: Maybe<Scalars['DateTime']['output']>;
roles: Array<Role>;
updatedAt: Scalars['DateTime']['output'];
verified: Scalars['Boolean']['output'];
};
export type Zone = Node & {
__typename?: 'Zone';
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
members: Array<Region>;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ZoneFilterParameter = {
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ZoneList = PaginatedList & {
__typename?: 'ZoneList';
items: Array<Zone>;
totalItems: Scalars['Int']['output'];
};
export type ZoneListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ZoneFilterParameter>;
/** Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ZoneSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ZoneSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ProductReviewFragment = {
__typename?: 'ProductReview';
id: string;
createdAt: any;
updatedAt: any;
authorName: string;
authorLocation?: string;
summary: string;
body?: string;
rating: number;
state: string;
upvotes: number;
downvotes: number;
response?: string;
responseCreatedAt?: any;
};
export type GetAllReviewsQueryVariables = Exact<{
options?: InputMaybe<ProductReviewListOptions>;
}>;
export type GetAllReviewsQuery = {
__typename?: 'Query';
productReviews: {
__typename?: 'ProductReviewList';
totalItems: number;
items: Array<{
__typename?: 'ProductReview';
id: string;
createdAt: any;
updatedAt: any;
authorName: string;
authorLocation?: string;
summary: string;
body?: string;
rating: number;
state: string;
upvotes: number;
downvotes: number;
response?: string;
responseCreatedAt?: any;
product: {
__typename?: 'Product';
id: string;
name: string;
featuredAsset?: { __typename?: 'Asset'; id: string; preview: string };
};
}>;
};
};
export type GetReviewDetailQueryVariables = Exact<{
id: Scalars['ID']['input'];
}>;
export type GetReviewDetailQuery = {
__typename?: 'Query';
productReview?: {
__typename?: 'ProductReview';
id: string;
createdAt: any;
updatedAt: any;
authorName: string;
authorLocation?: string;
summary: string;
body?: string;
rating: number;
state: string;
upvotes: number;
downvotes: number;
response?: string;
responseCreatedAt?: any;
product: {
__typename?: 'Product';
id: string;
name: string;
featuredAsset?: { __typename?: 'Asset'; id: string; preview: string };
};
productVariant?: {
__typename?: 'ProductVariant';
id: string;
name: string;
featuredAsset?: { __typename?: 'Asset'; id: string; preview: string };
};
};
};
export type UpdateReviewMutationVariables = Exact<{
input: UpdateProductReviewInput;
}>;
export type UpdateReviewMutation = {
__typename?: 'Mutation';
updateProductReview: {
__typename?: 'ProductReview';
id: string;
createdAt: any;
updatedAt: any;
authorName: string;
authorLocation?: string;
summary: string;
body?: string;
rating: number;
state: string;
upvotes: number;
downvotes: number;
response?: string;
responseCreatedAt?: any;
};
};
export type ApproveReviewMutationVariables = Exact<{
id: Scalars['ID']['input'];
}>;
export type ApproveReviewMutation = {
__typename?: 'Mutation';
approveProductReview?: {
__typename?: 'ProductReview';
id: string;
state: string;
product: {
__typename?: 'Product';
id: string;
customFields?: {
__typename?: 'ProductCustomFields';
reviewCount?: number;
reviewRating?: number;
};
};
};
};
export type RejectReviewMutationVariables = Exact<{
id: Scalars['ID']['input'];
}>;
export type RejectReviewMutation = {
__typename?: 'Mutation';
rejectProductReview?: { __typename?: 'ProductReview'; id: string; state: string };
};
export type GetReviewForProductQueryVariables = Exact<{
productId: Scalars['ID']['input'];
options?: InputMaybe<ProductReviewListOptions>;
}>;
export type GetReviewForProductQuery = {
__typename?: 'Query';
product?: {
__typename?: 'Product';
id: string;
reviews: {
__typename?: 'ProductReviewList';
totalItems: number;
items: Array<{
__typename?: 'ProductReview';
id: string;
createdAt: any;
updatedAt: any;
authorName: string;
authorLocation?: string;
summary: string;
body?: string;
rating: number;
state: string;
upvotes: number;
downvotes: number;
response?: string;
responseCreatedAt?: any;
}>;
};
};
};
export type GetReviewsHistogramQueryVariables = Exact<{
id: Scalars['ID']['input'];
}>;
export type GetReviewsHistogramQuery = {
__typename?: 'Query';
product?: {
__typename?: 'Product';
id: string;
name: string;
featuredAsset?: { __typename?: 'Asset'; id: string; preview: string };
customFields?: { __typename?: 'ProductCustomFields'; reviewRating?: number; reviewCount?: number };
reviewsHistogram: Array<{
__typename?: 'ProductReviewHistogramItem';
bin: number;
frequency: number;
}>;
};
};
export type GetProductNameQueryVariables = Exact<{
id: Scalars['ID']['input'];
}>;
export type GetProductNameQuery = {
__typename?: 'Query';
product?: { __typename?: 'Product'; id: string; name: string };
};
export type GetReviewsForWidgetQueryVariables = Exact<{
options?: InputMaybe<ProductReviewListOptions>;
}>;
export type GetReviewsForWidgetQuery = {
__typename?: 'Query';
productReviews: {
__typename?: 'ProductReviewList';
totalItems: number;
items: Array<{
__typename?: 'ProductReview';
id: string;
authorName: string;
summary: string;
rating: number;
state: string;
createdAt: any;
product: { __typename?: 'Product'; id: string; name: string };
}>;
};
};
export const ProductReviewFragmentDoc = {
kind: 'Document',
definitions: [
{
kind: 'FragmentDefinition',
name: { kind: 'Name', value: 'ProductReview' },
typeCondition: { kind: 'NamedType', name: { kind: 'Name', value: 'ProductReview' } },
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
{ kind: 'Field', name: { kind: 'Name', value: 'createdAt' } },
{ kind: 'Field', name: { kind: 'Name', value: 'updatedAt' } },
{ kind: 'Field', name: { kind: 'Name', value: 'authorName' } },
{ kind: 'Field', name: { kind: 'Name', value: 'authorLocation' } },
{ kind: 'Field', name: { kind: 'Name', value: 'summary' } },
{ kind: 'Field', name: { kind: 'Name', value: 'body' } },
{ kind: 'Field', name: { kind: 'Name', value: 'rating' } },
{ kind: 'Field', name: { kind: 'Name', value: 'state' } },
{ kind: 'Field', name: { kind: 'Name', value: 'upvotes' } },
{ kind: 'Field', name: { kind: 'Name', value: 'downvotes' } },
{ kind: 'Field', name: { kind: 'Name', value: 'response' } },
{ kind: 'Field', name: { kind: 'Name', value: 'responseCreatedAt' } },
],
},
},
],
} as unknown as DocumentNode<ProductReviewFragment, unknown>;
export const GetAllReviewsDocument = {
kind: 'Document',
definitions: [
{
kind: 'OperationDefinition',
operation: 'query',
name: { kind: 'Name', value: 'GetAllReviews' },
variableDefinitions: [
{
kind: 'VariableDefinition',
variable: { kind: 'Variable', name: { kind: 'Name', value: 'options' } },
type: { kind: 'NamedType', name: { kind: 'Name', value: 'ProductReviewListOptions' } },
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'productReviews' },
arguments: [
{
kind: 'Argument',
name: { kind: 'Name', value: 'options' },
value: { kind: 'Variable', name: { kind: 'Name', value: 'options' } },
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'items' },
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'FragmentSpread',
name: { kind: 'Name', value: 'ProductReview' },
},
{
kind: 'Field',
name: { kind: 'Name', value: 'product' },
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'id' },
},
{
kind: 'Field',
name: { kind: 'Name', value: 'name' },
},
{
kind: 'Field',
name: { kind: 'Name', value: 'featuredAsset' },
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'id' },
},
{
kind: 'Field',
name: {
kind: 'Name',
value: 'preview',
},
},
],
},
},
],
},
},
],
},
},
{ kind: 'Field', name: { kind: 'Name', value: 'totalItems' } },
],
},
},
],
},
},
{
kind: 'FragmentDefinition',
name: { kind: 'Name', value: 'ProductReview' },
typeCondition: { kind: 'NamedType', name: { kind: 'Name', value: 'ProductReview' } },
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
{ kind: 'Field', name: { kind: 'Name', value: 'createdAt' } },
{ kind: 'Field', name: { kind: 'Name', value: 'updatedAt' } },
{ kind: 'Field', name: { kind: 'Name', value: 'authorName' } },
{ kind: 'Field', name: { kind: 'Name', value: 'authorLocation' } },
{ kind: 'Field', name: { kind: 'Name', value: 'summary' } },
{ kind: 'Field', name: { kind: 'Name', value: 'body' } },
{ kind: 'Field', name: { kind: 'Name', value: 'rating' } },
{ kind: 'Field', name: { kind: 'Name', value: 'state' } },
{ kind: 'Field', name: { kind: 'Name', value: 'upvotes' } },
{ kind: 'Field', name: { kind: 'Name', value: 'downvotes' } },
{ kind: 'Field', name: { kind: 'Name', value: 'response' } },
{ kind: 'Field', name: { kind: 'Name', value: 'responseCreatedAt' } },
],
},
},
],
} as unknown as DocumentNode<GetAllReviewsQuery, GetAllReviewsQueryVariables>;
export const GetReviewDetailDocument = {
kind: 'Document',
definitions: [
{
kind: 'OperationDefinition',
operation: 'query',
name: { kind: 'Name', value: 'GetReviewDetail' },
variableDefinitions: [
{
kind: 'VariableDefinition',
variable: { kind: 'Variable', name: { kind: 'Name', value: 'id' } },
type: {
kind: 'NonNullType',
type: { kind: 'NamedType', name: { kind: 'Name', value: 'ID' } },
},
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'productReview' },
arguments: [
{
kind: 'Argument',
name: { kind: 'Name', value: 'id' },
value: { kind: 'Variable', name: { kind: 'Name', value: 'id' } },
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'FragmentSpread', name: { kind: 'Name', value: 'ProductReview' } },
{
kind: 'Field',
name: { kind: 'Name', value: 'product' },
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
{ kind: 'Field', name: { kind: 'Name', value: 'name' } },
{
kind: 'Field',
name: { kind: 'Name', value: 'featuredAsset' },
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'id' },
},
{
kind: 'Field',
name: { kind: 'Name', value: 'preview' },
},
],
},
},
],
},
},
{
kind: 'Field',
name: { kind: 'Name', value: 'productVariant' },
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
{ kind: 'Field', name: { kind: 'Name', value: 'name' } },
{
kind: 'Field',
name: { kind: 'Name', value: 'featuredAsset' },
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'id' },
},
{
kind: 'Field',
name: { kind: 'Name', value: 'preview' },
},
],
},
},
],
},
},
],
},
},
],
},
},
{
kind: 'FragmentDefinition',
name: { kind: 'Name', value: 'ProductReview' },
typeCondition: { kind: 'NamedType', name: { kind: 'Name', value: 'ProductReview' } },
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
{ kind: 'Field', name: { kind: 'Name', value: 'createdAt' } },
{ kind: 'Field', name: { kind: 'Name', value: 'updatedAt' } },
{ kind: 'Field', name: { kind: 'Name', value: 'authorName' } },
{ kind: 'Field', name: { kind: 'Name', value: 'authorLocation' } },
{ kind: 'Field', name: { kind: 'Name', value: 'summary' } },
{ kind: 'Field', name: { kind: 'Name', value: 'body' } },
{ kind: 'Field', name: { kind: 'Name', value: 'rating' } },
{ kind: 'Field', name: { kind: 'Name', value: 'state' } },
{ kind: 'Field', name: { kind: 'Name', value: 'upvotes' } },
{ kind: 'Field', name: { kind: 'Name', value: 'downvotes' } },
{ kind: 'Field', name: { kind: 'Name', value: 'response' } },
{ kind: 'Field', name: { kind: 'Name', value: 'responseCreatedAt' } },
],
},
},
],
} as unknown as DocumentNode<GetReviewDetailQuery, GetReviewDetailQueryVariables>;
export const UpdateReviewDocument = {
kind: 'Document',
definitions: [
{
kind: 'OperationDefinition',
operation: 'mutation',
name: { kind: 'Name', value: 'UpdateReview' },
variableDefinitions: [
{
kind: 'VariableDefinition',
variable: { kind: 'Variable', name: { kind: 'Name', value: 'input' } },
type: {
kind: 'NonNullType',
type: {
kind: 'NamedType',
name: { kind: 'Name', value: 'UpdateProductReviewInput' },
},
},
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'updateProductReview' },
arguments: [
{
kind: 'Argument',
name: { kind: 'Name', value: 'input' },
value: { kind: 'Variable', name: { kind: 'Name', value: 'input' } },
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'FragmentSpread', name: { kind: 'Name', value: 'ProductReview' } },
],
},
},
],
},
},
{
kind: 'FragmentDefinition',
name: { kind: 'Name', value: 'ProductReview' },
typeCondition: { kind: 'NamedType', name: { kind: 'Name', value: 'ProductReview' } },
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
{ kind: 'Field', name: { kind: 'Name', value: 'createdAt' } },
{ kind: 'Field', name: { kind: 'Name', value: 'updatedAt' } },
{ kind: 'Field', name: { kind: 'Name', value: 'authorName' } },
{ kind: 'Field', name: { kind: 'Name', value: 'authorLocation' } },
{ kind: 'Field', name: { kind: 'Name', value: 'summary' } },
{ kind: 'Field', name: { kind: 'Name', value: 'body' } },
{ kind: 'Field', name: { kind: 'Name', value: 'rating' } },
{ kind: 'Field', name: { kind: 'Name', value: 'state' } },
{ kind: 'Field', name: { kind: 'Name', value: 'upvotes' } },
{ kind: 'Field', name: { kind: 'Name', value: 'downvotes' } },
{ kind: 'Field', name: { kind: 'Name', value: 'response' } },
{ kind: 'Field', name: { kind: 'Name', value: 'responseCreatedAt' } },
],
},
},
],
} as unknown as DocumentNode<UpdateReviewMutation, UpdateReviewMutationVariables>;
export const ApproveReviewDocument = {
kind: 'Document',
definitions: [
{
kind: 'OperationDefinition',
operation: 'mutation',
name: { kind: 'Name', value: 'ApproveReview' },
variableDefinitions: [
{
kind: 'VariableDefinition',
variable: { kind: 'Variable', name: { kind: 'Name', value: 'id' } },
type: {
kind: 'NonNullType',
type: { kind: 'NamedType', name: { kind: 'Name', value: 'ID' } },
},
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'approveProductReview' },
arguments: [
{
kind: 'Argument',
name: { kind: 'Name', value: 'id' },
value: { kind: 'Variable', name: { kind: 'Name', value: 'id' } },
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
{ kind: 'Field', name: { kind: 'Name', value: 'state' } },
{
kind: 'Field',
name: { kind: 'Name', value: 'product' },
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
{
kind: 'Field',
name: { kind: 'Name', value: 'customFields' },
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'reviewCount' },
},
{
kind: 'Field',
name: { kind: 'Name', value: 'reviewRating' },
},
],
},
},
],
},
},
],
},
},
],
},
},
],
} as unknown as DocumentNode<ApproveReviewMutation, ApproveReviewMutationVariables>;
export const RejectReviewDocument = {
kind: 'Document',
definitions: [
{
kind: 'OperationDefinition',
operation: 'mutation',
name: { kind: 'Name', value: 'RejectReview' },
variableDefinitions: [
{
kind: 'VariableDefinition',
variable: { kind: 'Variable', name: { kind: 'Name', value: 'id' } },
type: {
kind: 'NonNullType',
type: { kind: 'NamedType', name: { kind: 'Name', value: 'ID' } },
},
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'rejectProductReview' },
arguments: [
{
kind: 'Argument',
name: { kind: 'Name', value: 'id' },
value: { kind: 'Variable', name: { kind: 'Name', value: 'id' } },
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
{ kind: 'Field', name: { kind: 'Name', value: 'state' } },
],
},
},
],
},
},
],
} as unknown as DocumentNode<RejectReviewMutation, RejectReviewMutationVariables>;
export const GetReviewForProductDocument = {
kind: 'Document',
definitions: [
{
kind: 'OperationDefinition',
operation: 'query',
name: { kind: 'Name', value: 'GetReviewForProduct' },
variableDefinitions: [
{
kind: 'VariableDefinition',
variable: { kind: 'Variable', name: { kind: 'Name', value: 'productId' } },
type: {
kind: 'NonNullType',
type: { kind: 'NamedType', name: { kind: 'Name', value: 'ID' } },
},
},
{
kind: 'VariableDefinition',
variable: { kind: 'Variable', name: { kind: 'Name', value: 'options' } },
type: { kind: 'NamedType', name: { kind: 'Name', value: 'ProductReviewListOptions' } },
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'product' },
arguments: [
{
kind: 'Argument',
name: { kind: 'Name', value: 'id' },
value: { kind: 'Variable', name: { kind: 'Name', value: 'productId' } },
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
{
kind: 'Field',
name: { kind: 'Name', value: 'reviews' },
arguments: [
{
kind: 'Argument',
name: { kind: 'Name', value: 'options' },
value: {
kind: 'Variable',
name: { kind: 'Name', value: 'options' },
},
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'items' },
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'FragmentSpread',
name: { kind: 'Name', value: 'ProductReview' },
},
],
},
},
{ kind: 'Field', name: { kind: 'Name', value: 'totalItems' } },
],
},
},
],
},
},
],
},
},
{
kind: 'FragmentDefinition',
name: { kind: 'Name', value: 'ProductReview' },
typeCondition: { kind: 'NamedType', name: { kind: 'Name', value: 'ProductReview' } },
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
{ kind: 'Field', name: { kind: 'Name', value: 'createdAt' } },
{ kind: 'Field', name: { kind: 'Name', value: 'updatedAt' } },
{ kind: 'Field', name: { kind: 'Name', value: 'authorName' } },
{ kind: 'Field', name: { kind: 'Name', value: 'authorLocation' } },
{ kind: 'Field', name: { kind: 'Name', value: 'summary' } },
{ kind: 'Field', name: { kind: 'Name', value: 'body' } },
{ kind: 'Field', name: { kind: 'Name', value: 'rating' } },
{ kind: 'Field', name: { kind: 'Name', value: 'state' } },
{ kind: 'Field', name: { kind: 'Name', value: 'upvotes' } },
{ kind: 'Field', name: { kind: 'Name', value: 'downvotes' } },
{ kind: 'Field', name: { kind: 'Name', value: 'response' } },
{ kind: 'Field', name: { kind: 'Name', value: 'responseCreatedAt' } },
],
},
},
],
} as unknown as DocumentNode<GetReviewForProductQuery, GetReviewForProductQueryVariables>;
export const GetReviewsHistogramDocument = {
kind: 'Document',
definitions: [
{
kind: 'OperationDefinition',
operation: 'query',
name: { kind: 'Name', value: 'GetReviewsHistogram' },
variableDefinitions: [
{
kind: 'VariableDefinition',
variable: { kind: 'Variable', name: { kind: 'Name', value: 'id' } },
type: {
kind: 'NonNullType',
type: { kind: 'NamedType', name: { kind: 'Name', value: 'ID' } },
},
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'product' },
arguments: [
{
kind: 'Argument',
name: { kind: 'Name', value: 'id' },
value: { kind: 'Variable', name: { kind: 'Name', value: 'id' } },
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
{ kind: 'Field', name: { kind: 'Name', value: 'name' } },
{
kind: 'Field',
name: { kind: 'Name', value: 'featuredAsset' },
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
{ kind: 'Field', name: { kind: 'Name', value: 'preview' } },
],
},
},
{
kind: 'Field',
name: { kind: 'Name', value: 'customFields' },
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'reviewRating' } },
{ kind: 'Field', name: { kind: 'Name', value: 'reviewCount' } },
],
},
},
{
kind: 'Field',
name: { kind: 'Name', value: 'reviewsHistogram' },
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'bin' } },
{ kind: 'Field', name: { kind: 'Name', value: 'frequency' } },
],
},
},
],
},
},
],
},
},
],
} as unknown as DocumentNode<GetReviewsHistogramQuery, GetReviewsHistogramQueryVariables>;
export const GetProductNameDocument = {
kind: 'Document',
definitions: [
{
kind: 'OperationDefinition',
operation: 'query',
name: { kind: 'Name', value: 'GetProductName' },
variableDefinitions: [
{
kind: 'VariableDefinition',
variable: { kind: 'Variable', name: { kind: 'Name', value: 'id' } },
type: {
kind: 'NonNullType',
type: { kind: 'NamedType', name: { kind: 'Name', value: 'ID' } },
},
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'product' },
arguments: [
{
kind: 'Argument',
name: { kind: 'Name', value: 'id' },
value: { kind: 'Variable', name: { kind: 'Name', value: 'id' } },
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
{ kind: 'Field', name: { kind: 'Name', value: 'name' } },
],
},
},
],
},
},
],
} as unknown as DocumentNode<GetProductNameQuery, GetProductNameQueryVariables>;
export const GetReviewsForWidgetDocument = {
kind: 'Document',
definitions: [
{
kind: 'OperationDefinition',
operation: 'query',
name: { kind: 'Name', value: 'GetReviewsForWidget' },
variableDefinitions: [
{
kind: 'VariableDefinition',
variable: { kind: 'Variable', name: { kind: 'Name', value: 'options' } },
type: { kind: 'NamedType', name: { kind: 'Name', value: 'ProductReviewListOptions' } },
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'productReviews' },
arguments: [
{
kind: 'Argument',
name: { kind: 'Name', value: 'options' },
value: { kind: 'Variable', name: { kind: 'Name', value: 'options' } },
},
],
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'items' },
selectionSet: {
kind: 'SelectionSet',
selections: [
{ kind: 'Field', name: { kind: 'Name', value: 'id' } },
{ kind: 'Field', name: { kind: 'Name', value: 'authorName' } },
{ kind: 'Field', name: { kind: 'Name', value: 'summary' } },
{ kind: 'Field', name: { kind: 'Name', value: 'rating' } },
{ kind: 'Field', name: { kind: 'Name', value: 'state' } },
{ kind: 'Field', name: { kind: 'Name', value: 'createdAt' } },
{
kind: 'Field',
name: { kind: 'Name', value: 'product' },
selectionSet: {
kind: 'SelectionSet',
selections: [
{
kind: 'Field',
name: { kind: 'Name', value: 'id' },
},
{
kind: 'Field',
name: { kind: 'Name', value: 'name' },
},
],
},
},
],
},
},
{ kind: 'Field', name: { kind: 'Name', value: 'totalItems' } },
],
},
},
],
},
},
],
} as unknown as DocumentNode<GetReviewsForWidgetQuery, GetReviewsForWidgetQueryVariables>;
|
import {
addNavMenuItem,
registerDashboardWidget,
registerFormInputComponent,
registerPageTab,
setDashboardWidgetLayout,
} from '@vendure/admin-ui/core';
import { RelationReviewInputComponent } from './components/featured-review-selector/featured-review-selector.component';
import { ProductReviewsListComponent } from './components/product-reviews-list/product-reviews-list.component';
import { ReviewCountLinkComponent } from './components/review-count-link/review-count-link.component';
import { StarRatingComponent } from './components/star-rating/star-rating.component';
export default [
registerFormInputComponent('review-count-link', ReviewCountLinkComponent),
registerFormInputComponent('star-rating-form-input', StarRatingComponent),
registerFormInputComponent('review-selector-form-input', RelationReviewInputComponent),
addNavMenuItem(
{
id: 'reviews',
label: 'Product reviews',
routerLink: ['/extensions/product-reviews'],
icon: 'star',
},
'marketing',
),
registerDashboardWidget('reviews', {
title: 'Latest reviews',
supportedWidths: [4, 6, 8, 12],
loadComponent: () => import('./widgets/reviews-widget/reviews-widget.component').then(m => m.default),
}),
setDashboardWidgetLayout([
{ id: 'metrics', width: 12 },
{ id: 'orderSummary', width: 6 },
{ id: 'reviews', width: 6 },
{ id: 'latestOrders', width: 12 },
]),
registerPageTab({
location: 'product-detail',
route: 'reviews',
tab: 'Reviews',
tabIcon: 'star',
component: ProductReviewsListComponent,
}),
];
|
import { registerRouteComponent } from '@vendure/admin-ui/core';
import { registerReactRouteComponent } from '@vendure/admin-ui/react';
import { AllProductReviewsListComponent } from './components/all-product-reviews-list/all-product-reviews-list.component';
import { ProductReviewDetailComponent } from './components/product-review-detail/product-review-detail.component';
import { GetReviewDetailDocument } from './generated-types';
import { AllProductReviewsList } from './react/AllProductReviewsList';
export default [
// registerRouteComponent({
// path: '',
// component: AllProductReviewsListComponent,
// breadcrumb: 'Product reviews',
// }),
registerReactRouteComponent({
path: '',
component: AllProductReviewsList,
breadcrumb: 'Product reviews',
}),
registerRouteComponent({
path: ':id',
component: ProductReviewDetailComponent,
query: GetReviewDetailDocument,
entityKey: 'productReview',
getBreadcrumbs: entity => [
{
label: 'Product reviews',
link: ['/extensions', 'product-reviews'],
},
{
label: `#${entity?.id} (${entity?.product.name})`,
link: [],
},
],
}),
];
|
import gql from 'graphql-tag';
export const PRODUCT_REVIEW_FRAGMENT = gql`
fragment ProductReview on ProductReview {
id
createdAt
updatedAt
authorName
authorLocation
summary
body
rating
state
upvotes
downvotes
response
responseCreatedAt
}
`;
|
export type ReviewState = 'new' | 'approved' | 'rejected';
|
import { ChangeDetectionStrategy, Component } from '@angular/core';
import { SharedModule, TypedBaseListComponent } from '@vendure/admin-ui/core';
import gql from 'graphql-tag';
import { PRODUCT_REVIEW_FRAGMENT } from '../../common/fragments.graphql';
import { GetAllReviewsDocument } from '../../generated-types';
import { ReviewStateLabelComponent } from '../review-state-label/review-state-label.component';
import { StarRatingComponent } from '../star-rating/star-rating.component';
export const GET_ALL_REVIEWS = gql`
query GetAllReviews($options: ProductReviewListOptions) {
productReviews(options: $options) {
items {
...ProductReview
product {
id
name
featuredAsset {
id
preview
}
}
}
totalItems
}
}
${PRODUCT_REVIEW_FRAGMENT}
`;
@Component({
selector: 'all-product-reviews-list',
templateUrl: './all-product-reviews-list.component.html',
styleUrls: ['./all-product-reviews-list.component.scss'],
changeDetection: ChangeDetectionStrategy.OnPush,
standalone: true,
imports: [SharedModule, StarRatingComponent, ReviewStateLabelComponent],
})
export class AllProductReviewsListComponent extends TypedBaseListComponent<
typeof GetAllReviewsDocument,
'productReviews'
> {
filteredState: string | null = 'new';
// Here we set up the filters that will be available
// to use in the data table
readonly filters = this.createFilterCollection()
.addDateFilters()
.addFilter({
name: 'summary',
type: { kind: 'text' },
label: 'Summary',
filterField: 'summary',
})
.addFilter({
name: 'rating',
type: { kind: 'number' },
label: 'Rating',
filterField: 'rating',
})
.addFilter({
name: 'state',
type: {
kind: 'select',
options: [
{ value: 'new', label: 'New' },
{ value: 'approved', label: 'Approved' },
{ value: 'rejected', label: 'Rejected' },
],
},
label: 'State',
filterField: 'state',
})
.addFilter({
name: 'authorName',
type: { kind: 'text' },
label: 'Author',
filterField: 'authorName',
})
.addFilter({
name: 'authorLocation',
type: { kind: 'text' },
label: 'Location',
filterField: 'authorLocation',
})
.addFilter({
name: 'upvotes',
type: { kind: 'number' },
label: 'Upvotes',
filterField: 'upvotes',
})
.addFilter({
name: 'downvotes',
type: { kind: 'number' },
label: 'Downvotes',
filterField: 'downvotes',
})
.connectToRoute(this.route);
// Here we set up the sorting options that will be available
// to use in the data table
readonly sorts = this.createSortCollection()
.defaultSort('createdAt', 'DESC')
.addSort({ name: 'createdAt' })
.addSort({ name: 'updatedAt' })
.addSort({ name: 'summary' })
.addSort({ name: 'state' })
.addSort({ name: 'upvotes' })
.addSort({ name: 'downvotes' })
.addSort({ name: 'rating' })
.addSort({ name: 'authorName' })
.addSort({ name: 'authorLocation' })
.connectToRoute(this.route);
constructor() {
super();
super.configure({
document: GetAllReviewsDocument,
getItems: data => data.productReviews,
setVariables: (skip, take) => ({
options: {
skip,
take,
filter: {
authorName: {
contains: this.searchTermControl.value ?? undefined,
},
...this.filters.createFilterInput(),
},
sort: this.sorts.createSortInput(),
},
}),
refreshListOnChanges: [this.filters.valueChanges, this.sorts.valueChanges],
});
}
}
|
import { ChangeDetectionStrategy, Component, Input, OnInit } from '@angular/core';
import { FormControl } from '@angular/forms';
import { ActivatedRoute } from '@angular/router';
import { CustomFieldControl, DataService, SharedModule } from '@vendure/admin-ui/core';
import { Observable } from 'rxjs';
import { switchMap } from 'rxjs/operators';
import { GetReviewForProductDocument, ProductReviewFragment } from '../../generated-types';
@Component({
selector: 'kb-relation-review-input',
template: `
<div *ngIf="formControl.value as review">
<vdr-chip>{{ review.rating }} / 5</vdr-chip>
{{ review.summary }}
<a [routerLink]="['/extensions', 'product-reviews', review.id]">
<clr-icon shape="link"></clr-icon>
</a>
</div>
<select class="mt-1" [formControl]="formControl">
<option [ngValue]="null">Select a review...</option>
<option *ngFor="let item of reviews$ | async" [ngValue]="item">
<b>{{ item.summary }}</b>
{{ item.rating }} / 5
</option>
</select>
`,
changeDetection: ChangeDetectionStrategy.OnPush,
standalone: true,
imports: [SharedModule],
})
export class RelationReviewInputComponent implements OnInit, CustomFieldControl {
@Input() readonly: boolean;
@Input() formControl: FormControl;
@Input() config: any;
reviews$: Observable<ProductReviewFragment[]>;
constructor(private dataService: DataService, private route: ActivatedRoute) {}
ngOnInit() {
this.reviews$ = this.route.data.pipe(
switchMap(data => data.detail.entity),
switchMap((product: any) => {
return this.dataService
.query(GetReviewForProductDocument, {
productId: product.id,
})
.mapSingle(({ product }) => product?.reviews.items ?? []);
}),
);
}
}
|
import { ChangeDetectionStrategy, ChangeDetectorRef, Component, OnDestroy, OnInit } from '@angular/core';
import { FormBuilder, Validators } from '@angular/forms';
import {
DataService,
NotificationService,
SharedModule,
TypedBaseDetailComponent,
} from '@vendure/admin-ui/core';
import gql from 'graphql-tag';
import { Observable, of } from 'rxjs';
import { filter, map, mapTo, switchMap } from 'rxjs/operators';
import { PRODUCT_REVIEW_FRAGMENT } from '../../common/fragments.graphql';
import { ReviewState } from '../../common/ui-types';
import {
ApproveReviewDocument,
GetReviewDetailDocument,
ProductReviewFragment,
RejectReviewDocument,
UpdateProductReviewInput,
UpdateReviewDocument,
} from '../../generated-types';
import { ReviewStateLabelComponent } from '../review-state-label/review-state-label.component';
import { StarRatingComponent } from '../star-rating/star-rating.component';
export const GET_REVIEW_DETAIL = gql`
query GetReviewDetail($id: ID!) {
productReview(id: $id) {
...ProductReview
product {
id
name
featuredAsset {
id
preview
}
}
productVariant {
id
name
featuredAsset {
id
preview
}
}
}
}
${PRODUCT_REVIEW_FRAGMENT}
`;
@Component({
selector: 'product-review-detail',
templateUrl: './product-review-detail.component.html',
styleUrls: ['./product-review-detail.component.scss'],
changeDetection: ChangeDetectionStrategy.Default,
standalone: true,
imports: [SharedModule, StarRatingComponent, ReviewStateLabelComponent],
})
export class ProductReviewDetailComponent
extends TypedBaseDetailComponent<typeof GetReviewDetailDocument, 'productReview'>
implements OnInit, OnDestroy
{
detailForm = this.formBuilder.group({
summary: ['', Validators.required],
body: '',
rating: [0, Validators.required],
authorName: ['', Validators.required],
authorLocation: '',
state: '',
response: '',
});
reviewState$: Observable<ReviewState>;
constructor(
private formBuilder: FormBuilder,
protected dataService: DataService,
private changeDetector: ChangeDetectorRef,
private notificationService: NotificationService,
) {
super();
}
ngOnInit(): void {
this.init();
this.reviewState$ = this.entity$.pipe(map(review => review.state as ReviewState));
}
ngOnDestroy(): void {
this.destroy();
}
approve() {
this.saveChanges()
.pipe(switchMap(() => this.dataService.mutate(ApproveReviewDocument, { id: this.id })))
.subscribe(
() => {
this.detailForm.markAsPristine();
this.changeDetector.markForCheck();
this.notificationService.success('Review was approved');
},
() => {
this.notificationService.error('An error occurred when attempting to approve the review');
},
);
}
reject() {
this.saveChanges()
.pipe(switchMap(() => this.dataService.mutate(RejectReviewDocument, { id: this.id })))
.subscribe(
() => {
this.detailForm.markAsPristine();
this.changeDetector.markForCheck();
this.notificationService.success('Review was rejected');
},
() => {
this.notificationService.error('An error occurred when attempting to reject the review');
},
);
}
save() {
this.saveChanges()
.pipe(filter(result => !!result))
.subscribe(
() => {
this.detailForm.markAsPristine();
this.changeDetector.markForCheck();
this.notificationService.success('common.notify-update-success', {
entity: 'ProductReview',
});
},
() => {
this.notificationService.error('common.notify-update-error', {
entity: 'ProductReview',
});
},
);
}
private saveChanges(): Observable<boolean> {
if (this.detailForm.dirty) {
const { summary, body, response } = this.detailForm.value;
const input: UpdateProductReviewInput = {
id: this.id,
summary: summary ?? undefined,
body: body ?? undefined,
response: response ?? undefined,
};
return this.dataService.mutate(UpdateReviewDocument, { input }).pipe(mapTo(true));
} else {
return of(false);
}
}
protected setFormValues(entity: ProductReviewFragment): void {
this.detailForm.patchValue({
summary: entity.summary,
body: entity.body,
rating: entity.rating,
authorName: entity.authorName,
authorLocation: entity.authorLocation,
state: entity.state,
response: entity.response,
});
}
}
|
import gql from 'graphql-tag';
import { PRODUCT_REVIEW_FRAGMENT } from '../../common/fragments.graphql';
export const UPDATE_REVIEW = gql`
mutation UpdateReview($input: UpdateProductReviewInput!) {
updateProductReview(input: $input) {
...ProductReview
}
}
${PRODUCT_REVIEW_FRAGMENT}
`;
export const APPROVE_REVIEW = gql`
mutation ApproveReview($id: ID!) {
approveProductReview(id: $id) {
id
state
product {
id
customFields {
reviewCount
reviewRating
}
}
}
}
`;
export const REJECT_REVIEW = gql`
mutation RejectReview($id: ID!) {
rejectProductReview(id: $id) {
id
state
}
}
`;
|
import { ChangeDetectionStrategy, Component, OnInit } from '@angular/core';
import { ActivatedRoute, Router } from '@angular/router';
import {
BaseListComponent,
DataService,
DataTableFilterCollection,
DataTableSortCollection,
ItemOf,
SharedModule,
} from '@vendure/admin-ui/core';
import gql from 'graphql-tag';
import { Observable } from 'rxjs';
import { map, shareReplay } from 'rxjs/operators';
import { PRODUCT_REVIEW_FRAGMENT } from '../../common/fragments.graphql';
import {
GetReviewForProductDocument,
GetReviewForProductQuery,
GetReviewForProductQueryVariables,
GetReviewsHistogramDocument,
GetReviewsHistogramQuery,
ProductReviewFilterParameter,
ProductReviewHistogramItem,
ProductReviewSortParameter,
} from '../../generated-types';
import { ReviewHistogramComponent } from '../review-histogram/review-histogram.component';
import { StarRatingComponent } from '../star-rating/star-rating.component';
export const GET_REVIEWS_FOR_PRODUCT = gql`
query GetReviewForProduct($productId: ID!, $options: ProductReviewListOptions) {
product(id: $productId) {
id
reviews(options: $options) {
items {
...ProductReview
}
totalItems
}
}
}
${PRODUCT_REVIEW_FRAGMENT}
`;
export const GET_PRODUCT_PREVIEW_AND_HISTOGRAM = gql`
query GetReviewsHistogram($id: ID!) {
product(id: $id) {
id
name
featuredAsset {
id
preview
}
customFields {
reviewRating
reviewCount
}
reviewsHistogram {
bin
frequency
}
}
}
`;
@Component({
selector: 'product-reviews-list',
templateUrl: './product-reviews-list.component.html',
styleUrls: ['./product-reviews-list.component.scss'],
changeDetection: ChangeDetectionStrategy.OnPush,
standalone: true,
imports: [SharedModule, StarRatingComponent, ReviewHistogramComponent],
})
export class ProductReviewsListComponent
extends BaseListComponent<
GetReviewForProductQuery,
ItemOf<NonNullable<GetReviewForProductQuery['product']>, 'reviews'>,
GetReviewForProductQueryVariables
>
implements OnInit
{
histogramBinData$: Observable<ProductReviewHistogramItem[]>;
product$: Observable<GetReviewsHistogramQuery['product'] | null>;
private filteredRating: number | null;
// Here we set up the filters that will be available
// to use in the data table
readonly filters = new DataTableFilterCollection<ProductReviewFilterParameter>(this.router)
.addDateFilters()
.addFilter({
name: 'summary',
type: { kind: 'text' },
label: 'Summary',
filterField: 'summary',
})
.addFilter({
name: 'rating',
type: { kind: 'number' },
label: 'Rating',
filterField: 'rating',
})
.addFilter({
name: 'state',
type: {
kind: 'select',
options: [
{ value: 'new', label: 'New' },
{ value: 'approved', label: 'Approved' },
{ value: 'rejected', label: 'Rejected' },
],
},
label: 'State',
filterField: 'state',
})
.addFilter({
name: 'authorName',
type: { kind: 'text' },
label: 'Author',
filterField: 'authorName',
})
.addFilter({
name: 'authorLocation',
type: { kind: 'text' },
label: 'Location',
filterField: 'authorLocation',
})
.addFilter({
name: 'upvotes',
type: { kind: 'number' },
label: 'Upvotes',
filterField: 'upvotes',
})
.addFilter({
name: 'downvotes',
type: { kind: 'number' },
label: 'Downvotes',
filterField: 'downvotes',
})
.connectToRoute(this.route);
// Here we set up the sorting options that will be available
// to use in the data table
readonly sorts = new DataTableSortCollection<ProductReviewSortParameter>(this.router)
.defaultSort('createdAt', 'DESC')
.addSort({ name: 'createdAt' })
.addSort({ name: 'updatedAt' })
.addSort({ name: 'summary' })
.addSort({ name: 'state' })
.addSort({ name: 'upvotes' })
.addSort({ name: 'downvotes' })
.addSort({ name: 'rating' })
.addSort({ name: 'authorName' })
.addSort({ name: 'authorLocation' })
.connectToRoute(this.route);
constructor(private dataService: DataService, protected router: Router, route: ActivatedRoute) {
super(router, route);
super.setQueryFn(
(...args: any) => {
return this.dataService.query(GetReviewForProductDocument, args);
},
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
data => data.product!.reviews,
(skip, take) => {
return {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
productId: route.snapshot.parent!.paramMap.get('id')!,
options: {
skip,
take,
sort: this.sorts.createSortInput(),
filter: {
authorName: {
contains: this.searchTermControl.value ?? undefined,
},
...this.filters.createFilterInput(),
},
},
};
},
);
}
ngOnInit() {
super.ngOnInit();
const productWithHistogram$ = this.dataService
.query(GetReviewsHistogramDocument, {
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
id: this.route.snapshot.parent!.paramMap.get('id')! || '',
})
.single$.pipe(shareReplay(1));
this.histogramBinData$ = productWithHistogram$.pipe(
map(data => (data.product ? data.product.reviewsHistogram : [])),
);
this.product$ = productWithHistogram$.pipe(map(data => data.product));
this.refreshListOnChanges(this.filters.valueChanges, this.sorts.valueChanges);
}
applyRatingFilters(filteredBin: number) {
this.filteredRating = filteredBin;
this.refresh();
}
}
|
import { ChangeDetectionStrategy, Component } from '@angular/core';
import { FormControl } from '@angular/forms';
import { CustomFieldConfigType, CustomFieldControl, SharedModule } from '@vendure/admin-ui/core';
@Component({
selector: 'review-count-link',
template: ` {{ formControl.value }} `,
styles: [``],
changeDetection: ChangeDetectionStrategy.OnPush,
standalone: true,
imports: [SharedModule],
})
export class ReviewCountLinkComponent implements CustomFieldControl {
readonly: boolean;
config: CustomFieldConfigType;
formControl: FormControl;
}
|
import { ChangeDetectionStrategy, Component, Input, OnChanges, Output, EventEmitter } from '@angular/core';
import { SharedModule } from '@vendure/admin-ui/core';
import { ProductReviewHistogramItem } from '../../generated-types';
import { StarRatingComponent } from '../star-rating/star-rating.component';
@Component({
selector: 'review-histogram',
templateUrl: './review-histogram.component.html',
styleUrls: ['./review-histogram.component.scss'],
changeDetection: ChangeDetectionStrategy.OnPush,
standalone: true,
imports: [SharedModule, StarRatingComponent],
})
export class ReviewHistogramComponent implements OnChanges {
@Input() binData: ProductReviewHistogramItem[] | null = [];
@Output() filterChange = new EventEmitter<number | null>();
bins = [5, 4, 3, 2, 1];
filteredBin: number | null = null;
private max: number;
ngOnChanges() {
this.max = this.binData ? Math.max(...this.binData.map(d => d.frequency)) : 0;
}
getPercentage(bin: number): number {
if (!this.binData) {
return 0;
}
const data = this.binData.find(d => d.bin === bin);
if (!data) {
return 0;
}
return Math.round((data.frequency / this.max) * 100);
}
getFrequency(bin: number): number {
if (!this.binData) {
return 0;
}
const data = this.binData.find(d => d.bin === bin);
if (!data) {
return 0;
}
return data.frequency;
}
toggleBinFilter(bin: number) {
if (this.filteredBin === bin) {
this.filteredBin = null;
} else {
this.filteredBin = bin;
}
this.filterChange.emit(this.filteredBin);
}
}
|
import { ChangeDetectionStrategy, Component, Input } from '@angular/core';
import { SharedModule } from '@vendure/admin-ui/core';
import { ReviewState } from '../../common/ui-types';
@Component({
selector: 'review-state-label',
templateUrl: './review-state-label.component.html',
styleUrls: ['./review-state-label.component.scss'],
changeDetection: ChangeDetectionStrategy.OnPush,
standalone: true,
imports: [SharedModule],
})
export class ReviewStateLabelComponent {
@Input() state: ReviewState;
getIcon(state: ReviewState) {
switch (state) {
case 'new':
return 'bubble-exclamation';
case 'approved':
return 'check-circle';
case 'rejected':
return 'times-circle';
}
}
}
|
import { ChangeDetectionStrategy, Component, Input } from '@angular/core';
import { FormControl } from '@angular/forms';
import { CustomFieldConfigType, CustomFieldControl, SharedModule } from '@vendure/admin-ui/core';
type StarType = 'empty' | 'full' | 'half';
@Component({
selector: 'star-rating',
templateUrl: './star-rating.component.html',
styleUrls: ['./star-rating.component.scss'],
changeDetection: ChangeDetectionStrategy.Default,
standalone: true,
imports: [SharedModule],
})
export class StarRatingComponent implements CustomFieldControl {
@Input() rating: number | null;
@Input() showLabel = false;
readonly: boolean;
config: CustomFieldConfigType;
formControl: FormControl;
get starRating(): number {
return this.formControl ? this.formControl.value : this.rating;
}
get stars(): StarType[] {
const rating = this.starRating;
return Array.from({ length: 5 }).map((_, i) => {
const pos = i + 1;
const filled = rating >= pos;
if (filled) {
return 'full';
}
if (Math.ceil(rating) < pos) {
return 'empty';
}
return 'half';
});
}
}
|
import { ChangeDetectionStrategy, Component, OnInit } from '@angular/core';
import { DataService, ItemOf, SharedModule } from '@vendure/admin-ui/core';
import gql from 'graphql-tag';
import { Observable } from 'rxjs';
import { ReviewStateLabelComponent } from '../../components/review-state-label/review-state-label.component';
import { StarRatingComponent } from '../../components/star-rating/star-rating.component';
import { GetReviewsForWidgetDocument, GetReviewsForWidgetQuery } from '../../generated-types';
const GET_REVIEWS_FOR_WIDGET = gql`
query GetReviewsForWidget($options: ProductReviewListOptions) {
productReviews(options: $options) {
items {
id
authorName
summary
rating
state
createdAt
product {
id
name
}
}
totalItems
}
}
`;
@Component({
selector: 'vdr-reviews-widget',
templateUrl: './reviews-widget.component.html',
styleUrls: ['./reviews-widget.component.scss'],
changeDetection: ChangeDetectionStrategy.OnPush,
standalone: true,
imports: [SharedModule, StarRatingComponent, ReviewStateLabelComponent],
})
export default class ReviewsWidgetComponent implements OnInit {
pendingReviews$: Observable<Array<ItemOf<GetReviewsForWidgetQuery, 'productReviews'>>>;
constructor(private dataService: DataService) {}
ngOnInit() {
this.pendingReviews$ = this.dataService
.query(GetReviewsForWidgetDocument, {
options: {
filter: {
state: {
eq: 'new',
},
},
take: 10,
},
})
.mapStream(data => data.productReviews.items);
}
}
|
import { NgModule } from '@angular/core';
import { RouterModule } from '@angular/router';
import { hostExternalFrame } from '@vendure/admin-ui/core';
@NgModule({
imports: [
RouterModule.forChild([
hostExternalFrame({
path: '',
breadcrumbLabel: 'Test',
extensionUrl: './assets/external-app/index.html',
openInNewTab: false,
}),
]),
],
})
export class ExternalUiExtensionModule {}
|
import { NgModule } from '@angular/core';
import { addNavMenuSection, SharedModule } from '@vendure/admin-ui/core';
@NgModule({
imports: [SharedModule],
providers: [
addNavMenuSection(
{
id: 'greeter',
label: 'My Extensions',
items: [
{
id: 'greeter',
label: 'Greeter',
routerLink: ['/extensions/greet'],
// Icon can be any of https://clarity.design/icons
icon: 'cursor-hand-open',
},
],
},
// Add this section before the "settings" section
'settings',
),
],
})
export class GreeterSharedModule {}
|
// project/ui-extensions/greeter.component.ts
import { Component } from '@angular/core';
@Component({
selector: 'greeter',
template: '<h1>{{ greeting }}</h1>',
})
export class GreeterComponent {
greeting = 'Hello!';
}
|
import { NgModule } from '@angular/core';
import { RouterModule } from '@angular/router';
import { SharedModule } from '@vendure/admin-ui/core';
import { GreeterComponent } from './greeter.component';
@NgModule({
imports: [
SharedModule,
RouterModule.forChild([
{
path: '',
pathMatch: 'full',
component: GreeterComponent,
data: { breadcrumb: 'Greeter' },
},
]),
],
declarations: [GreeterComponent],
})
export class GreeterModule {}
|
export * from './src/plugin';
export * from './src/options';
export * from './src/types';
|
import { Client } from '@elastic/elasticsearch';
import { SortOrder } from '@vendure/common/lib/generated-types';
import { SimpleGraphQLClient } from '@vendure/testing';
import { expect } from 'vitest';
import { SearchGetPricesQuery, SearchInput } from '../../core/e2e/graphql/generated-e2e-admin-types';
import {
LogicalOperator,
SearchProductsShopQuery,
SearchProductsShopQueryVariables,
} from '../../core/e2e/graphql/generated-e2e-shop-types';
import { SEARCH_PRODUCTS_SHOP } from '../../core/e2e/graphql/shop-definitions';
import { deleteIndices } from '../src/indexing/indexing-utils';
import { SEARCH_GET_PRICES, SEARCH_PRODUCTS } from './elasticsearch-plugin.e2e-spec';
import {
SearchGetPricesQueryVariables,
SearchProductsAdminQuery,
SearchProductsAdminQueryVariables,
} from './graphql/generated-e2e-elasticsearch-plugin-types';
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { elasticsearchHost, elasticsearchPort } = require('./constants');
export function doAdminSearchQuery(client: SimpleGraphQLClient, input: SearchInput) {
return client.query<SearchProductsAdminQuery, SearchProductsAdminQueryVariables>(SEARCH_PRODUCTS, {
input,
});
}
export async function testGroupByProduct(client: SimpleGraphQLClient) {
const result = await client.query<SearchProductsShopQuery, SearchProductsShopQueryVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: true,
},
},
);
expect(result.search.totalItems).toBe(20);
}
export async function testNoGrouping(client: SimpleGraphQLClient) {
const result = await client.query<SearchProductsShopQuery, SearchProductsShopQueryVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: false,
},
},
);
expect(result.search.totalItems).toBe(34);
}
export async function testMatchSearchTerm(client: SimpleGraphQLClient) {
const result = await client.query<SearchProductsShopQuery, SearchProductsShopQueryVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
term: 'camera',
groupByProduct: true,
},
},
);
expect(result.search.items.map(i => i.productName)).toEqual([
'Instant Camera',
'Camera Lens',
'SLR Camera',
]);
}
export async function testMatchFacetIdsAnd(client: SimpleGraphQLClient) {
const result = await client.query<SearchProductsShopQuery, SearchProductsShopQueryVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
facetValueIds: ['T_1', 'T_2'],
facetValueOperator: LogicalOperator.AND,
groupByProduct: true,
sort: {
name: SortOrder.ASC,
},
},
},
);
expect(result.search.items.map(i => i.productName)).toEqual([
'Clacky Keyboard',
'Curvy Monitor',
'Gaming PC',
'Hard Drive',
'Laptop',
'USB Cable',
]);
}
export async function testMatchFacetIdsOr(client: SimpleGraphQLClient) {
const result = await client.query<SearchProductsShopQuery, SearchProductsShopQueryVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
facetValueIds: ['T_1', 'T_5'],
facetValueOperator: LogicalOperator.OR,
groupByProduct: true,
sort: {
name: SortOrder.ASC,
},
take: 20,
},
},
);
expect(result.search.items.map(i => i.productName)).toEqual([
'Bonsai Tree',
'Camera Lens',
'Clacky Keyboard',
'Curvy Monitor',
'Gaming PC',
'Hard Drive',
'Instant Camera',
'Laptop',
'Orchid',
'SLR Camera',
'Spiky Cactus',
'Tripod',
'USB Cable',
]);
}
export async function testMatchFacetValueFiltersAnd(client: SimpleGraphQLClient) {
const result = await client.query<SearchProductsShopQuery, SearchProductsShopQueryVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: true,
facetValueFilters: [{ and: 'T_1' }, { and: 'T_2' }],
},
},
);
expect(result.search.items.map(i => i.productName).sort()).toEqual(
['Laptop', 'Curvy Monitor', 'Gaming PC', 'Hard Drive', 'Clacky Keyboard', 'USB Cable'].sort(),
);
}
export async function testMatchFacetValueFiltersOr(client: SimpleGraphQLClient) {
const result = await client.query<SearchProductsShopQuery, SearchProductsShopQueryVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: true,
facetValueFilters: [{ or: ['T_1', 'T_5'] }],
sort: {
name: SortOrder.ASC,
},
take: 20,
},
},
);
expect(result.search.items.map(i => i.productName).sort()).toEqual(
[
'Bonsai Tree',
'Camera Lens',
'Clacky Keyboard',
'Curvy Monitor',
'Gaming PC',
'Hard Drive',
'Instant Camera',
'Laptop',
'Orchid',
'SLR Camera',
'Spiky Cactus',
'Tripod',
'USB Cable',
].sort(),
);
}
export async function testMatchFacetValueFiltersOrWithAnd(client: SimpleGraphQLClient) {
const result = await client.query<SearchProductsShopQuery, SearchProductsShopQueryVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: true,
facetValueFilters: [{ and: 'T_1' }, { or: ['T_2', 'T_3'] }],
},
},
);
expect(result.search.items.map(i => i.productName).sort()).toEqual(
[
'Laptop',
'Curvy Monitor',
'Gaming PC',
'Hard Drive',
'Clacky Keyboard',
'USB Cable',
'Instant Camera',
'Camera Lens',
'Tripod',
'SLR Camera',
].sort(),
);
}
export async function testMatchFacetValueFiltersWithFacetIdsOr(client: SimpleGraphQLClient) {
const result = await client.query<SearchProductsShopQuery, SearchProductsShopQueryVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
facetValueIds: ['T_2', 'T_3'],
facetValueOperator: LogicalOperator.OR,
facetValueFilters: [{ and: 'T_1' }],
groupByProduct: true,
},
},
);
expect(result.search.items.map(i => i.productName).sort()).toEqual(
[
'Laptop',
'Curvy Monitor',
'Gaming PC',
'Hard Drive',
'Clacky Keyboard',
'USB Cable',
'Instant Camera',
'Camera Lens',
'Tripod',
'SLR Camera',
].sort(),
);
}
export async function testMatchFacetValueFiltersWithFacetIdsAnd(client: SimpleGraphQLClient) {
const result = await client.query<SearchProductsShopQuery, SearchProductsShopQueryVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
facetValueIds: ['T_1'],
facetValueFilters: [{ and: 'T_3' }],
facetValueOperator: LogicalOperator.AND,
groupByProduct: true,
},
},
);
expect(result.search.items.map(i => i.productName).sort()).toEqual(
['Instant Camera', 'Camera Lens', 'Tripod', 'SLR Camera'].sort(),
);
}
export async function testMatchCollectionId(client: SimpleGraphQLClient) {
const result = await client.query<SearchProductsShopQuery, SearchProductsShopQueryVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
collectionId: 'T_2',
groupByProduct: true,
},
},
);
expect(result.search.items.map(i => i.productName).sort()).toEqual([
'Bonsai Tree',
'Orchid',
'Spiky Cactus',
]);
}
export async function testMatchCollectionSlug(client: SimpleGraphQLClient) {
const result = await client.query<SearchProductsShopQuery, SearchProductsShopQueryVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
collectionSlug: 'plants',
groupByProduct: true,
},
},
);
expect(result.search.items.map(i => i.productName).sort()).toEqual([
'Bonsai Tree',
'Orchid',
'Spiky Cactus',
]);
}
export async function testSinglePrices(client: SimpleGraphQLClient) {
const result = await client.query<SearchGetPricesQuery, SearchGetPricesQueryVariables>(
SEARCH_GET_PRICES,
{
input: {
groupByProduct: false,
take: 3,
sort: {
price: SortOrder.ASC,
},
},
},
);
expect(result.search.items).toEqual([
{
price: { value: 799 },
priceWithTax: { value: 959 },
},
{
price: { value: 1498 },
priceWithTax: { value: 1798 },
},
{
price: { value: 1550 },
priceWithTax: { value: 1860 },
},
]);
}
export async function testPriceRanges(client: SimpleGraphQLClient) {
const result = await client.query<SearchGetPricesQuery, SearchGetPricesQueryVariables>(
SEARCH_GET_PRICES,
{
input: {
groupByProduct: true,
take: 3,
term: 'laptop',
},
},
);
expect(result.search.items).toEqual([
{
price: { min: 129900, max: 229900 },
priceWithTax: { min: 155880, max: 275880 },
},
]);
}
export async function dropElasticIndices(indexPrefix: string) {
const esClient = new Client({
node: `${elasticsearchHost as string}:${elasticsearchPort as string}`,
});
return deleteIndices(esClient, indexPrefix);
}
|
import { DefaultJobQueuePlugin, mergeConfig, UuidIdStrategy } from '@vendure/core';
import { createTestEnvironment } from '@vendure/testing';
import gql from 'graphql-tag';
import path from 'path';
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
import { initialData } from '../../../e2e-common/e2e-initial-data';
import { testConfig, TEST_SETUP_TIMEOUT_MS } from '../../../e2e-common/test-config';
import {
SearchProductsShopQuery,
SearchProductsShopQueryVariables,
} from '../../core/e2e/graphql/generated-e2e-shop-types';
import { SEARCH_PRODUCTS_SHOP } from '../../core/e2e/graphql/shop-definitions';
import { awaitRunningJobs } from '../../core/e2e/utils/await-running-jobs';
import { ElasticsearchPlugin } from '../src/plugin';
import { GetCollectionListQuery } from './graphql/generated-e2e-elasticsearch-plugin-types';
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { elasticsearchHost, elasticsearchPort } = require('./constants');
// https://github.com/vendure-ecommerce/vendure/issues/494
describe('Elasticsearch plugin with UuidIdStrategy', () => {
const { server, adminClient, shopClient } = createTestEnvironment(
mergeConfig(testConfig(), {
entityOptions: { entityIdStrategy: new UuidIdStrategy() },
// logger: new DefaultLogger({ level: LogLevel.Info }),
plugins: [
ElasticsearchPlugin.init({
indexPrefix: 'e2e-uuid-tests',
port: elasticsearchPort,
host: elasticsearchHost,
}),
DefaultJobQueuePlugin,
],
}),
);
beforeAll(async () => {
await server.init({
initialData,
productsCsvPath: path.join(__dirname, 'fixtures/e2e-products-full.csv'),
customerCount: 1,
});
await adminClient.asSuperAdmin();
await adminClient.query(REINDEX);
await awaitRunningJobs(adminClient);
}, TEST_SETUP_TIMEOUT_MS);
afterAll(async () => {
await server.destroy();
});
it('no term or filters', async () => {
const { search } = await shopClient.query<SearchProductsShopQuery, SearchProductsShopQueryVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: true,
},
},
);
expect(search.totalItems).toBe(20);
});
it('with search term', async () => {
const { search } = await shopClient.query<SearchProductsShopQuery, SearchProductsShopQueryVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: true,
term: 'laptop',
},
},
);
expect(search.totalItems).toBe(1);
});
it('with collectionId filter term', async () => {
const { collections } = await shopClient.query<GetCollectionListQuery>(GET_COLLECTION_LIST);
const { search } = await shopClient.query<SearchProductsShopQuery, SearchProductsShopQueryVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: true,
collectionId: collections.items[0].id,
},
},
);
expect(search.items).not.toEqual([]);
});
});
const REINDEX = gql`
mutation Reindex {
reindex {
id
queueName
state
progress
duration
result
}
}
`;
const GET_COLLECTION_LIST = gql`
query GetCollectionList {
collections {
items {
id
name
}
}
}
`;
|
/* eslint-disable @typescript-eslint/no-non-null-assertion, no-console */
import { CurrencyCode, SortOrder } from '@vendure/common/lib/generated-types';
import { pick } from '@vendure/common/lib/pick';
import {
DefaultJobQueuePlugin,
DefaultLogger,
FacetValue,
facetValueCollectionFilter,
LanguageCode,
LogLevel,
mergeConfig,
} from '@vendure/core';
import { createTestEnvironment, E2E_DEFAULT_CHANNEL_TOKEN } from '@vendure/testing';
import { fail } from 'assert';
import gql from 'graphql-tag';
import path from 'path';
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
import { initialData } from '../../../e2e-common/e2e-initial-data';
import { testConfig, TEST_SETUP_TIMEOUT_MS } from '../../../e2e-common/test-config';
import * as Codegen from '../../core/e2e/graphql/generated-e2e-admin-types';
import {
SearchProductsShopQuery,
SearchProductsShopQueryVariables,
} from '../../core/e2e/graphql/generated-e2e-shop-types';
import {
ASSIGN_PRODUCTVARIANT_TO_CHANNEL,
ASSIGN_PRODUCT_TO_CHANNEL,
CREATE_CHANNEL,
CREATE_COLLECTION,
CREATE_FACET,
CREATE_PRODUCT,
CREATE_PRODUCT_VARIANTS,
DELETE_ASSET,
DELETE_PRODUCT,
DELETE_PRODUCT_VARIANT,
REMOVE_PRODUCTVARIANT_FROM_CHANNEL,
REMOVE_PRODUCT_FROM_CHANNEL,
UPDATE_ASSET,
UPDATE_COLLECTION,
UPDATE_PRODUCT,
UPDATE_PRODUCT_VARIANTS,
UPDATE_TAX_RATE,
} from '../../core/e2e/graphql/shared-definitions';
import { SEARCH_PRODUCTS_SHOP } from '../../core/e2e/graphql/shop-definitions';
import { awaitRunningJobs } from '../../core/e2e/utils/await-running-jobs';
import { ElasticsearchPlugin } from '../src/plugin';
import {
doAdminSearchQuery,
dropElasticIndices,
testGroupByProduct,
testMatchCollectionId,
testMatchCollectionSlug,
testMatchFacetIdsAnd,
testMatchFacetIdsOr,
testMatchFacetValueFiltersAnd,
testMatchFacetValueFiltersOr,
testMatchFacetValueFiltersOrWithAnd,
testMatchFacetValueFiltersWithFacetIdsAnd,
testMatchFacetValueFiltersWithFacetIdsOr,
testMatchSearchTerm,
testNoGrouping,
testPriceRanges,
testSinglePrices,
} from './e2e-helpers';
import {
GetJobInfoQuery,
GetJobInfoQueryVariables,
JobState,
} from './graphql/generated-e2e-elasticsearch-plugin-types';
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { elasticsearchHost, elasticsearchPort } = require('./constants');
interface SearchProductShopVariables extends SearchProductsShopQueryVariables {
input: SearchProductsShopQueryVariables['input'] & {
// This input field is dynamically added only when the `indexStockStatus` init option
// of DefaultSearchPlugin is set to `true`, and therefore not included in the generated type. Therefore
// we need to manually patch it here.
inStock?: boolean;
};
}
const INDEX_PREFIX = 'e2e-tests';
describe('Elasticsearch plugin', () => {
const { server, adminClient, shopClient } = createTestEnvironment(
mergeConfig(testConfig(), {
customFields: {
ProductVariant: [
{
name: 'material',
type: 'relation',
entity: FacetValue,
},
],
},
plugins: [
ElasticsearchPlugin.init({
indexPrefix: INDEX_PREFIX,
port: elasticsearchPort,
host: elasticsearchHost,
hydrateProductVariantRelations: ['customFields.material', 'stockLevels'],
customProductVariantMappings: {
inStock: {
graphQlType: 'Boolean!',
valueFn: variant => {
return variant.stockLevels[0]?.stockOnHand > 0;
},
},
materialCode: {
graphQlType: 'String!',
valueFn: variant => {
const materialFacetValue: FacetValue | undefined = (
variant.customFields as any
).material;
let result = '';
if (materialFacetValue) {
result = `${materialFacetValue.code}`;
}
return result;
},
},
},
customProductMappings: {
answer: {
graphQlType: 'Int!',
valueFn: args => {
return 42;
},
},
hello: {
graphQlType: 'String!',
public: false,
valueFn: args => {
return 'World';
},
},
priority: {
graphQlType: 'Int!',
valueFn: args => {
return ((args.id as number) % 2) + 1; // only 1 or 2
},
},
},
searchConfig: {
scriptFields: {
answerMultiplied: {
graphQlType: 'Int!',
context: 'product',
scriptFn: input => {
const factor = input.factor ?? 2;
return { script: `doc['product-answer'].value * ${factor as string}` };
},
},
},
mapSort: (sort, input) => {
const priority = (input.sort as any)?.priority;
if (priority) {
return [
...sort,
{
['product-priority']: {
order: priority === SortOrder.ASC ? 'asc' : 'desc',
},
},
];
}
return sort;
},
},
extendSearchInputType: {
factor: 'Int',
},
extendSearchSortType: ['priority'],
}),
DefaultJobQueuePlugin,
],
}),
);
beforeAll(async () => {
await dropElasticIndices(INDEX_PREFIX);
await server.init({
initialData,
productsCsvPath: path.join(__dirname, 'fixtures/e2e-products-full.csv'),
customerCount: 1,
});
await adminClient.asSuperAdmin();
await adminClient.query(REINDEX);
await awaitRunningJobs(adminClient);
}, TEST_SETUP_TIMEOUT_MS);
afterAll(async () => {
await awaitRunningJobs(adminClient);
await server.destroy();
});
describe('shop api', () => {
it('group by product', () => testGroupByProduct(shopClient));
it('no grouping', () => testNoGrouping(shopClient));
it('matches search term', () => testMatchSearchTerm(shopClient));
it('matches by facetValueId with AND operator', () => testMatchFacetIdsAnd(shopClient));
it('matches by facetValueId with OR operator', () => testMatchFacetIdsOr(shopClient));
it('matches by FacetValueFilters AND', () => testMatchFacetValueFiltersAnd(shopClient));
it('matches by FacetValueFilters OR', () => testMatchFacetValueFiltersOr(shopClient));
it('matches by FacetValueFilters OR and AND', () => testMatchFacetValueFiltersOrWithAnd(shopClient));
it('matches by FacetValueFilters with facetId OR operator', () =>
testMatchFacetValueFiltersWithFacetIdsOr(shopClient));
it('matches by FacetValueFilters with facetId AND operator', () =>
testMatchFacetValueFiltersWithFacetIdsAnd(shopClient));
it('matches by collectionId', () => testMatchCollectionId(shopClient));
it('matches by collectionSlug', () => testMatchCollectionSlug(shopClient));
it('single prices', () => testSinglePrices(shopClient));
it('price ranges', () => testPriceRanges(shopClient));
it('returns correct facetValues when not grouped by product', async () => {
const result = await shopClient.query<
Codegen.SearchFacetValuesQuery,
Codegen.SearchFacetValuesQueryVariables
>(SEARCH_GET_FACET_VALUES, {
input: {
groupByProduct: false,
},
});
expect(result.search.facetValues).toEqual([
{ count: 21, facetValue: { id: 'T_1', name: 'electronics' } },
{ count: 17, facetValue: { id: 'T_2', name: 'computers' } },
{ count: 4, facetValue: { id: 'T_3', name: 'photo' } },
{ count: 10, facetValue: { id: 'T_4', name: 'sports equipment' } },
{ count: 3, facetValue: { id: 'T_5', name: 'home & garden' } },
{ count: 3, facetValue: { id: 'T_6', name: 'plants' } },
]);
});
it('returns correct facetValues when grouped by product', async () => {
const result = await shopClient.query<
Codegen.SearchFacetValuesQuery,
Codegen.SearchFacetValuesQueryVariables
>(SEARCH_GET_FACET_VALUES, {
input: {
groupByProduct: true,
},
});
expect(result.search.facetValues).toEqual([
{ count: 10, facetValue: { id: 'T_1', name: 'electronics' } },
{ count: 6, facetValue: { id: 'T_2', name: 'computers' } },
{ count: 4, facetValue: { id: 'T_3', name: 'photo' } },
{ count: 7, facetValue: { id: 'T_4', name: 'sports equipment' } },
{ count: 3, facetValue: { id: 'T_5', name: 'home & garden' } },
{ count: 3, facetValue: { id: 'T_6', name: 'plants' } },
]);
});
it('omits facetValues of private facets', async () => {
const { createFacet } = await adminClient.query<
Codegen.CreateFacetMutation,
Codegen.CreateFacetMutationVariables
>(CREATE_FACET, {
input: {
code: 'profit-margin',
isPrivate: true,
translations: [{ languageCode: LanguageCode.en, name: 'Profit Margin' }],
values: [
{
code: 'massive',
translations: [{ languageCode: LanguageCode.en, name: 'massive' }],
},
],
},
});
await adminClient.query<Codegen.UpdateProductMutation, Codegen.UpdateProductMutationVariables>(
UPDATE_PRODUCT,
{
input: {
id: 'T_2',
// T_1 & T_2 are the existing facetValues (electronics & photo)
facetValueIds: ['T_1', 'T_2', createFacet.values[0].id],
},
},
);
await awaitRunningJobs(adminClient);
const result = await shopClient.query<
Codegen.SearchFacetValuesQuery,
Codegen.SearchFacetValuesQueryVariables
>(SEARCH_GET_FACET_VALUES, {
input: {
groupByProduct: true,
},
});
expect(result.search.facetValues).toEqual([
{ count: 10, facetValue: { id: 'T_1', name: 'electronics' } },
{ count: 6, facetValue: { id: 'T_2', name: 'computers' } },
{ count: 4, facetValue: { id: 'T_3', name: 'photo' } },
{ count: 7, facetValue: { id: 'T_4', name: 'sports equipment' } },
{ count: 3, facetValue: { id: 'T_5', name: 'home & garden' } },
{ count: 3, facetValue: { id: 'T_6', name: 'plants' } },
]);
});
it('returns correct collections when not grouped by product', async () => {
const result = await shopClient.query<
Codegen.SearchCollectionsQuery,
Codegen.SearchCollectionsQueryVariables
>(SEARCH_GET_COLLECTIONS, {
input: {
groupByProduct: false,
},
});
expect(result.search.collections).toEqual([
{ collection: { id: 'T_2', name: 'Plants' }, count: 3 },
]);
});
it('returns correct collections when grouped by product', async () => {
const result = await shopClient.query<
Codegen.SearchCollectionsQuery,
Codegen.SearchCollectionsQueryVariables
>(SEARCH_GET_COLLECTIONS, {
input: {
groupByProduct: true,
},
});
expect(result.search.collections).toEqual([
{ collection: { id: 'T_2', name: 'Plants' }, count: 3 },
]);
});
it('encodes the productId and productVariantId', async () => {
const result = await shopClient.query<SearchProductsShopQuery, SearchProductShopVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
term: 'Laptop 13 inch 8GB',
groupByProduct: false,
take: 1,
},
},
);
expect(pick(result.search.items[0], ['productId', 'productVariantId'])).toEqual({
productId: 'T_1',
productVariantId: 'T_1',
});
});
it('omits results for disabled ProductVariants', async () => {
await adminClient.query<
Codegen.UpdateProductVariantsMutation,
Codegen.UpdateProductVariantsMutationVariables
>(UPDATE_PRODUCT_VARIANTS, {
input: [{ id: 'T_3', enabled: false }],
});
await awaitRunningJobs(adminClient);
const result = await shopClient.query<SearchProductsShopQuery, SearchProductShopVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: false,
take: 100,
},
},
);
expect(result.search.items.map(i => i.productVariantId).includes('T_3')).toBe(false);
});
it('encodes collectionIds', async () => {
const result = await shopClient.query<SearchProductsShopQuery, SearchProductShopVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: false,
term: 'cactus',
take: 1,
},
},
);
expect(result.search.items[0].collectionIds).toEqual(['T_2']);
});
it('inStock is false and not grouped by product', async () => {
const result = await shopClient.query<SearchProductsShopQuery, SearchProductShopVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: false,
inStock: false,
},
},
);
expect(result.search.totalItems).toBe(2);
});
it('inStock is false and grouped by product', async () => {
const result = await shopClient.query<SearchProductsShopQuery, SearchProductShopVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: true,
inStock: false,
},
},
);
expect(result.search.totalItems).toBe(1);
});
it('inStock is true and not grouped by product', async () => {
const result = await shopClient.query<SearchProductsShopQuery, SearchProductShopVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: false,
inStock: true,
},
},
);
expect(result.search.totalItems).toBe(31);
});
it('inStock is true and grouped by product', async () => {
const result = await shopClient.query<SearchProductsShopQuery, SearchProductShopVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: true,
inStock: true,
},
},
);
expect(result.search.totalItems).toBe(19);
});
it('inStock is undefined and not grouped by product', async () => {
const result = await shopClient.query<SearchProductsShopQuery, SearchProductShopVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: false,
inStock: undefined,
},
},
);
expect(result.search.totalItems).toBe(33);
});
it('inStock is undefined and grouped by product', async () => {
const result = await shopClient.query<SearchProductsShopQuery, SearchProductShopVariables>(
SEARCH_PRODUCTS_SHOP,
{
input: {
groupByProduct: true,
inStock: undefined,
},
},
);
expect(result.search.totalItems).toBe(20);
});
});
describe('admin api', () => {
it('group by product', () => testGroupByProduct(adminClient));
it('no grouping', () => testNoGrouping(adminClient));
it('matches search term', () => testMatchSearchTerm(adminClient));
it('matches by facetValueId with AND operator', () => testMatchFacetIdsAnd(adminClient));
it('matches by facetValueId with OR operator', () => testMatchFacetIdsOr(adminClient));
it('matches by FacetValueFilters AND', () => testMatchFacetValueFiltersAnd(shopClient));
it('matches by FacetValueFilters OR', () => testMatchFacetValueFiltersOr(shopClient));
it('matches by FacetValueFilters OR and AND', () => testMatchFacetValueFiltersOrWithAnd(shopClient));
it('matches by FacetValueFilters with facetId OR operator', () =>
testMatchFacetValueFiltersWithFacetIdsOr(shopClient));
it('matches by FacetValueFilters with facetId AND operator', () =>
testMatchFacetValueFiltersWithFacetIdsAnd(shopClient));
it('matches by collectionId', () => testMatchCollectionId(adminClient));
it('matches by collectionSlug', () => testMatchCollectionSlug(adminClient));
it('single prices', () => testSinglePrices(adminClient));
it('price ranges', () => testPriceRanges(adminClient));
describe('updating the index', () => {
it('updates index when ProductVariants are changed', async () => {
await awaitRunningJobs(adminClient);
const { search } = await doAdminSearchQuery(adminClient, {
term: 'drive',
groupByProduct: false,
});
expect(search.items.map(i => i.sku)).toEqual([
'IHD455T1',
'IHD455T2',
'IHD455T3',
'IHD455T4',
'IHD455T6',
]);
await adminClient.query<
Codegen.UpdateProductVariantsMutation,
Codegen.UpdateProductVariantsMutationVariables
>(UPDATE_PRODUCT_VARIANTS, {
input: search.items.map(i => ({
id: i.productVariantId,
sku: i.sku + '_updated',
})),
});
await awaitRunningJobs(adminClient);
const { search: search2 } = await doAdminSearchQuery(adminClient, {
term: 'drive',
groupByProduct: false,
});
expect(search2.items.map(i => i.sku)).toEqual([
'IHD455T1_updated',
'IHD455T2_updated',
'IHD455T3_updated',
'IHD455T4_updated',
'IHD455T6_updated',
]);
});
it('updates index when ProductVariants are deleted', async () => {
await awaitRunningJobs(adminClient);
const { search } = await doAdminSearchQuery(adminClient, {
term: 'drive',
groupByProduct: false,
});
await adminClient.query<
Codegen.DeleteProductVariantMutation,
Codegen.DeleteProductVariantMutationVariables
>(DELETE_PRODUCT_VARIANT, {
id: search.items[0].productVariantId,
});
await awaitRunningJobs(adminClient);
await awaitRunningJobs(adminClient);
const { search: search2 } = await doAdminSearchQuery(adminClient, {
term: 'drive',
groupByProduct: false,
});
expect(search2.items.map(i => i.sku).sort()).toEqual([
'IHD455T2_updated',
'IHD455T3_updated',
'IHD455T4_updated',
'IHD455T6_updated',
]);
});
it('updates index when a Product is changed', async () => {
await adminClient.query<
Codegen.UpdateProductMutation,
Codegen.UpdateProductMutationVariables
>(UPDATE_PRODUCT, {
input: {
id: 'T_1',
facetValueIds: [],
},
});
await awaitRunningJobs(adminClient);
const result = await doAdminSearchQuery(adminClient, {
facetValueIds: ['T_2'],
groupByProduct: true,
});
expect(result.search.items.map(i => i.productName).sort()).toEqual([
'Clacky Keyboard',
'Curvy Monitor',
'Gaming PC',
'Hard Drive',
'USB Cable',
]);
});
it('updates index when a Product is deleted', async () => {
const { search } = await doAdminSearchQuery(adminClient, {
facetValueIds: ['T_2'],
groupByProduct: true,
});
expect(search.items.map(i => i.productId).sort()).toEqual([
'T_2',
'T_3',
'T_4',
'T_5',
'T_6',
]);
await adminClient.query<
Codegen.DeleteProductMutation,
Codegen.DeleteProductMutationVariables
>(DELETE_PRODUCT, {
id: 'T_5',
});
await awaitRunningJobs(adminClient);
const { search: search2 } = await doAdminSearchQuery(adminClient, {
facetValueIds: ['T_2'],
groupByProduct: true,
});
expect(search2.items.map(i => i.productId).sort()).toEqual(['T_2', 'T_3', 'T_4', 'T_6']);
});
it('updates index when a Collection is changed', async () => {
await adminClient.query<
Codegen.UpdateCollectionMutation,
Codegen.UpdateCollectionMutationVariables
>(UPDATE_COLLECTION, {
input: {
id: 'T_2',
filters: [
{
code: facetValueCollectionFilter.code,
arguments: [
{
name: 'facetValueIds',
value: '["T_4"]',
},
{
name: 'containsAny',
value: 'false',
},
],
},
],
},
});
await awaitRunningJobs(adminClient);
// add an additional check for the collection filters to update
await awaitRunningJobs(adminClient);
const result1 = await doAdminSearchQuery(adminClient, {
collectionId: 'T_2',
groupByProduct: true,
});
expect(result1.search.items.map(i => i.productName).sort()).toEqual([
'Boxing Gloves',
'Cruiser Skateboard',
'Football',
'Road Bike',
'Running Shoe',
'Skipping Rope',
'Tent',
]);
const result2 = await doAdminSearchQuery(adminClient, {
collectionSlug: 'plants',
groupByProduct: true,
});
expect(result2.search.items.map(i => i.productName).sort()).toEqual([
'Boxing Gloves',
'Cruiser Skateboard',
'Football',
'Road Bike',
'Running Shoe',
'Skipping Rope',
'Tent',
]);
});
it('updates index when a Collection created', async () => {
const { createCollection } = await adminClient.query<
Codegen.CreateCollectionMutation,
Codegen.CreateCollectionMutationVariables
>(CREATE_COLLECTION, {
input: {
translations: [
{
languageCode: LanguageCode.en,
name: 'Photo',
description: '',
slug: 'photo',
},
],
filters: [
{
code: facetValueCollectionFilter.code,
arguments: [
{
name: 'facetValueIds',
value: '["T_3"]',
},
{
name: 'containsAny',
value: 'false',
},
],
},
],
},
});
await awaitRunningJobs(adminClient);
// add an additional check for the collection filters to update
await awaitRunningJobs(adminClient);
const result = await doAdminSearchQuery(adminClient, {
collectionId: createCollection.id,
groupByProduct: true,
});
expect(result.search.items.map(i => i.productName).sort()).toEqual([
'Camera Lens',
'Instant Camera',
'SLR Camera',
'Tripod',
]);
});
it('updates index when a taxRate is changed', async () => {
await adminClient.query<
Codegen.UpdateTaxRateMutation,
Codegen.UpdateTaxRateMutationVariables
>(UPDATE_TAX_RATE, {
input: {
// Default Channel's defaultTaxZone is Europe (id 2) and the id of the standard TaxRate
// to Europe is 2.
id: 'T_2',
value: 50,
},
});
await awaitRunningJobs(adminClient);
const result = await adminClient.query<
Codegen.SearchGetPricesQuery,
Codegen.SearchGetPricesQueryVariables
>(SEARCH_GET_PRICES, {
input: {
groupByProduct: true,
term: 'laptop',
} as Codegen.SearchInput,
});
expect(result.search.items).toEqual([
{
price: { min: 129900, max: 229900 },
priceWithTax: { min: 194850, max: 344850 },
},
]);
});
describe('asset changes', () => {
function searchForLaptop() {
return doAdminSearchQuery(adminClient, {
term: 'laptop',
groupByProduct: true,
take: 1,
sort: {
name: SortOrder.ASC,
},
});
}
it('updates index when asset focalPoint is changed', async () => {
const { search: search1 } = await searchForLaptop();
expect(search1.items[0].productAsset!.id).toBe('T_1');
expect(search1.items[0].productAsset!.focalPoint).toBeNull();
await adminClient.query<
Codegen.UpdateAssetMutation,
Codegen.UpdateAssetMutationVariables
>(UPDATE_ASSET, {
input: {
id: 'T_1',
focalPoint: {
x: 0.42,
y: 0.42,
},
},
});
await awaitRunningJobs(adminClient);
const { search: search2 } = await searchForLaptop();
expect(search2.items[0].productAsset!.id).toBe('T_1');
expect(search2.items[0].productAsset!.focalPoint).toEqual({ x: 0.42, y: 0.42 });
});
it('updates index when asset deleted', async () => {
const { search: search1 } = await searchForLaptop();
const assetId = search1.items[0].productAsset?.id;
expect(assetId).toBeTruthy();
await adminClient.query<
Codegen.DeleteAssetMutation,
Codegen.DeleteAssetMutationVariables
>(DELETE_ASSET, {
input: {
assetId: assetId!,
force: true,
},
});
await awaitRunningJobs(adminClient);
const { search: search2 } = await searchForLaptop();
expect(search2.items[0].productAsset).toBeNull();
});
});
it('does not include deleted ProductVariants in index', async () => {
const { search: s1 } = await doAdminSearchQuery(adminClient, {
term: 'hard drive',
groupByProduct: false,
});
const variantToDelete = s1.items.find(i => i.sku === 'IHD455T2_updated')!;
const { deleteProductVariant } = await adminClient.query<
Codegen.DeleteProductVariantMutation,
Codegen.DeleteProductVariantMutationVariables
>(DELETE_PRODUCT_VARIANT, { id: variantToDelete.productVariantId });
await awaitRunningJobs(adminClient);
const { search } = await adminClient.query<
Codegen.SearchGetPricesQuery,
Codegen.SearchGetPricesQueryVariables
>(SEARCH_GET_PRICES, { input: { term: 'hard drive', groupByProduct: true } });
expect(search.items[0].price).toEqual({
min: 7896,
max: 13435,
});
});
it('returns disabled field when not grouped', async () => {
const result = await doAdminSearchQuery(adminClient, {
groupByProduct: false,
term: 'laptop',
});
expect(result.search.items.map(pick(['productVariantId', 'enabled']))).toEqual([
{ productVariantId: 'T_1', enabled: true },
{ productVariantId: 'T_2', enabled: true },
{ productVariantId: 'T_3', enabled: false },
{ productVariantId: 'T_4', enabled: true },
]);
});
it('when grouped, disabled is false if at least one variant is enabled', async () => {
await adminClient.query<
Codegen.UpdateProductVariantsMutation,
Codegen.UpdateProductVariantsMutationVariables
>(UPDATE_PRODUCT_VARIANTS, {
input: [
{ id: 'T_1', enabled: false },
{ id: 'T_2', enabled: false },
],
});
await awaitRunningJobs(adminClient);
const result = await doAdminSearchQuery(adminClient, {
groupByProduct: true,
term: 'laptop',
});
expect(result.search.items.map(pick(['productId', 'enabled']))).toEqual([
{ productId: 'T_1', enabled: true },
]);
});
it('when grouped, disabled is true if all variants are disabled', async () => {
await adminClient.query<
Codegen.UpdateProductVariantsMutation,
Codegen.UpdateProductVariantsMutationVariables
>(UPDATE_PRODUCT_VARIANTS, {
input: [{ id: 'T_4', enabled: false }],
});
await awaitRunningJobs(adminClient);
const result = await doAdminSearchQuery(adminClient, {
groupByProduct: true,
take: 3,
term: 'laptop',
});
expect(result.search.items.map(pick(['productId', 'enabled']))).toEqual([
{ productId: 'T_1', enabled: false },
]);
});
it('when grouped, disabled is true product is disabled', async () => {
await adminClient.query<
Codegen.UpdateProductMutation,
Codegen.UpdateProductMutationVariables
>(UPDATE_PRODUCT, {
input: {
id: 'T_3',
enabled: false,
},
});
await awaitRunningJobs(adminClient);
const result = await doAdminSearchQuery(adminClient, {
groupByProduct: true,
term: 'gaming',
});
expect(result.search.items.map(pick(['productId', 'enabled']))).toEqual([
{ productId: 'T_3', enabled: false },
]);
});
// https://github.com/vendure-ecommerce/vendure/issues/295
it('enabled status survives reindex', async () => {
await adminClient.query<Codegen.ReindexMutation>(REINDEX);
await awaitRunningJobs(adminClient);
const result = await doAdminSearchQuery(adminClient, {
term: 'laptop',
groupByProduct: true,
take: 3,
});
expect(result.search.items.map(pick(['productId', 'enabled']))).toEqual([
{ productId: 'T_1', enabled: false },
]);
});
});
// https://github.com/vendure-ecommerce/vendure/issues/609
describe('Synthetic index items', () => {
let createdProductId: string;
it('creates synthetic index item for Product with no variants', async () => {
const { createProduct } = await adminClient.query<
Codegen.CreateProductMutation,
Codegen.CreateProductMutationVariables
>(CREATE_PRODUCT, {
input: {
facetValueIds: ['T_1'],
translations: [
{
languageCode: LanguageCode.en,
name: 'Strawberry cheesecake',
slug: 'strawberry-cheesecake',
description: 'A yummy dessert',
},
],
},
});
await awaitRunningJobs(adminClient);
const result = await doAdminSearchQuery(adminClient, {
groupByProduct: true,
term: 'strawberry',
});
expect(
result.search.items.map(
pick([
'productId',
'enabled',
'productName',
'productVariantName',
'slug',
'description',
]),
),
).toEqual([
{
productId: createProduct.id,
enabled: false,
productName: 'Strawberry cheesecake',
productVariantName: 'Strawberry cheesecake',
slug: 'strawberry-cheesecake',
description: 'A yummy dessert',
},
]);
createdProductId = createProduct.id;
});
it('removes synthetic index item once a variant is created', async () => {
const { createProductVariants } = await adminClient.query<
Codegen.CreateProductVariantsMutation,
Codegen.CreateProductVariantsMutationVariables
>(CREATE_PRODUCT_VARIANTS, {
input: [
{
productId: createdProductId,
sku: 'SC01',
price: 1399,
translations: [
{ languageCode: LanguageCode.en, name: 'Strawberry Cheesecake Pie' },
],
},
],
});
await awaitRunningJobs(adminClient);
const result = await doAdminSearchQuery(adminClient, {
groupByProduct: true,
term: 'strawberry',
});
expect(result.search.items.map(pick(['productVariantName']))).toEqual([
{ productVariantName: 'Strawberry Cheesecake Pie' },
]);
});
});
describe('channel handling', () => {
const SECOND_CHANNEL_TOKEN = 'second-channel-token';
let secondChannel: Codegen.ChannelFragment;
beforeAll(async () => {
const { createChannel } = await adminClient.query<
Codegen.CreateChannelMutation,
Codegen.CreateChannelMutationVariables
>(CREATE_CHANNEL, {
input: {
code: 'second-channel',
token: SECOND_CHANNEL_TOKEN,
defaultLanguageCode: LanguageCode.en,
currencyCode: CurrencyCode.GBP,
pricesIncludeTax: true,
defaultTaxZoneId: 'T_2',
defaultShippingZoneId: 'T_1',
},
});
secondChannel = createChannel as Codegen.ChannelFragment;
adminClient.setChannelToken(SECOND_CHANNEL_TOKEN);
await adminClient.query<Codegen.ReindexMutation>(REINDEX);
await awaitRunningJobs(adminClient);
});
it('new channel is initially empty', async () => {
const { search: searchGrouped } = await doAdminSearchQuery(adminClient, {
groupByProduct: true,
});
const { search: searchUngrouped } = await doAdminSearchQuery(adminClient, {
groupByProduct: false,
});
expect(searchGrouped.totalItems).toEqual(0);
expect(searchUngrouped.totalItems).toEqual(0);
});
it('adding product to channel', async () => {
adminClient.setChannelToken(E2E_DEFAULT_CHANNEL_TOKEN);
await adminClient.query<
Codegen.AssignProductsToChannelMutation,
Codegen.AssignProductsToChannelMutationVariables
>(ASSIGN_PRODUCT_TO_CHANNEL, {
input: { channelId: secondChannel.id, productIds: ['T_1', 'T_2'] },
});
await awaitRunningJobs(adminClient);
adminClient.setChannelToken(SECOND_CHANNEL_TOKEN);
const { search } = await doAdminSearchQuery(adminClient, { groupByProduct: true });
expect(search.items.map(i => i.productId).sort()).toEqual(['T_1', 'T_2']);
});
it('removing product from channel', async () => {
adminClient.setChannelToken(E2E_DEFAULT_CHANNEL_TOKEN);
const { removeProductsFromChannel } = await adminClient.query<
Codegen.RemoveProductsFromChannelMutation,
Codegen.RemoveProductsFromChannelMutationVariables
>(REMOVE_PRODUCT_FROM_CHANNEL, {
input: {
productIds: ['T_2'],
channelId: secondChannel.id,
},
});
await awaitRunningJobs(adminClient);
adminClient.setChannelToken(SECOND_CHANNEL_TOKEN);
const { search } = await doAdminSearchQuery(adminClient, { groupByProduct: true });
expect(search.items.map(i => i.productId)).toEqual(['T_1']);
});
it('reindexes in channel', async () => {
adminClient.setChannelToken(SECOND_CHANNEL_TOKEN);
const { reindex } = await adminClient.query<Codegen.ReindexMutation>(REINDEX);
await awaitRunningJobs(adminClient);
const { job } = await adminClient.query<GetJobInfoQuery, GetJobInfoQueryVariables>(
GET_JOB_INFO,
{ id: reindex.id },
);
expect(job!.state).toBe(JobState.COMPLETED);
const { search } = await doAdminSearchQuery(adminClient, { groupByProduct: true });
expect(search.items.map(i => i.productId).sort()).toEqual(['T_1']);
});
it('adding product variant to channel', async () => {
adminClient.setChannelToken(E2E_DEFAULT_CHANNEL_TOKEN);
await adminClient.query<
Codegen.AssignProductVariantsToChannelMutation,
Codegen.AssignProductVariantsToChannelMutationVariables
>(ASSIGN_PRODUCTVARIANT_TO_CHANNEL, {
input: { channelId: secondChannel.id, productVariantIds: ['T_10', 'T_15'] },
});
await awaitRunningJobs(adminClient);
adminClient.setChannelToken(SECOND_CHANNEL_TOKEN);
const { search: searchGrouped } = await doAdminSearchQuery(adminClient, {
groupByProduct: true,
});
expect(searchGrouped.items.map(i => i.productId).sort()).toEqual(['T_1', 'T_3', 'T_4']);
const { search: searchUngrouped } = await doAdminSearchQuery(adminClient, {
groupByProduct: false,
});
expect(searchUngrouped.items.map(i => i.productVariantId).sort()).toEqual([
'T_1',
'T_10',
'T_15',
'T_2',
'T_3',
'T_4',
]);
});
it('removing product variant from channel', async () => {
adminClient.setChannelToken(E2E_DEFAULT_CHANNEL_TOKEN);
await adminClient.query<
Codegen.RemoveProductVariantsFromChannelMutation,
Codegen.RemoveProductVariantsFromChannelMutationVariables
>(REMOVE_PRODUCTVARIANT_FROM_CHANNEL, {
input: { channelId: secondChannel.id, productVariantIds: ['T_1', 'T_15'] },
});
await awaitRunningJobs(adminClient);
adminClient.setChannelToken(SECOND_CHANNEL_TOKEN);
const { search: searchGrouped } = await doAdminSearchQuery(adminClient, {
groupByProduct: true,
});
expect(searchGrouped.items.map(i => i.productId).sort()).toEqual(['T_1', 'T_3']);
const { search: searchUngrouped } = await doAdminSearchQuery(adminClient, {
groupByProduct: false,
});
expect(searchUngrouped.items.map(i => i.productVariantId).sort()).toEqual([
'T_10',
'T_2',
'T_3',
'T_4',
]);
});
it('updating product affects current channel', async () => {
adminClient.setChannelToken(SECOND_CHANNEL_TOKEN);
const { updateProduct } = await adminClient.query<
Codegen.UpdateProductMutation,
Codegen.UpdateProductMutationVariables
>(UPDATE_PRODUCT, {
input: {
id: 'T_3',
enabled: true,
translations: [{ languageCode: LanguageCode.en, name: 'xyz' }],
},
});
await awaitRunningJobs(adminClient);
const { search: searchGrouped } = await doAdminSearchQuery(adminClient, {
groupByProduct: true,
term: 'xyz',
});
expect(searchGrouped.items.map(i => i.productName)).toEqual(['xyz']);
});
it('updating product affects other channels', async () => {
adminClient.setChannelToken(E2E_DEFAULT_CHANNEL_TOKEN);
const { search: searchGrouped } = await doAdminSearchQuery(adminClient, {
groupByProduct: true,
term: 'xyz',
});
expect(searchGrouped.items.map(i => i.productName)).toEqual(['xyz']);
});
// https://github.com/vendure-ecommerce/vendure/issues/896
it('removing from channel with multiple languages', async () => {
adminClient.setChannelToken(E2E_DEFAULT_CHANNEL_TOKEN);
await adminClient.query<
Codegen.UpdateProductMutation,
Codegen.UpdateProductMutationVariables
>(UPDATE_PRODUCT, {
input: {
id: 'T_4',
translations: [
{
languageCode: LanguageCode.en,
name: 'product en',
slug: 'product-en',
description: 'en',
},
{
languageCode: LanguageCode.de,
name: 'product de',
slug: 'product-de',
description: 'de',
},
],
},
});
await adminClient.query<
Codegen.AssignProductsToChannelMutation,
Codegen.AssignProductsToChannelMutationVariables
>(ASSIGN_PRODUCT_TO_CHANNEL, {
input: { channelId: secondChannel.id, productIds: ['T_4'] },
});
await awaitRunningJobs(adminClient);
async function searchSecondChannelForDEProduct() {
adminClient.setChannelToken(SECOND_CHANNEL_TOKEN);
const { search } = await adminClient.query<
SearchProductsShopQuery,
SearchProductShopVariables
>(
SEARCH_PRODUCTS,
{
input: { term: 'product', groupByProduct: true },
},
{ languageCode: LanguageCode.de },
);
return search;
}
const search1 = await searchSecondChannelForDEProduct();
expect(search1.items.map(i => i.productName)).toEqual(['product de']);
adminClient.setChannelToken(E2E_DEFAULT_CHANNEL_TOKEN);
const { removeProductsFromChannel } = await adminClient.query<
Codegen.RemoveProductsFromChannelMutation,
Codegen.RemoveProductsFromChannelMutationVariables
>(REMOVE_PRODUCT_FROM_CHANNEL, {
input: {
productIds: ['T_4'],
channelId: secondChannel.id,
},
});
await awaitRunningJobs(adminClient);
const search2 = await searchSecondChannelForDEProduct();
expect(search2.items.map(i => i.productName)).toEqual([]);
});
});
describe('multiple language handling', () => {
function searchInLanguage(languageCode: LanguageCode, groupByProduct: boolean) {
return adminClient.query<
Codegen.SearchProductsAdminQuery,
Codegen.SearchProductsAdminQueryVariables
>(
SEARCH_PRODUCTS,
{
input: {
take: 1,
term: 'laptop',
groupByProduct,
},
},
{
languageCode,
},
);
}
beforeAll(async () => {
adminClient.setChannelToken(E2E_DEFAULT_CHANNEL_TOKEN);
const { updateProduct } = await adminClient.query<
Codegen.UpdateProductMutation,
Codegen.UpdateProductMutationVariables
>(UPDATE_PRODUCT, {
input: {
id: 'T_1',
translations: [
{
languageCode: LanguageCode.de,
name: 'laptop name de',
slug: 'laptop-slug-de',
description: 'laptop description de',
},
{
languageCode: LanguageCode.zh,
name: 'laptop name zh',
slug: 'laptop-slug-zh',
description: 'laptop description zh',
},
],
},
});
await adminClient.query<
Codegen.UpdateProductVariantsMutation,
Codegen.UpdateProductVariantsMutationVariables
>(UPDATE_PRODUCT_VARIANTS, {
input: [
{
id: updateProduct.variants[0].id,
translations: [
{
languageCode: LanguageCode.fr,
name: 'laptop variant fr',
},
],
},
],
});
await awaitRunningJobs(adminClient);
});
it('indexes product-level languages', async () => {
const { search: search1 } = await searchInLanguage(LanguageCode.de, true);
expect(search1.items[0].productName).toBe('laptop name de');
expect(search1.items[0].slug).toBe('laptop-slug-de');
expect(search1.items[0].description).toBe('laptop description de');
const { search: search2 } = await searchInLanguage(LanguageCode.zh, true);
expect(search2.items[0].productName).toBe('laptop name zh');
expect(search2.items[0].slug).toBe('laptop-slug-zh');
expect(search2.items[0].description).toBe('laptop description zh');
});
it('indexes product variant-level languages', async () => {
const { search: search1 } = await searchInLanguage(LanguageCode.fr, false);
expect(search1.items.length ? search1.items[0].productName : undefined).toBe('Laptop');
expect(search1.items.length ? search1.items[0].productVariantName : undefined).toBe(
'laptop variant fr',
);
});
});
});
describe('customMappings', () => {
it('variant mappings', async () => {
const query = `{
search(input: { take: 1, groupByProduct: false, sort: { name: ASC } }) {
items {
productVariantName
customProductVariantMappings {
inStock
}
customProductMappings {
answer
}
customMappings {
...on CustomProductVariantMappings {
inStock
}
...on CustomProductMappings {
answer
}
}
}
}
}`;
const { search } = await shopClient.query(gql(query));
expect(search.items[0]).toEqual({
productVariantName: 'Bonsai Tree',
customProductVariantMappings: {
inStock: false,
},
customProductMappings: {
answer: 42,
},
customMappings: {
inStock: false,
},
});
});
// https://github.com/vendure-ecommerce/vendure/issues/1638
it('hydrates variant custom field relation', async () => {
const { updateProductVariants } = await adminClient.query<
Codegen.UpdateProductVariantsMutation,
Codegen.UpdateProductVariantsMutationVariables
>(UPDATE_PRODUCT_VARIANTS, {
input: [
{
id: 'T_20',
customFields: {
materialId: 'T_1',
},
},
],
});
expect(updateProductVariants[0]!.id).toBe('T_20');
await adminClient.query<Codegen.ReindexMutation>(REINDEX);
await awaitRunningJobs(adminClient);
const query = `{
search(input: { groupByProduct: false, term: "tripod" }) {
items {
productVariantName
productVariantId
customMappings {
...on CustomProductVariantMappings {
materialCode
}
}
}
}
}`;
const { search } = await shopClient.query(gql(query));
expect(search.items.map((i: any) => i.customMappings)).toEqual([{ materialCode: 'electronics' }]);
});
it('product mappings', async () => {
const query = `{
search(input: { take: 1, groupByProduct: true, sort: { name: ASC } }) {
items {
productName
customMappings {
...on CustomProductMappings {
answer
}
}
}
}
}`;
const { search } = await shopClient.query(gql(query));
expect(search.items[0]).toEqual({
productName: 'Bonsai Tree',
customMappings: {
answer: 42,
},
});
});
it('private mappings', async () => {
const query = `{
search(input: { take: 1, groupByProduct: true, sort: { name: ASC } }) {
items {
customMappings {
...on CustomProductMappings {
answer
hello
}
}
}
}
}`;
try {
await shopClient.query(gql(query));
} catch (error: any) {
expect(error).toBeDefined();
expect(error.message).toContain('Cannot query field "hello"');
return;
}
fail('should not be able to query field "hello"');
});
});
describe('scriptFields', () => {
it('script mapping', async () => {
const query = `{
search(input: { take: 1, groupByProduct: true, sort: { name: ASC } }) {
items {
productVariantName
customScriptFields {
answerMultiplied
}
}
}
}`;
const { search } = await shopClient.query(gql(query));
expect(search.items[0]).toEqual({
productVariantName: 'Bonsai Tree',
customScriptFields: {
answerMultiplied: 84,
},
});
});
it('can use the custom search input field', async () => {
const query = `{
search(input: { take: 1, groupByProduct: true, sort: { name: ASC }, factor: 10 }) {
items {
productVariantName
customScriptFields {
answerMultiplied
}
}
}
}`;
const { search } = await shopClient.query(gql(query));
expect(search.items[0]).toEqual({
productVariantName: 'Bonsai Tree',
customScriptFields: {
answerMultiplied: 420,
},
});
});
});
describe('sort', () => {
it('sort ASC', async () => {
const query = `{
search(input: { take: 1, groupByProduct: true, sort: { priority: ASC } }) {
items {
customMappings {
...on CustomProductMappings {
priority
}
}
}
}
}`;
const { search } = await shopClient.query(gql(query));
expect(search.items[0]).toEqual({
customMappings: {
priority: 1,
},
});
});
it('sort DESC', async () => {
const query = `{
search(input: { take: 1, groupByProduct: true, sort: { priority: DESC } }) {
items {
customMappings {
...on CustomProductMappings {
priority
}
}
}
}
}`;
const { search } = await shopClient.query(gql(query));
expect(search.items[0]).toEqual({
customMappings: {
priority: 2,
},
});
});
});
});
export const SEARCH_PRODUCTS = gql`
query SearchProductsAdmin($input: SearchInput!) {
search(input: $input) {
totalItems
items {
enabled
productId
productName
slug
description
productAsset {
id
preview
focalPoint {
x
y
}
}
productVariantId
productVariantName
productVariantAsset {
id
preview
focalPoint {
x
y
}
}
sku
}
}
}
`;
export const SEARCH_GET_FACET_VALUES = gql`
query SearchFacetValues($input: SearchInput!) {
search(input: $input) {
totalItems
facetValues {
count
facetValue {
id
name
}
}
}
}
`;
export const SEARCH_GET_COLLECTIONS = gql`
query SearchCollections($input: SearchInput!) {
search(input: $input) {
totalItems
collections {
count
collection {
id
name
}
}
}
}
`;
export const SEARCH_GET_PRICES = gql`
query SearchGetPrices($input: SearchInput!) {
search(input: $input) {
items {
price {
... on PriceRange {
min
max
}
... on SinglePrice {
value
}
}
priceWithTax {
... on PriceRange {
min
max
}
... on SinglePrice {
value
}
}
}
}
}
`;
const REINDEX = gql`
mutation Reindex {
reindex {
id
queueName
state
progress
duration
result
}
}
`;
const GET_JOB_INFO = gql`
query GetJobInfo($id: ID!) {
job(jobId: $id) {
id
queueName
state
progress
duration
result
}
}
`;
|
/* eslint-disable */
import { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
export type Maybe<T> = T | null;
export type InputMaybe<T> = Maybe<T>;
export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
export type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]?: Maybe<T[SubKey]> };
export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]: Maybe<T[SubKey]> };
export type MakeEmpty<T extends { [key: string]: unknown }, K extends keyof T> = { [_ in K]?: never };
export type Incremental<T> = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
/** All built-in and custom scalars, mapped to their actual values */
export type Scalars = {
ID: { input: string; output: string; }
String: { input: string; output: string; }
Boolean: { input: boolean; output: boolean; }
Int: { input: number; output: number; }
Float: { input: number; output: number; }
DateTime: { input: any; output: any; }
JSON: { input: any; output: any; }
Money: { input: number; output: number; }
Upload: { input: any; output: any; }
};
export type AddFulfillmentToOrderResult = CreateFulfillmentError | EmptyOrderLineSelectionError | Fulfillment | FulfillmentStateTransitionError | InsufficientStockOnHandError | InvalidFulfillmentHandlerError | ItemsAlreadyFulfilledError;
export type AddItemInput = {
productVariantId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type AddItemToDraftOrderInput = {
productVariantId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type AddManualPaymentToOrderResult = ManualPaymentStateError | Order;
export type AddNoteToCustomerInput = {
id: Scalars['ID']['input'];
isPublic: Scalars['Boolean']['input'];
note: Scalars['String']['input'];
};
export type AddNoteToOrderInput = {
id: Scalars['ID']['input'];
isPublic: Scalars['Boolean']['input'];
note: Scalars['String']['input'];
};
export type Address = Node & {
city?: Maybe<Scalars['String']['output']>;
company?: Maybe<Scalars['String']['output']>;
country: Country;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
defaultBillingAddress?: Maybe<Scalars['Boolean']['output']>;
defaultShippingAddress?: Maybe<Scalars['Boolean']['output']>;
fullName?: Maybe<Scalars['String']['output']>;
id: Scalars['ID']['output'];
phoneNumber?: Maybe<Scalars['String']['output']>;
postalCode?: Maybe<Scalars['String']['output']>;
province?: Maybe<Scalars['String']['output']>;
streetLine1: Scalars['String']['output'];
streetLine2?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type AdjustDraftOrderLineInput = {
orderLineId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type Adjustment = {
adjustmentSource: Scalars['String']['output'];
amount: Scalars['Money']['output'];
data?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
type: AdjustmentType;
};
export enum AdjustmentType {
DISTRIBUTED_ORDER_PROMOTION = 'DISTRIBUTED_ORDER_PROMOTION',
OTHER = 'OTHER',
PROMOTION = 'PROMOTION'
}
export type Administrator = Node & {
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
emailAddress: Scalars['String']['output'];
firstName: Scalars['String']['output'];
id: Scalars['ID']['output'];
lastName: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
user: User;
};
export type AdministratorFilterParameter = {
_and?: InputMaybe<Array<AdministratorFilterParameter>>;
_or?: InputMaybe<Array<AdministratorFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
emailAddress?: InputMaybe<StringOperators>;
firstName?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
lastName?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type AdministratorList = PaginatedList & {
items: Array<Administrator>;
totalItems: Scalars['Int']['output'];
};
export type AdministratorListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<AdministratorFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<AdministratorSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type AdministratorPaymentInput = {
metadata?: InputMaybe<Scalars['JSON']['input']>;
paymentMethod?: InputMaybe<Scalars['String']['input']>;
};
export type AdministratorRefundInput = {
/**
* The amount to be refunded to this particular Payment. This was introduced in
* v2.2.0 as the preferred way to specify the refund amount. The `lines`, `shipping` and `adjustment`
* fields will be removed in a future version.
*/
amount?: InputMaybe<Scalars['Money']['input']>;
paymentId: Scalars['ID']['input'];
reason?: InputMaybe<Scalars['String']['input']>;
};
export type AdministratorSortParameter = {
createdAt?: InputMaybe<SortOrder>;
emailAddress?: InputMaybe<SortOrder>;
firstName?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
lastName?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type Allocation = Node & StockMovement & {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
orderLine: OrderLine;
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
/** Returned if an attempting to refund an OrderItem which has already been refunded */
export type AlreadyRefundedError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
refundId: Scalars['ID']['output'];
};
export type ApplyCouponCodeResult = CouponCodeExpiredError | CouponCodeInvalidError | CouponCodeLimitError | Order;
export type Asset = Node & {
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
fileSize: Scalars['Int']['output'];
focalPoint?: Maybe<Coordinate>;
height: Scalars['Int']['output'];
id: Scalars['ID']['output'];
mimeType: Scalars['String']['output'];
name: Scalars['String']['output'];
preview: Scalars['String']['output'];
source: Scalars['String']['output'];
tags: Array<Tag>;
type: AssetType;
updatedAt: Scalars['DateTime']['output'];
width: Scalars['Int']['output'];
};
export type AssetFilterParameter = {
_and?: InputMaybe<Array<AssetFilterParameter>>;
_or?: InputMaybe<Array<AssetFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
fileSize?: InputMaybe<NumberOperators>;
height?: InputMaybe<NumberOperators>;
id?: InputMaybe<IdOperators>;
mimeType?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
preview?: InputMaybe<StringOperators>;
source?: InputMaybe<StringOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
width?: InputMaybe<NumberOperators>;
};
export type AssetList = PaginatedList & {
items: Array<Asset>;
totalItems: Scalars['Int']['output'];
};
export type AssetListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<AssetFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<AssetSortParameter>;
tags?: InputMaybe<Array<Scalars['String']['input']>>;
tagsOperator?: InputMaybe<LogicalOperator>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type AssetSortParameter = {
createdAt?: InputMaybe<SortOrder>;
fileSize?: InputMaybe<SortOrder>;
height?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
mimeType?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
preview?: InputMaybe<SortOrder>;
source?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
width?: InputMaybe<SortOrder>;
};
export enum AssetType {
BINARY = 'BINARY',
IMAGE = 'IMAGE',
VIDEO = 'VIDEO'
}
export type AssignAssetsToChannelInput = {
assetIds: Array<Scalars['ID']['input']>;
channelId: Scalars['ID']['input'];
};
export type AssignCollectionsToChannelInput = {
channelId: Scalars['ID']['input'];
collectionIds: Array<Scalars['ID']['input']>;
};
export type AssignFacetsToChannelInput = {
channelId: Scalars['ID']['input'];
facetIds: Array<Scalars['ID']['input']>;
};
export type AssignPaymentMethodsToChannelInput = {
channelId: Scalars['ID']['input'];
paymentMethodIds: Array<Scalars['ID']['input']>;
};
export type AssignProductVariantsToChannelInput = {
channelId: Scalars['ID']['input'];
priceFactor?: InputMaybe<Scalars['Float']['input']>;
productVariantIds: Array<Scalars['ID']['input']>;
};
export type AssignProductsToChannelInput = {
channelId: Scalars['ID']['input'];
priceFactor?: InputMaybe<Scalars['Float']['input']>;
productIds: Array<Scalars['ID']['input']>;
};
export type AssignPromotionsToChannelInput = {
channelId: Scalars['ID']['input'];
promotionIds: Array<Scalars['ID']['input']>;
};
export type AssignShippingMethodsToChannelInput = {
channelId: Scalars['ID']['input'];
shippingMethodIds: Array<Scalars['ID']['input']>;
};
export type AssignStockLocationsToChannelInput = {
channelId: Scalars['ID']['input'];
stockLocationIds: Array<Scalars['ID']['input']>;
};
export type AuthenticationInput = {
native?: InputMaybe<NativeAuthInput>;
};
export type AuthenticationMethod = Node & {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
strategy: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type AuthenticationResult = CurrentUser | InvalidCredentialsError;
export type BooleanCustomFieldConfig = CustomField & {
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
requiresPermission?: Maybe<Array<Permission>>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
/** Operators for filtering on a list of Boolean fields */
export type BooleanListOperators = {
inList: Scalars['Boolean']['input'];
};
/** Operators for filtering on a Boolean field */
export type BooleanOperators = {
eq?: InputMaybe<Scalars['Boolean']['input']>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
};
/** Returned if an attempting to cancel lines from an Order which is still active */
export type CancelActiveOrderError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
orderState: Scalars['String']['output'];
};
export type CancelOrderInput = {
/** Specify whether the shipping charges should also be cancelled. Defaults to false */
cancelShipping?: InputMaybe<Scalars['Boolean']['input']>;
/** Optionally specify which OrderLines to cancel. If not provided, all OrderLines will be cancelled */
lines?: InputMaybe<Array<OrderLineInput>>;
/** The id of the order to be cancelled */
orderId: Scalars['ID']['input'];
reason?: InputMaybe<Scalars['String']['input']>;
};
export type CancelOrderResult = CancelActiveOrderError | EmptyOrderLineSelectionError | MultipleOrderError | Order | OrderStateTransitionError | QuantityTooGreatError;
/** Returned if the Payment cancellation fails */
export type CancelPaymentError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
paymentErrorMessage: Scalars['String']['output'];
};
export type CancelPaymentResult = CancelPaymentError | Payment | PaymentStateTransitionError;
export type Cancellation = Node & StockMovement & {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
orderLine: OrderLine;
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type Channel = Node & {
availableCurrencyCodes: Array<CurrencyCode>;
availableLanguageCodes?: Maybe<Array<LanguageCode>>;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
/** @deprecated Use defaultCurrencyCode instead */
currencyCode: CurrencyCode;
customFields?: Maybe<Scalars['JSON']['output']>;
defaultCurrencyCode: CurrencyCode;
defaultLanguageCode: LanguageCode;
defaultShippingZone?: Maybe<Zone>;
defaultTaxZone?: Maybe<Zone>;
id: Scalars['ID']['output'];
/** Not yet used - will be implemented in a future release. */
outOfStockThreshold?: Maybe<Scalars['Int']['output']>;
pricesIncludeTax: Scalars['Boolean']['output'];
seller?: Maybe<Seller>;
token: Scalars['String']['output'];
/** Not yet used - will be implemented in a future release. */
trackInventory?: Maybe<Scalars['Boolean']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
/**
* Returned when the default LanguageCode of a Channel is no longer found in the `availableLanguages`
* of the GlobalSettings
*/
export type ChannelDefaultLanguageError = ErrorResult & {
channelCode: Scalars['String']['output'];
errorCode: ErrorCode;
language: Scalars['String']['output'];
message: Scalars['String']['output'];
};
export type ChannelFilterParameter = {
_and?: InputMaybe<Array<ChannelFilterParameter>>;
_or?: InputMaybe<Array<ChannelFilterParameter>>;
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
currencyCode?: InputMaybe<StringOperators>;
defaultCurrencyCode?: InputMaybe<StringOperators>;
defaultLanguageCode?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
outOfStockThreshold?: InputMaybe<NumberOperators>;
pricesIncludeTax?: InputMaybe<BooleanOperators>;
token?: InputMaybe<StringOperators>;
trackInventory?: InputMaybe<BooleanOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ChannelList = PaginatedList & {
items: Array<Channel>;
totalItems: Scalars['Int']['output'];
};
export type ChannelListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ChannelFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ChannelSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ChannelSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
outOfStockThreshold?: InputMaybe<SortOrder>;
token?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type Collection = Node & {
assets: Array<Asset>;
breadcrumbs: Array<CollectionBreadcrumb>;
children?: Maybe<Array<Collection>>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
featuredAsset?: Maybe<Asset>;
filters: Array<ConfigurableOperation>;
id: Scalars['ID']['output'];
inheritFilters: Scalars['Boolean']['output'];
isPrivate: Scalars['Boolean']['output'];
languageCode?: Maybe<LanguageCode>;
name: Scalars['String']['output'];
parent?: Maybe<Collection>;
parentId: Scalars['ID']['output'];
position: Scalars['Int']['output'];
productVariants: ProductVariantList;
slug: Scalars['String']['output'];
translations: Array<CollectionTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type CollectionProductVariantsArgs = {
options?: InputMaybe<ProductVariantListOptions>;
};
export type CollectionBreadcrumb = {
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
slug: Scalars['String']['output'];
};
export type CollectionFilterParameter = {
_and?: InputMaybe<Array<CollectionFilterParameter>>;
_or?: InputMaybe<Array<CollectionFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
inheritFilters?: InputMaybe<BooleanOperators>;
isPrivate?: InputMaybe<BooleanOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
parentId?: InputMaybe<IdOperators>;
position?: InputMaybe<NumberOperators>;
slug?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CollectionList = PaginatedList & {
items: Array<Collection>;
totalItems: Scalars['Int']['output'];
};
export type CollectionListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CollectionFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CollectionSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
topLevelOnly?: InputMaybe<Scalars['Boolean']['input']>;
};
/**
* Which Collections are present in the products returned
* by the search, and in what quantity.
*/
export type CollectionResult = {
collection: Collection;
count: Scalars['Int']['output'];
};
export type CollectionSortParameter = {
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
parentId?: InputMaybe<SortOrder>;
position?: InputMaybe<SortOrder>;
slug?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type CollectionTranslation = {
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
slug: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ConfigArg = {
name: Scalars['String']['output'];
value: Scalars['String']['output'];
};
export type ConfigArgDefinition = {
defaultValue?: Maybe<Scalars['JSON']['output']>;
description?: Maybe<Scalars['String']['output']>;
label?: Maybe<Scalars['String']['output']>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
required: Scalars['Boolean']['output'];
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type ConfigArgInput = {
name: Scalars['String']['input'];
/** A JSON stringified representation of the actual value */
value: Scalars['String']['input'];
};
export type ConfigurableOperation = {
args: Array<ConfigArg>;
code: Scalars['String']['output'];
};
export type ConfigurableOperationDefinition = {
args: Array<ConfigArgDefinition>;
code: Scalars['String']['output'];
description: Scalars['String']['output'];
};
export type ConfigurableOperationInput = {
arguments: Array<ConfigArgInput>;
code: Scalars['String']['input'];
};
export type Coordinate = {
x: Scalars['Float']['output'];
y: Scalars['Float']['output'];
};
export type CoordinateInput = {
x: Scalars['Float']['input'];
y: Scalars['Float']['input'];
};
export type Country = Node & Region & {
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
parent?: Maybe<Region>;
parentId?: Maybe<Scalars['ID']['output']>;
translations: Array<RegionTranslation>;
type: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type CountryFilterParameter = {
_and?: InputMaybe<Array<CountryFilterParameter>>;
_or?: InputMaybe<Array<CountryFilterParameter>>;
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
enabled?: InputMaybe<BooleanOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
parentId?: InputMaybe<IdOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CountryList = PaginatedList & {
items: Array<Country>;
totalItems: Scalars['Int']['output'];
};
export type CountryListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CountryFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CountrySortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type CountrySortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
parentId?: InputMaybe<SortOrder>;
type?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type CountryTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
/** Returned if the provided coupon code is invalid */
export type CouponCodeExpiredError = ErrorResult & {
couponCode: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the provided coupon code is invalid */
export type CouponCodeInvalidError = ErrorResult & {
couponCode: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the provided coupon code is invalid */
export type CouponCodeLimitError = ErrorResult & {
couponCode: Scalars['String']['output'];
errorCode: ErrorCode;
limit: Scalars['Int']['output'];
message: Scalars['String']['output'];
};
export type CreateAddressInput = {
city?: InputMaybe<Scalars['String']['input']>;
company?: InputMaybe<Scalars['String']['input']>;
countryCode: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
defaultBillingAddress?: InputMaybe<Scalars['Boolean']['input']>;
defaultShippingAddress?: InputMaybe<Scalars['Boolean']['input']>;
fullName?: InputMaybe<Scalars['String']['input']>;
phoneNumber?: InputMaybe<Scalars['String']['input']>;
postalCode?: InputMaybe<Scalars['String']['input']>;
province?: InputMaybe<Scalars['String']['input']>;
streetLine1: Scalars['String']['input'];
streetLine2?: InputMaybe<Scalars['String']['input']>;
};
export type CreateAdministratorInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress: Scalars['String']['input'];
firstName: Scalars['String']['input'];
lastName: Scalars['String']['input'];
password: Scalars['String']['input'];
roleIds: Array<Scalars['ID']['input']>;
};
export type CreateAssetInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
file: Scalars['Upload']['input'];
tags?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type CreateAssetResult = Asset | MimeTypeError;
export type CreateChannelInput = {
availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
code: Scalars['String']['input'];
/** @deprecated Use defaultCurrencyCode instead */
currencyCode?: InputMaybe<CurrencyCode>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
defaultCurrencyCode?: InputMaybe<CurrencyCode>;
defaultLanguageCode: LanguageCode;
defaultShippingZoneId: Scalars['ID']['input'];
defaultTaxZoneId: Scalars['ID']['input'];
outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
pricesIncludeTax: Scalars['Boolean']['input'];
sellerId?: InputMaybe<Scalars['ID']['input']>;
token: Scalars['String']['input'];
trackInventory?: InputMaybe<Scalars['Boolean']['input']>;
};
export type CreateChannelResult = Channel | LanguageNotAvailableError;
export type CreateCollectionInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
filters: Array<ConfigurableOperationInput>;
inheritFilters?: InputMaybe<Scalars['Boolean']['input']>;
isPrivate?: InputMaybe<Scalars['Boolean']['input']>;
parentId?: InputMaybe<Scalars['ID']['input']>;
translations: Array<CreateCollectionTranslationInput>;
};
export type CreateCollectionTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description: Scalars['String']['input'];
languageCode: LanguageCode;
name: Scalars['String']['input'];
slug: Scalars['String']['input'];
};
export type CreateCountryInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled: Scalars['Boolean']['input'];
translations: Array<CountryTranslationInput>;
};
export type CreateCustomerGroupInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
customerIds?: InputMaybe<Array<Scalars['ID']['input']>>;
name: Scalars['String']['input'];
};
export type CreateCustomerInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress: Scalars['String']['input'];
firstName: Scalars['String']['input'];
lastName: Scalars['String']['input'];
phoneNumber?: InputMaybe<Scalars['String']['input']>;
title?: InputMaybe<Scalars['String']['input']>;
};
export type CreateCustomerResult = Customer | EmailAddressConflictError;
export type CreateFacetInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
isPrivate: Scalars['Boolean']['input'];
translations: Array<FacetTranslationInput>;
values?: InputMaybe<Array<CreateFacetValueWithFacetInput>>;
};
export type CreateFacetValueInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
facetId: Scalars['ID']['input'];
translations: Array<FacetValueTranslationInput>;
};
export type CreateFacetValueWithFacetInput = {
code: Scalars['String']['input'];
translations: Array<FacetValueTranslationInput>;
};
/** Returned if an error is thrown in a FulfillmentHandler's createFulfillment method */
export type CreateFulfillmentError = ErrorResult & {
errorCode: ErrorCode;
fulfillmentHandlerError: Scalars['String']['output'];
message: Scalars['String']['output'];
};
export type CreateGroupOptionInput = {
code: Scalars['String']['input'];
translations: Array<ProductOptionGroupTranslationInput>;
};
export type CreatePaymentMethodInput = {
checker?: InputMaybe<ConfigurableOperationInput>;
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled: Scalars['Boolean']['input'];
handler: ConfigurableOperationInput;
translations: Array<PaymentMethodTranslationInput>;
};
export type CreateProductInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
translations: Array<ProductTranslationInput>;
};
export type CreateProductOptionGroupInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
options: Array<CreateGroupOptionInput>;
translations: Array<ProductOptionGroupTranslationInput>;
};
export type CreateProductOptionInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
productOptionGroupId: Scalars['ID']['input'];
translations: Array<ProductOptionGroupTranslationInput>;
};
export type CreateProductVariantInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
optionIds?: InputMaybe<Array<Scalars['ID']['input']>>;
outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
price?: InputMaybe<Scalars['Money']['input']>;
productId: Scalars['ID']['input'];
sku: Scalars['String']['input'];
stockLevels?: InputMaybe<Array<StockLevelInput>>;
stockOnHand?: InputMaybe<Scalars['Int']['input']>;
taxCategoryId?: InputMaybe<Scalars['ID']['input']>;
trackInventory?: InputMaybe<GlobalFlag>;
translations: Array<ProductVariantTranslationInput>;
useGlobalOutOfStockThreshold?: InputMaybe<Scalars['Boolean']['input']>;
};
export type CreateProductVariantOptionInput = {
code: Scalars['String']['input'];
optionGroupId: Scalars['ID']['input'];
translations: Array<ProductOptionTranslationInput>;
};
export type CreatePromotionInput = {
actions: Array<ConfigurableOperationInput>;
conditions: Array<ConfigurableOperationInput>;
couponCode?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled: Scalars['Boolean']['input'];
endsAt?: InputMaybe<Scalars['DateTime']['input']>;
perCustomerUsageLimit?: InputMaybe<Scalars['Int']['input']>;
startsAt?: InputMaybe<Scalars['DateTime']['input']>;
translations: Array<PromotionTranslationInput>;
usageLimit?: InputMaybe<Scalars['Int']['input']>;
};
export type CreatePromotionResult = MissingConditionsError | Promotion;
export type CreateProvinceInput = {
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled: Scalars['Boolean']['input'];
translations: Array<ProvinceTranslationInput>;
};
export type CreateRoleInput = {
channelIds?: InputMaybe<Array<Scalars['ID']['input']>>;
code: Scalars['String']['input'];
description: Scalars['String']['input'];
permissions: Array<Permission>;
};
export type CreateSellerInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
name: Scalars['String']['input'];
};
export type CreateShippingMethodInput = {
calculator: ConfigurableOperationInput;
checker: ConfigurableOperationInput;
code: Scalars['String']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
fulfillmentHandler: Scalars['String']['input'];
translations: Array<ShippingMethodTranslationInput>;
};
export type CreateStockLocationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
name: Scalars['String']['input'];
};
export type CreateTagInput = {
value: Scalars['String']['input'];
};
export type CreateTaxCategoryInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
isDefault?: InputMaybe<Scalars['Boolean']['input']>;
name: Scalars['String']['input'];
};
export type CreateTaxRateInput = {
categoryId: Scalars['ID']['input'];
customFields?: InputMaybe<Scalars['JSON']['input']>;
customerGroupId?: InputMaybe<Scalars['ID']['input']>;
enabled: Scalars['Boolean']['input'];
name: Scalars['String']['input'];
value: Scalars['Float']['input'];
zoneId: Scalars['ID']['input'];
};
export type CreateZoneInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
memberIds?: InputMaybe<Array<Scalars['ID']['input']>>;
name: Scalars['String']['input'];
};
/**
* @description
* ISO 4217 currency code
*
* @docsCategory common
*/
export enum CurrencyCode {
/** United Arab Emirates dirham */
AED = 'AED',
/** Afghan afghani */
AFN = 'AFN',
/** Albanian lek */
ALL = 'ALL',
/** Armenian dram */
AMD = 'AMD',
/** Netherlands Antillean guilder */
ANG = 'ANG',
/** Angolan kwanza */
AOA = 'AOA',
/** Argentine peso */
ARS = 'ARS',
/** Australian dollar */
AUD = 'AUD',
/** Aruban florin */
AWG = 'AWG',
/** Azerbaijani manat */
AZN = 'AZN',
/** Bosnia and Herzegovina convertible mark */
BAM = 'BAM',
/** Barbados dollar */
BBD = 'BBD',
/** Bangladeshi taka */
BDT = 'BDT',
/** Bulgarian lev */
BGN = 'BGN',
/** Bahraini dinar */
BHD = 'BHD',
/** Burundian franc */
BIF = 'BIF',
/** Bermudian dollar */
BMD = 'BMD',
/** Brunei dollar */
BND = 'BND',
/** Boliviano */
BOB = 'BOB',
/** Brazilian real */
BRL = 'BRL',
/** Bahamian dollar */
BSD = 'BSD',
/** Bhutanese ngultrum */
BTN = 'BTN',
/** Botswana pula */
BWP = 'BWP',
/** Belarusian ruble */
BYN = 'BYN',
/** Belize dollar */
BZD = 'BZD',
/** Canadian dollar */
CAD = 'CAD',
/** Congolese franc */
CDF = 'CDF',
/** Swiss franc */
CHF = 'CHF',
/** Chilean peso */
CLP = 'CLP',
/** Renminbi (Chinese) yuan */
CNY = 'CNY',
/** Colombian peso */
COP = 'COP',
/** Costa Rican colon */
CRC = 'CRC',
/** Cuban convertible peso */
CUC = 'CUC',
/** Cuban peso */
CUP = 'CUP',
/** Cape Verde escudo */
CVE = 'CVE',
/** Czech koruna */
CZK = 'CZK',
/** Djiboutian franc */
DJF = 'DJF',
/** Danish krone */
DKK = 'DKK',
/** Dominican peso */
DOP = 'DOP',
/** Algerian dinar */
DZD = 'DZD',
/** Egyptian pound */
EGP = 'EGP',
/** Eritrean nakfa */
ERN = 'ERN',
/** Ethiopian birr */
ETB = 'ETB',
/** Euro */
EUR = 'EUR',
/** Fiji dollar */
FJD = 'FJD',
/** Falkland Islands pound */
FKP = 'FKP',
/** Pound sterling */
GBP = 'GBP',
/** Georgian lari */
GEL = 'GEL',
/** Ghanaian cedi */
GHS = 'GHS',
/** Gibraltar pound */
GIP = 'GIP',
/** Gambian dalasi */
GMD = 'GMD',
/** Guinean franc */
GNF = 'GNF',
/** Guatemalan quetzal */
GTQ = 'GTQ',
/** Guyanese dollar */
GYD = 'GYD',
/** Hong Kong dollar */
HKD = 'HKD',
/** Honduran lempira */
HNL = 'HNL',
/** Croatian kuna */
HRK = 'HRK',
/** Haitian gourde */
HTG = 'HTG',
/** Hungarian forint */
HUF = 'HUF',
/** Indonesian rupiah */
IDR = 'IDR',
/** Israeli new shekel */
ILS = 'ILS',
/** Indian rupee */
INR = 'INR',
/** Iraqi dinar */
IQD = 'IQD',
/** Iranian rial */
IRR = 'IRR',
/** Icelandic króna */
ISK = 'ISK',
/** Jamaican dollar */
JMD = 'JMD',
/** Jordanian dinar */
JOD = 'JOD',
/** Japanese yen */
JPY = 'JPY',
/** Kenyan shilling */
KES = 'KES',
/** Kyrgyzstani som */
KGS = 'KGS',
/** Cambodian riel */
KHR = 'KHR',
/** Comoro franc */
KMF = 'KMF',
/** North Korean won */
KPW = 'KPW',
/** South Korean won */
KRW = 'KRW',
/** Kuwaiti dinar */
KWD = 'KWD',
/** Cayman Islands dollar */
KYD = 'KYD',
/** Kazakhstani tenge */
KZT = 'KZT',
/** Lao kip */
LAK = 'LAK',
/** Lebanese pound */
LBP = 'LBP',
/** Sri Lankan rupee */
LKR = 'LKR',
/** Liberian dollar */
LRD = 'LRD',
/** Lesotho loti */
LSL = 'LSL',
/** Libyan dinar */
LYD = 'LYD',
/** Moroccan dirham */
MAD = 'MAD',
/** Moldovan leu */
MDL = 'MDL',
/** Malagasy ariary */
MGA = 'MGA',
/** Macedonian denar */
MKD = 'MKD',
/** Myanmar kyat */
MMK = 'MMK',
/** Mongolian tögrög */
MNT = 'MNT',
/** Macanese pataca */
MOP = 'MOP',
/** Mauritanian ouguiya */
MRU = 'MRU',
/** Mauritian rupee */
MUR = 'MUR',
/** Maldivian rufiyaa */
MVR = 'MVR',
/** Malawian kwacha */
MWK = 'MWK',
/** Mexican peso */
MXN = 'MXN',
/** Malaysian ringgit */
MYR = 'MYR',
/** Mozambican metical */
MZN = 'MZN',
/** Namibian dollar */
NAD = 'NAD',
/** Nigerian naira */
NGN = 'NGN',
/** Nicaraguan córdoba */
NIO = 'NIO',
/** Norwegian krone */
NOK = 'NOK',
/** Nepalese rupee */
NPR = 'NPR',
/** New Zealand dollar */
NZD = 'NZD',
/** Omani rial */
OMR = 'OMR',
/** Panamanian balboa */
PAB = 'PAB',
/** Peruvian sol */
PEN = 'PEN',
/** Papua New Guinean kina */
PGK = 'PGK',
/** Philippine peso */
PHP = 'PHP',
/** Pakistani rupee */
PKR = 'PKR',
/** Polish złoty */
PLN = 'PLN',
/** Paraguayan guaraní */
PYG = 'PYG',
/** Qatari riyal */
QAR = 'QAR',
/** Romanian leu */
RON = 'RON',
/** Serbian dinar */
RSD = 'RSD',
/** Russian ruble */
RUB = 'RUB',
/** Rwandan franc */
RWF = 'RWF',
/** Saudi riyal */
SAR = 'SAR',
/** Solomon Islands dollar */
SBD = 'SBD',
/** Seychelles rupee */
SCR = 'SCR',
/** Sudanese pound */
SDG = 'SDG',
/** Swedish krona/kronor */
SEK = 'SEK',
/** Singapore dollar */
SGD = 'SGD',
/** Saint Helena pound */
SHP = 'SHP',
/** Sierra Leonean leone */
SLL = 'SLL',
/** Somali shilling */
SOS = 'SOS',
/** Surinamese dollar */
SRD = 'SRD',
/** South Sudanese pound */
SSP = 'SSP',
/** São Tomé and Príncipe dobra */
STN = 'STN',
/** Salvadoran colón */
SVC = 'SVC',
/** Syrian pound */
SYP = 'SYP',
/** Swazi lilangeni */
SZL = 'SZL',
/** Thai baht */
THB = 'THB',
/** Tajikistani somoni */
TJS = 'TJS',
/** Turkmenistan manat */
TMT = 'TMT',
/** Tunisian dinar */
TND = 'TND',
/** Tongan paʻanga */
TOP = 'TOP',
/** Turkish lira */
TRY = 'TRY',
/** Trinidad and Tobago dollar */
TTD = 'TTD',
/** New Taiwan dollar */
TWD = 'TWD',
/** Tanzanian shilling */
TZS = 'TZS',
/** Ukrainian hryvnia */
UAH = 'UAH',
/** Ugandan shilling */
UGX = 'UGX',
/** United States dollar */
USD = 'USD',
/** Uruguayan peso */
UYU = 'UYU',
/** Uzbekistan som */
UZS = 'UZS',
/** Venezuelan bolívar soberano */
VES = 'VES',
/** Vietnamese đồng */
VND = 'VND',
/** Vanuatu vatu */
VUV = 'VUV',
/** Samoan tala */
WST = 'WST',
/** CFA franc BEAC */
XAF = 'XAF',
/** East Caribbean dollar */
XCD = 'XCD',
/** CFA franc BCEAO */
XOF = 'XOF',
/** CFP franc (franc Pacifique) */
XPF = 'XPF',
/** Yemeni rial */
YER = 'YER',
/** South African rand */
ZAR = 'ZAR',
/** Zambian kwacha */
ZMW = 'ZMW',
/** Zimbabwean dollar */
ZWL = 'ZWL'
}
export type CurrentUser = {
channels: Array<CurrentUserChannel>;
id: Scalars['ID']['output'];
identifier: Scalars['String']['output'];
};
export type CurrentUserChannel = {
code: Scalars['String']['output'];
id: Scalars['ID']['output'];
permissions: Array<Permission>;
token: Scalars['String']['output'];
};
export type CustomField = {
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
requiresPermission?: Maybe<Array<Permission>>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type CustomFieldConfig = BooleanCustomFieldConfig | DateTimeCustomFieldConfig | FloatCustomFieldConfig | IntCustomFieldConfig | LocaleStringCustomFieldConfig | LocaleTextCustomFieldConfig | RelationCustomFieldConfig | StringCustomFieldConfig | TextCustomFieldConfig;
/**
* This type is deprecated in v2.2 in favor of the EntityCustomFields type,
* which allows custom fields to be defined on user-supplies entities.
*/
export type CustomFields = {
Address: Array<CustomFieldConfig>;
Administrator: Array<CustomFieldConfig>;
Asset: Array<CustomFieldConfig>;
Channel: Array<CustomFieldConfig>;
Collection: Array<CustomFieldConfig>;
Customer: Array<CustomFieldConfig>;
CustomerGroup: Array<CustomFieldConfig>;
Facet: Array<CustomFieldConfig>;
FacetValue: Array<CustomFieldConfig>;
Fulfillment: Array<CustomFieldConfig>;
GlobalSettings: Array<CustomFieldConfig>;
Order: Array<CustomFieldConfig>;
OrderLine: Array<CustomFieldConfig>;
PaymentMethod: Array<CustomFieldConfig>;
Product: Array<CustomFieldConfig>;
ProductOption: Array<CustomFieldConfig>;
ProductOptionGroup: Array<CustomFieldConfig>;
ProductVariant: Array<CustomFieldConfig>;
ProductVariantPrice: Array<CustomFieldConfig>;
Promotion: Array<CustomFieldConfig>;
Region: Array<CustomFieldConfig>;
Seller: Array<CustomFieldConfig>;
ShippingMethod: Array<CustomFieldConfig>;
StockLocation: Array<CustomFieldConfig>;
TaxCategory: Array<CustomFieldConfig>;
TaxRate: Array<CustomFieldConfig>;
User: Array<CustomFieldConfig>;
Zone: Array<CustomFieldConfig>;
};
export type Customer = Node & {
addresses?: Maybe<Array<Address>>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
emailAddress: Scalars['String']['output'];
firstName: Scalars['String']['output'];
groups: Array<CustomerGroup>;
history: HistoryEntryList;
id: Scalars['ID']['output'];
lastName: Scalars['String']['output'];
orders: OrderList;
phoneNumber?: Maybe<Scalars['String']['output']>;
title?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
user?: Maybe<User>;
};
export type CustomerHistoryArgs = {
options?: InputMaybe<HistoryEntryListOptions>;
};
export type CustomerOrdersArgs = {
options?: InputMaybe<OrderListOptions>;
};
export type CustomerFilterParameter = {
_and?: InputMaybe<Array<CustomerFilterParameter>>;
_or?: InputMaybe<Array<CustomerFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
emailAddress?: InputMaybe<StringOperators>;
firstName?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
lastName?: InputMaybe<StringOperators>;
phoneNumber?: InputMaybe<StringOperators>;
postalCode?: InputMaybe<StringOperators>;
title?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CustomerGroup = Node & {
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
customers: CustomerList;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type CustomerGroupCustomersArgs = {
options?: InputMaybe<CustomerListOptions>;
};
export type CustomerGroupFilterParameter = {
_and?: InputMaybe<Array<CustomerGroupFilterParameter>>;
_or?: InputMaybe<Array<CustomerGroupFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type CustomerGroupList = PaginatedList & {
items: Array<CustomerGroup>;
totalItems: Scalars['Int']['output'];
};
export type CustomerGroupListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CustomerGroupFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CustomerGroupSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type CustomerGroupSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type CustomerList = PaginatedList & {
items: Array<Customer>;
totalItems: Scalars['Int']['output'];
};
export type CustomerListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<CustomerFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<CustomerSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type CustomerSortParameter = {
createdAt?: InputMaybe<SortOrder>;
emailAddress?: InputMaybe<SortOrder>;
firstName?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
lastName?: InputMaybe<SortOrder>;
phoneNumber?: InputMaybe<SortOrder>;
title?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
/** Operators for filtering on a list of Date fields */
export type DateListOperators = {
inList: Scalars['DateTime']['input'];
};
/** Operators for filtering on a DateTime field */
export type DateOperators = {
after?: InputMaybe<Scalars['DateTime']['input']>;
before?: InputMaybe<Scalars['DateTime']['input']>;
between?: InputMaybe<DateRange>;
eq?: InputMaybe<Scalars['DateTime']['input']>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
};
export type DateRange = {
end: Scalars['DateTime']['input'];
start: Scalars['DateTime']['input'];
};
/**
* Expects the same validation formats as the `<input type="datetime-local">` HTML element.
* See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes
*/
export type DateTimeCustomFieldConfig = CustomField & {
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['String']['output']>;
min?: Maybe<Scalars['String']['output']>;
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
requiresPermission?: Maybe<Array<Permission>>;
step?: Maybe<Scalars['Int']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type DeleteAssetInput = {
assetId: Scalars['ID']['input'];
deleteFromAllChannels?: InputMaybe<Scalars['Boolean']['input']>;
force?: InputMaybe<Scalars['Boolean']['input']>;
};
export type DeleteAssetsInput = {
assetIds: Array<Scalars['ID']['input']>;
deleteFromAllChannels?: InputMaybe<Scalars['Boolean']['input']>;
force?: InputMaybe<Scalars['Boolean']['input']>;
};
export type DeleteStockLocationInput = {
id: Scalars['ID']['input'];
transferToLocationId?: InputMaybe<Scalars['ID']['input']>;
};
export type DeletionResponse = {
message?: Maybe<Scalars['String']['output']>;
result: DeletionResult;
};
export enum DeletionResult {
/** The entity was successfully deleted */
DELETED = 'DELETED',
/** Deletion did not take place, reason given in message */
NOT_DELETED = 'NOT_DELETED'
}
export type Discount = {
adjustmentSource: Scalars['String']['output'];
amount: Scalars['Money']['output'];
amountWithTax: Scalars['Money']['output'];
description: Scalars['String']['output'];
type: AdjustmentType;
};
export type DuplicateEntityError = ErrorResult & {
duplicationError: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type DuplicateEntityInput = {
duplicatorInput: ConfigurableOperationInput;
entityId: Scalars['ID']['input'];
entityName: Scalars['String']['input'];
};
export type DuplicateEntityResult = DuplicateEntityError | DuplicateEntitySuccess;
export type DuplicateEntitySuccess = {
newEntityId: Scalars['ID']['output'];
};
/** Returned when attempting to create a Customer with an email address already registered to an existing User. */
export type EmailAddressConflictError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if no OrderLines have been specified for the operation */
export type EmptyOrderLineSelectionError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type EntityCustomFields = {
customFields: Array<CustomFieldConfig>;
entityName: Scalars['String']['output'];
};
export type EntityDuplicatorDefinition = {
args: Array<ConfigArgDefinition>;
code: Scalars['String']['output'];
description: Scalars['String']['output'];
forEntities: Array<Scalars['String']['output']>;
requiresPermission: Array<Permission>;
};
export enum ErrorCode {
ALREADY_REFUNDED_ERROR = 'ALREADY_REFUNDED_ERROR',
CANCEL_ACTIVE_ORDER_ERROR = 'CANCEL_ACTIVE_ORDER_ERROR',
CANCEL_PAYMENT_ERROR = 'CANCEL_PAYMENT_ERROR',
CHANNEL_DEFAULT_LANGUAGE_ERROR = 'CHANNEL_DEFAULT_LANGUAGE_ERROR',
COUPON_CODE_EXPIRED_ERROR = 'COUPON_CODE_EXPIRED_ERROR',
COUPON_CODE_INVALID_ERROR = 'COUPON_CODE_INVALID_ERROR',
COUPON_CODE_LIMIT_ERROR = 'COUPON_CODE_LIMIT_ERROR',
CREATE_FULFILLMENT_ERROR = 'CREATE_FULFILLMENT_ERROR',
DUPLICATE_ENTITY_ERROR = 'DUPLICATE_ENTITY_ERROR',
EMAIL_ADDRESS_CONFLICT_ERROR = 'EMAIL_ADDRESS_CONFLICT_ERROR',
EMPTY_ORDER_LINE_SELECTION_ERROR = 'EMPTY_ORDER_LINE_SELECTION_ERROR',
FACET_IN_USE_ERROR = 'FACET_IN_USE_ERROR',
FULFILLMENT_STATE_TRANSITION_ERROR = 'FULFILLMENT_STATE_TRANSITION_ERROR',
GUEST_CHECKOUT_ERROR = 'GUEST_CHECKOUT_ERROR',
INELIGIBLE_SHIPPING_METHOD_ERROR = 'INELIGIBLE_SHIPPING_METHOD_ERROR',
INSUFFICIENT_STOCK_ERROR = 'INSUFFICIENT_STOCK_ERROR',
INSUFFICIENT_STOCK_ON_HAND_ERROR = 'INSUFFICIENT_STOCK_ON_HAND_ERROR',
INVALID_CREDENTIALS_ERROR = 'INVALID_CREDENTIALS_ERROR',
INVALID_FULFILLMENT_HANDLER_ERROR = 'INVALID_FULFILLMENT_HANDLER_ERROR',
ITEMS_ALREADY_FULFILLED_ERROR = 'ITEMS_ALREADY_FULFILLED_ERROR',
LANGUAGE_NOT_AVAILABLE_ERROR = 'LANGUAGE_NOT_AVAILABLE_ERROR',
MANUAL_PAYMENT_STATE_ERROR = 'MANUAL_PAYMENT_STATE_ERROR',
MIME_TYPE_ERROR = 'MIME_TYPE_ERROR',
MISSING_CONDITIONS_ERROR = 'MISSING_CONDITIONS_ERROR',
MULTIPLE_ORDER_ERROR = 'MULTIPLE_ORDER_ERROR',
NATIVE_AUTH_STRATEGY_ERROR = 'NATIVE_AUTH_STRATEGY_ERROR',
NEGATIVE_QUANTITY_ERROR = 'NEGATIVE_QUANTITY_ERROR',
NOTHING_TO_REFUND_ERROR = 'NOTHING_TO_REFUND_ERROR',
NO_ACTIVE_ORDER_ERROR = 'NO_ACTIVE_ORDER_ERROR',
NO_CHANGES_SPECIFIED_ERROR = 'NO_CHANGES_SPECIFIED_ERROR',
ORDER_LIMIT_ERROR = 'ORDER_LIMIT_ERROR',
ORDER_MODIFICATION_ERROR = 'ORDER_MODIFICATION_ERROR',
ORDER_MODIFICATION_STATE_ERROR = 'ORDER_MODIFICATION_STATE_ERROR',
ORDER_STATE_TRANSITION_ERROR = 'ORDER_STATE_TRANSITION_ERROR',
PAYMENT_METHOD_MISSING_ERROR = 'PAYMENT_METHOD_MISSING_ERROR',
PAYMENT_ORDER_MISMATCH_ERROR = 'PAYMENT_ORDER_MISMATCH_ERROR',
PAYMENT_STATE_TRANSITION_ERROR = 'PAYMENT_STATE_TRANSITION_ERROR',
PRODUCT_OPTION_IN_USE_ERROR = 'PRODUCT_OPTION_IN_USE_ERROR',
QUANTITY_TOO_GREAT_ERROR = 'QUANTITY_TOO_GREAT_ERROR',
REFUND_AMOUNT_ERROR = 'REFUND_AMOUNT_ERROR',
REFUND_ORDER_STATE_ERROR = 'REFUND_ORDER_STATE_ERROR',
REFUND_PAYMENT_ID_MISSING_ERROR = 'REFUND_PAYMENT_ID_MISSING_ERROR',
REFUND_STATE_TRANSITION_ERROR = 'REFUND_STATE_TRANSITION_ERROR',
SETTLE_PAYMENT_ERROR = 'SETTLE_PAYMENT_ERROR',
UNKNOWN_ERROR = 'UNKNOWN_ERROR'
}
export type ErrorResult = {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Facet = Node & {
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
isPrivate: Scalars['Boolean']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<FacetTranslation>;
updatedAt: Scalars['DateTime']['output'];
/** Returns a paginated, sortable, filterable list of the Facet's values. Added in v2.1.0. */
valueList: FacetValueList;
values: Array<FacetValue>;
};
export type FacetValueListArgs = {
options?: InputMaybe<FacetValueListOptions>;
};
export type FacetFilterParameter = {
_and?: InputMaybe<Array<FacetFilterParameter>>;
_or?: InputMaybe<Array<FacetFilterParameter>>;
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
isPrivate?: InputMaybe<BooleanOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type FacetInUseError = ErrorResult & {
errorCode: ErrorCode;
facetCode: Scalars['String']['output'];
message: Scalars['String']['output'];
productCount: Scalars['Int']['output'];
variantCount: Scalars['Int']['output'];
};
export type FacetList = PaginatedList & {
items: Array<Facet>;
totalItems: Scalars['Int']['output'];
};
export type FacetListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<FacetFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<FacetSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type FacetSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type FacetTranslation = {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type FacetTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type FacetValue = Node & {
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
facet: Facet;
facetId: Scalars['ID']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<FacetValueTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
/**
* Used to construct boolean expressions for filtering search results
* by FacetValue ID. Examples:
*
* * ID=1 OR ID=2: `{ facetValueFilters: [{ or: [1,2] }] }`
* * ID=1 AND ID=2: `{ facetValueFilters: [{ and: 1 }, { and: 2 }] }`
* * ID=1 AND (ID=2 OR ID=3): `{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }`
*/
export type FacetValueFilterInput = {
and?: InputMaybe<Scalars['ID']['input']>;
or?: InputMaybe<Array<Scalars['ID']['input']>>;
};
export type FacetValueFilterParameter = {
_and?: InputMaybe<Array<FacetValueFilterParameter>>;
_or?: InputMaybe<Array<FacetValueFilterParameter>>;
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
facetId?: InputMaybe<IdOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type FacetValueList = PaginatedList & {
items: Array<FacetValue>;
totalItems: Scalars['Int']['output'];
};
export type FacetValueListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<FacetValueFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<FacetValueSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
/**
* Which FacetValues are present in the products returned
* by the search, and in what quantity.
*/
export type FacetValueResult = {
count: Scalars['Int']['output'];
facetValue: FacetValue;
};
export type FacetValueSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
facetId?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type FacetValueTranslation = {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type FacetValueTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type FloatCustomFieldConfig = CustomField & {
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['Float']['output']>;
min?: Maybe<Scalars['Float']['output']>;
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
requiresPermission?: Maybe<Array<Permission>>;
step?: Maybe<Scalars['Float']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type FulfillOrderInput = {
handler: ConfigurableOperationInput;
lines: Array<OrderLineInput>;
};
export type Fulfillment = Node & {
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
lines: Array<FulfillmentLine>;
method: Scalars['String']['output'];
nextStates: Array<Scalars['String']['output']>;
state: Scalars['String']['output'];
/** @deprecated Use the `lines` field instead */
summary: Array<FulfillmentLine>;
trackingCode?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type FulfillmentLine = {
fulfillment: Fulfillment;
fulfillmentId: Scalars['ID']['output'];
orderLine: OrderLine;
orderLineId: Scalars['ID']['output'];
quantity: Scalars['Int']['output'];
};
/** Returned when there is an error in transitioning the Fulfillment state */
export type FulfillmentStateTransitionError = ErrorResult & {
errorCode: ErrorCode;
fromState: Scalars['String']['output'];
message: Scalars['String']['output'];
toState: Scalars['String']['output'];
transitionError: Scalars['String']['output'];
};
export enum GlobalFlag {
FALSE = 'FALSE',
INHERIT = 'INHERIT',
TRUE = 'TRUE'
}
export type GlobalSettings = {
availableLanguages: Array<LanguageCode>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
outOfStockThreshold: Scalars['Int']['output'];
serverConfig: ServerConfig;
trackInventory: Scalars['Boolean']['output'];
updatedAt: Scalars['DateTime']['output'];
};
/** Returned when attempting to set the Customer on a guest checkout when the configured GuestCheckoutStrategy does not allow it. */
export type GuestCheckoutError = ErrorResult & {
errorCode: ErrorCode;
errorDetail: Scalars['String']['output'];
message: Scalars['String']['output'];
};
export type HistoryEntry = Node & {
administrator?: Maybe<Administrator>;
createdAt: Scalars['DateTime']['output'];
data: Scalars['JSON']['output'];
id: Scalars['ID']['output'];
isPublic: Scalars['Boolean']['output'];
type: HistoryEntryType;
updatedAt: Scalars['DateTime']['output'];
};
export type HistoryEntryFilterParameter = {
_and?: InputMaybe<Array<HistoryEntryFilterParameter>>;
_or?: InputMaybe<Array<HistoryEntryFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
isPublic?: InputMaybe<BooleanOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type HistoryEntryList = PaginatedList & {
items: Array<HistoryEntry>;
totalItems: Scalars['Int']['output'];
};
export type HistoryEntryListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<HistoryEntryFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<HistoryEntrySortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type HistoryEntrySortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export enum HistoryEntryType {
CUSTOMER_ADDED_TO_GROUP = 'CUSTOMER_ADDED_TO_GROUP',
CUSTOMER_ADDRESS_CREATED = 'CUSTOMER_ADDRESS_CREATED',
CUSTOMER_ADDRESS_DELETED = 'CUSTOMER_ADDRESS_DELETED',
CUSTOMER_ADDRESS_UPDATED = 'CUSTOMER_ADDRESS_UPDATED',
CUSTOMER_DETAIL_UPDATED = 'CUSTOMER_DETAIL_UPDATED',
CUSTOMER_EMAIL_UPDATE_REQUESTED = 'CUSTOMER_EMAIL_UPDATE_REQUESTED',
CUSTOMER_EMAIL_UPDATE_VERIFIED = 'CUSTOMER_EMAIL_UPDATE_VERIFIED',
CUSTOMER_NOTE = 'CUSTOMER_NOTE',
CUSTOMER_PASSWORD_RESET_REQUESTED = 'CUSTOMER_PASSWORD_RESET_REQUESTED',
CUSTOMER_PASSWORD_RESET_VERIFIED = 'CUSTOMER_PASSWORD_RESET_VERIFIED',
CUSTOMER_PASSWORD_UPDATED = 'CUSTOMER_PASSWORD_UPDATED',
CUSTOMER_REGISTERED = 'CUSTOMER_REGISTERED',
CUSTOMER_REMOVED_FROM_GROUP = 'CUSTOMER_REMOVED_FROM_GROUP',
CUSTOMER_VERIFIED = 'CUSTOMER_VERIFIED',
ORDER_CANCELLATION = 'ORDER_CANCELLATION',
ORDER_COUPON_APPLIED = 'ORDER_COUPON_APPLIED',
ORDER_COUPON_REMOVED = 'ORDER_COUPON_REMOVED',
ORDER_CUSTOMER_UPDATED = 'ORDER_CUSTOMER_UPDATED',
ORDER_FULFILLMENT = 'ORDER_FULFILLMENT',
ORDER_FULFILLMENT_TRANSITION = 'ORDER_FULFILLMENT_TRANSITION',
ORDER_MODIFIED = 'ORDER_MODIFIED',
ORDER_NOTE = 'ORDER_NOTE',
ORDER_PAYMENT_TRANSITION = 'ORDER_PAYMENT_TRANSITION',
ORDER_REFUND_TRANSITION = 'ORDER_REFUND_TRANSITION',
ORDER_STATE_TRANSITION = 'ORDER_STATE_TRANSITION'
}
/** Operators for filtering on a list of ID fields */
export type IdListOperators = {
inList: Scalars['ID']['input'];
};
/** Operators for filtering on an ID field */
export type IdOperators = {
eq?: InputMaybe<Scalars['String']['input']>;
in?: InputMaybe<Array<Scalars['String']['input']>>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
notEq?: InputMaybe<Scalars['String']['input']>;
notIn?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type ImportInfo = {
errors?: Maybe<Array<Scalars['String']['output']>>;
imported: Scalars['Int']['output'];
processed: Scalars['Int']['output'];
};
/** Returned when attempting to set a ShippingMethod for which the Order is not eligible */
export type IneligibleShippingMethodError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when attempting to add more items to the Order than are available */
export type InsufficientStockError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
order: Order;
quantityAvailable: Scalars['Int']['output'];
};
/**
* Returned if attempting to create a Fulfillment when there is insufficient
* stockOnHand of a ProductVariant to satisfy the requested quantity.
*/
export type InsufficientStockOnHandError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
productVariantId: Scalars['ID']['output'];
productVariantName: Scalars['String']['output'];
stockOnHand: Scalars['Int']['output'];
};
export type IntCustomFieldConfig = CustomField & {
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
max?: Maybe<Scalars['Int']['output']>;
min?: Maybe<Scalars['Int']['output']>;
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
requiresPermission?: Maybe<Array<Permission>>;
step?: Maybe<Scalars['Int']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
/** Returned if the user authentication credentials are not valid */
export type InvalidCredentialsError = ErrorResult & {
authenticationError: Scalars['String']['output'];
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the specified FulfillmentHandler code is not valid */
export type InvalidFulfillmentHandlerError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned if the specified items are already part of a Fulfillment */
export type ItemsAlreadyFulfilledError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Job = Node & {
attempts: Scalars['Int']['output'];
createdAt: Scalars['DateTime']['output'];
data?: Maybe<Scalars['JSON']['output']>;
duration: Scalars['Int']['output'];
error?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
isSettled: Scalars['Boolean']['output'];
progress: Scalars['Float']['output'];
queueName: Scalars['String']['output'];
result?: Maybe<Scalars['JSON']['output']>;
retries: Scalars['Int']['output'];
settledAt?: Maybe<Scalars['DateTime']['output']>;
startedAt?: Maybe<Scalars['DateTime']['output']>;
state: JobState;
};
export type JobBufferSize = {
bufferId: Scalars['String']['output'];
size: Scalars['Int']['output'];
};
export type JobFilterParameter = {
_and?: InputMaybe<Array<JobFilterParameter>>;
_or?: InputMaybe<Array<JobFilterParameter>>;
attempts?: InputMaybe<NumberOperators>;
createdAt?: InputMaybe<DateOperators>;
duration?: InputMaybe<NumberOperators>;
id?: InputMaybe<IdOperators>;
isSettled?: InputMaybe<BooleanOperators>;
progress?: InputMaybe<NumberOperators>;
queueName?: InputMaybe<StringOperators>;
retries?: InputMaybe<NumberOperators>;
settledAt?: InputMaybe<DateOperators>;
startedAt?: InputMaybe<DateOperators>;
state?: InputMaybe<StringOperators>;
};
export type JobList = PaginatedList & {
items: Array<Job>;
totalItems: Scalars['Int']['output'];
};
export type JobListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<JobFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<JobSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type JobQueue = {
name: Scalars['String']['output'];
running: Scalars['Boolean']['output'];
};
export type JobSortParameter = {
attempts?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
duration?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
progress?: InputMaybe<SortOrder>;
queueName?: InputMaybe<SortOrder>;
retries?: InputMaybe<SortOrder>;
settledAt?: InputMaybe<SortOrder>;
startedAt?: InputMaybe<SortOrder>;
};
/**
* @description
* The state of a Job in the JobQueue
*
* @docsCategory common
*/
export enum JobState {
CANCELLED = 'CANCELLED',
COMPLETED = 'COMPLETED',
FAILED = 'FAILED',
PENDING = 'PENDING',
RETRYING = 'RETRYING',
RUNNING = 'RUNNING'
}
/**
* @description
* Languages in the form of a ISO 639-1 language code with optional
* region or script modifier (e.g. de_AT). The selection available is based
* on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)
* and includes the major spoken languages of the world and any widely-used variants.
*
* @docsCategory common
*/
export enum LanguageCode {
/** Afrikaans */
af = 'af',
/** Akan */
ak = 'ak',
/** Amharic */
am = 'am',
/** Arabic */
ar = 'ar',
/** Assamese */
as = 'as',
/** Azerbaijani */
az = 'az',
/** Belarusian */
be = 'be',
/** Bulgarian */
bg = 'bg',
/** Bambara */
bm = 'bm',
/** Bangla */
bn = 'bn',
/** Tibetan */
bo = 'bo',
/** Breton */
br = 'br',
/** Bosnian */
bs = 'bs',
/** Catalan */
ca = 'ca',
/** Chechen */
ce = 'ce',
/** Corsican */
co = 'co',
/** Czech */
cs = 'cs',
/** Church Slavic */
cu = 'cu',
/** Welsh */
cy = 'cy',
/** Danish */
da = 'da',
/** German */
de = 'de',
/** Austrian German */
de_AT = 'de_AT',
/** Swiss High German */
de_CH = 'de_CH',
/** Dzongkha */
dz = 'dz',
/** Ewe */
ee = 'ee',
/** Greek */
el = 'el',
/** English */
en = 'en',
/** Australian English */
en_AU = 'en_AU',
/** Canadian English */
en_CA = 'en_CA',
/** British English */
en_GB = 'en_GB',
/** American English */
en_US = 'en_US',
/** Esperanto */
eo = 'eo',
/** Spanish */
es = 'es',
/** European Spanish */
es_ES = 'es_ES',
/** Mexican Spanish */
es_MX = 'es_MX',
/** Estonian */
et = 'et',
/** Basque */
eu = 'eu',
/** Persian */
fa = 'fa',
/** Dari */
fa_AF = 'fa_AF',
/** Fulah */
ff = 'ff',
/** Finnish */
fi = 'fi',
/** Faroese */
fo = 'fo',
/** French */
fr = 'fr',
/** Canadian French */
fr_CA = 'fr_CA',
/** Swiss French */
fr_CH = 'fr_CH',
/** Western Frisian */
fy = 'fy',
/** Irish */
ga = 'ga',
/** Scottish Gaelic */
gd = 'gd',
/** Galician */
gl = 'gl',
/** Gujarati */
gu = 'gu',
/** Manx */
gv = 'gv',
/** Hausa */
ha = 'ha',
/** Hebrew */
he = 'he',
/** Hindi */
hi = 'hi',
/** Croatian */
hr = 'hr',
/** Haitian Creole */
ht = 'ht',
/** Hungarian */
hu = 'hu',
/** Armenian */
hy = 'hy',
/** Interlingua */
ia = 'ia',
/** Indonesian */
id = 'id',
/** Igbo */
ig = 'ig',
/** Sichuan Yi */
ii = 'ii',
/** Icelandic */
is = 'is',
/** Italian */
it = 'it',
/** Japanese */
ja = 'ja',
/** Javanese */
jv = 'jv',
/** Georgian */
ka = 'ka',
/** Kikuyu */
ki = 'ki',
/** Kazakh */
kk = 'kk',
/** Kalaallisut */
kl = 'kl',
/** Khmer */
km = 'km',
/** Kannada */
kn = 'kn',
/** Korean */
ko = 'ko',
/** Kashmiri */
ks = 'ks',
/** Kurdish */
ku = 'ku',
/** Cornish */
kw = 'kw',
/** Kyrgyz */
ky = 'ky',
/** Latin */
la = 'la',
/** Luxembourgish */
lb = 'lb',
/** Ganda */
lg = 'lg',
/** Lingala */
ln = 'ln',
/** Lao */
lo = 'lo',
/** Lithuanian */
lt = 'lt',
/** Luba-Katanga */
lu = 'lu',
/** Latvian */
lv = 'lv',
/** Malagasy */
mg = 'mg',
/** Maori */
mi = 'mi',
/** Macedonian */
mk = 'mk',
/** Malayalam */
ml = 'ml',
/** Mongolian */
mn = 'mn',
/** Marathi */
mr = 'mr',
/** Malay */
ms = 'ms',
/** Maltese */
mt = 'mt',
/** Burmese */
my = 'my',
/** Norwegian Bokmål */
nb = 'nb',
/** North Ndebele */
nd = 'nd',
/** Nepali */
ne = 'ne',
/** Dutch */
nl = 'nl',
/** Flemish */
nl_BE = 'nl_BE',
/** Norwegian Nynorsk */
nn = 'nn',
/** Nyanja */
ny = 'ny',
/** Oromo */
om = 'om',
/** Odia */
or = 'or',
/** Ossetic */
os = 'os',
/** Punjabi */
pa = 'pa',
/** Polish */
pl = 'pl',
/** Pashto */
ps = 'ps',
/** Portuguese */
pt = 'pt',
/** Brazilian Portuguese */
pt_BR = 'pt_BR',
/** European Portuguese */
pt_PT = 'pt_PT',
/** Quechua */
qu = 'qu',
/** Romansh */
rm = 'rm',
/** Rundi */
rn = 'rn',
/** Romanian */
ro = 'ro',
/** Moldavian */
ro_MD = 'ro_MD',
/** Russian */
ru = 'ru',
/** Kinyarwanda */
rw = 'rw',
/** Sanskrit */
sa = 'sa',
/** Sindhi */
sd = 'sd',
/** Northern Sami */
se = 'se',
/** Sango */
sg = 'sg',
/** Sinhala */
si = 'si',
/** Slovak */
sk = 'sk',
/** Slovenian */
sl = 'sl',
/** Samoan */
sm = 'sm',
/** Shona */
sn = 'sn',
/** Somali */
so = 'so',
/** Albanian */
sq = 'sq',
/** Serbian */
sr = 'sr',
/** Southern Sotho */
st = 'st',
/** Sundanese */
su = 'su',
/** Swedish */
sv = 'sv',
/** Swahili */
sw = 'sw',
/** Congo Swahili */
sw_CD = 'sw_CD',
/** Tamil */
ta = 'ta',
/** Telugu */
te = 'te',
/** Tajik */
tg = 'tg',
/** Thai */
th = 'th',
/** Tigrinya */
ti = 'ti',
/** Turkmen */
tk = 'tk',
/** Tongan */
to = 'to',
/** Turkish */
tr = 'tr',
/** Tatar */
tt = 'tt',
/** Uyghur */
ug = 'ug',
/** Ukrainian */
uk = 'uk',
/** Urdu */
ur = 'ur',
/** Uzbek */
uz = 'uz',
/** Vietnamese */
vi = 'vi',
/** Volapük */
vo = 'vo',
/** Wolof */
wo = 'wo',
/** Xhosa */
xh = 'xh',
/** Yiddish */
yi = 'yi',
/** Yoruba */
yo = 'yo',
/** Chinese */
zh = 'zh',
/** Simplified Chinese */
zh_Hans = 'zh_Hans',
/** Traditional Chinese */
zh_Hant = 'zh_Hant',
/** Zulu */
zu = 'zu'
}
/** Returned if attempting to set a Channel's defaultLanguageCode to a language which is not enabled in GlobalSettings */
export type LanguageNotAvailableError = ErrorResult & {
errorCode: ErrorCode;
languageCode: Scalars['String']['output'];
message: Scalars['String']['output'];
};
export type LocaleStringCustomFieldConfig = CustomField & {
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
length?: Maybe<Scalars['Int']['output']>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
pattern?: Maybe<Scalars['String']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
requiresPermission?: Maybe<Array<Permission>>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type LocaleTextCustomFieldConfig = CustomField & {
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
requiresPermission?: Maybe<Array<Permission>>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type LocalizedString = {
languageCode: LanguageCode;
value: Scalars['String']['output'];
};
export enum LogicalOperator {
AND = 'AND',
OR = 'OR'
}
export type ManualPaymentInput = {
metadata?: InputMaybe<Scalars['JSON']['input']>;
method: Scalars['String']['input'];
orderId: Scalars['ID']['input'];
transactionId?: InputMaybe<Scalars['String']['input']>;
};
/**
* Returned when a call to addManualPaymentToOrder is made but the Order
* is not in the required state.
*/
export type ManualPaymentStateError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export enum MetricInterval {
Daily = 'Daily'
}
export type MetricSummary = {
entries: Array<MetricSummaryEntry>;
interval: MetricInterval;
title: Scalars['String']['output'];
type: MetricType;
};
export type MetricSummaryEntry = {
label: Scalars['String']['output'];
value: Scalars['Float']['output'];
};
export type MetricSummaryInput = {
interval: MetricInterval;
refresh?: InputMaybe<Scalars['Boolean']['input']>;
types: Array<MetricType>;
};
export enum MetricType {
AverageOrderValue = 'AverageOrderValue',
OrderCount = 'OrderCount',
OrderTotal = 'OrderTotal'
}
export type MimeTypeError = ErrorResult & {
errorCode: ErrorCode;
fileName: Scalars['String']['output'];
message: Scalars['String']['output'];
mimeType: Scalars['String']['output'];
};
/** Returned if a PromotionCondition has neither a couponCode nor any conditions set */
export type MissingConditionsError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type ModifyOrderInput = {
addItems?: InputMaybe<Array<AddItemInput>>;
adjustOrderLines?: InputMaybe<Array<OrderLineInput>>;
couponCodes?: InputMaybe<Array<Scalars['String']['input']>>;
dryRun: Scalars['Boolean']['input'];
note?: InputMaybe<Scalars['String']['input']>;
options?: InputMaybe<ModifyOrderOptions>;
orderId: Scalars['ID']['input'];
/**
* Deprecated in v2.2.0. Use `refunds` instead to allow multiple refunds to be
* applied in the case that multiple payment methods have been used on the order.
*/
refund?: InputMaybe<AdministratorRefundInput>;
refunds?: InputMaybe<Array<AdministratorRefundInput>>;
/** Added in v2.2 */
shippingMethodIds?: InputMaybe<Array<Scalars['ID']['input']>>;
surcharges?: InputMaybe<Array<SurchargeInput>>;
updateBillingAddress?: InputMaybe<UpdateOrderAddressInput>;
updateShippingAddress?: InputMaybe<UpdateOrderAddressInput>;
};
export type ModifyOrderOptions = {
freezePromotions?: InputMaybe<Scalars['Boolean']['input']>;
recalculateShipping?: InputMaybe<Scalars['Boolean']['input']>;
};
export type ModifyOrderResult = CouponCodeExpiredError | CouponCodeInvalidError | CouponCodeLimitError | IneligibleShippingMethodError | InsufficientStockError | NegativeQuantityError | NoChangesSpecifiedError | Order | OrderLimitError | OrderModificationStateError | PaymentMethodMissingError | RefundPaymentIdMissingError;
export type MoveCollectionInput = {
collectionId: Scalars['ID']['input'];
index: Scalars['Int']['input'];
parentId: Scalars['ID']['input'];
};
/** Returned if an operation has specified OrderLines from multiple Orders */
export type MultipleOrderError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Mutation = {
/** Add Customers to a CustomerGroup */
addCustomersToGroup: CustomerGroup;
addFulfillmentToOrder: AddFulfillmentToOrderResult;
/** Adds an item to the draft Order. */
addItemToDraftOrder: UpdateOrderItemsResult;
/**
* Used to manually create a new Payment against an Order.
* This can be used by an Administrator when an Order is in the ArrangingPayment state.
*
* It is also used when a completed Order
* has been modified (using `modifyOrder`) and the price has increased. The extra payment
* can then be manually arranged by the administrator, and the details used to create a new
* Payment.
*/
addManualPaymentToOrder: AddManualPaymentToOrderResult;
/** Add members to a Zone */
addMembersToZone: Zone;
addNoteToCustomer: Customer;
addNoteToOrder: Order;
/** Add an OptionGroup to a Product */
addOptionGroupToProduct: Product;
/** Adjusts a draft OrderLine. If custom fields are defined on the OrderLine entity, a third argument 'customFields' of type `OrderLineCustomFieldsInput` will be available. */
adjustDraftOrderLine: UpdateOrderItemsResult;
/** Applies the given coupon code to the draft Order */
applyCouponCodeToDraftOrder: ApplyCouponCodeResult;
/** Assign assets to channel */
assignAssetsToChannel: Array<Asset>;
/** Assigns Collections to the specified Channel */
assignCollectionsToChannel: Array<Collection>;
/** Assigns Facets to the specified Channel */
assignFacetsToChannel: Array<Facet>;
/** Assigns PaymentMethods to the specified Channel */
assignPaymentMethodsToChannel: Array<PaymentMethod>;
/** Assigns ProductVariants to the specified Channel */
assignProductVariantsToChannel: Array<ProductVariant>;
/** Assigns all ProductVariants of Product to the specified Channel */
assignProductsToChannel: Array<Product>;
/** Assigns Promotions to the specified Channel */
assignPromotionsToChannel: Array<Promotion>;
/** Assign a Role to an Administrator */
assignRoleToAdministrator: Administrator;
/** Assigns ShippingMethods to the specified Channel */
assignShippingMethodsToChannel: Array<ShippingMethod>;
/** Assigns StockLocations to the specified Channel */
assignStockLocationsToChannel: Array<StockLocation>;
/** Authenticates the user using a named authentication strategy */
authenticate: AuthenticationResult;
cancelJob: Job;
cancelOrder: CancelOrderResult;
cancelPayment: CancelPaymentResult;
/** Create a new Administrator */
createAdministrator: Administrator;
/** Create a new Asset */
createAssets: Array<CreateAssetResult>;
/** Create a new Channel */
createChannel: CreateChannelResult;
/** Create a new Collection */
createCollection: Collection;
/** Create a new Country */
createCountry: Country;
/** Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer. */
createCustomer: CreateCustomerResult;
/** Create a new Address and associate it with the Customer specified by customerId */
createCustomerAddress: Address;
/** Create a new CustomerGroup */
createCustomerGroup: CustomerGroup;
/** Creates a draft Order */
createDraftOrder: Order;
/** Create a new Facet */
createFacet: Facet;
/** Create one or more FacetValues */
createFacetValues: Array<FacetValue>;
/** Create existing PaymentMethod */
createPaymentMethod: PaymentMethod;
/** Create a new Product */
createProduct: Product;
/** Create a new ProductOption within a ProductOptionGroup */
createProductOption: ProductOption;
/** Create a new ProductOptionGroup */
createProductOptionGroup: ProductOptionGroup;
/** Create a set of ProductVariants based on the OptionGroups assigned to the given Product */
createProductVariants: Array<Maybe<ProductVariant>>;
createPromotion: CreatePromotionResult;
/** Create a new Province */
createProvince: Province;
/** Create a new Role */
createRole: Role;
/** Create a new Seller */
createSeller: Seller;
/** Create a new ShippingMethod */
createShippingMethod: ShippingMethod;
createStockLocation: StockLocation;
/** Create a new Tag */
createTag: Tag;
/** Create a new TaxCategory */
createTaxCategory: TaxCategory;
/** Create a new TaxRate */
createTaxRate: TaxRate;
/** Create a new Zone */
createZone: Zone;
/** Delete an Administrator */
deleteAdministrator: DeletionResponse;
/** Delete multiple Administrators */
deleteAdministrators: Array<DeletionResponse>;
/** Delete an Asset */
deleteAsset: DeletionResponse;
/** Delete multiple Assets */
deleteAssets: DeletionResponse;
/** Delete a Channel */
deleteChannel: DeletionResponse;
/** Delete multiple Channels */
deleteChannels: Array<DeletionResponse>;
/** Delete a Collection and all of its descendants */
deleteCollection: DeletionResponse;
/** Delete multiple Collections and all of their descendants */
deleteCollections: Array<DeletionResponse>;
/** Delete multiple Countries */
deleteCountries: Array<DeletionResponse>;
/** Delete a Country */
deleteCountry: DeletionResponse;
/** Delete a Customer */
deleteCustomer: DeletionResponse;
/** Update an existing Address */
deleteCustomerAddress: Success;
/** Delete a CustomerGroup */
deleteCustomerGroup: DeletionResponse;
/** Delete multiple CustomerGroups */
deleteCustomerGroups: Array<DeletionResponse>;
deleteCustomerNote: DeletionResponse;
/** Deletes Customers */
deleteCustomers: Array<DeletionResponse>;
/** Deletes a draft Order */
deleteDraftOrder: DeletionResponse;
/** Delete an existing Facet */
deleteFacet: DeletionResponse;
/** Delete one or more FacetValues */
deleteFacetValues: Array<DeletionResponse>;
/** Delete multiple existing Facets */
deleteFacets: Array<DeletionResponse>;
deleteOrderNote: DeletionResponse;
/** Delete a PaymentMethod */
deletePaymentMethod: DeletionResponse;
/** Delete multiple PaymentMethods */
deletePaymentMethods: Array<DeletionResponse>;
/** Delete a Product */
deleteProduct: DeletionResponse;
/** Delete a ProductOption */
deleteProductOption: DeletionResponse;
/** Delete a ProductVariant */
deleteProductVariant: DeletionResponse;
/** Delete multiple ProductVariants */
deleteProductVariants: Array<DeletionResponse>;
/** Delete multiple Products */
deleteProducts: Array<DeletionResponse>;
deletePromotion: DeletionResponse;
deletePromotions: Array<DeletionResponse>;
/** Delete a Province */
deleteProvince: DeletionResponse;
/** Delete an existing Role */
deleteRole: DeletionResponse;
/** Delete multiple Roles */
deleteRoles: Array<DeletionResponse>;
/** Delete a Seller */
deleteSeller: DeletionResponse;
/** Delete multiple Sellers */
deleteSellers: Array<DeletionResponse>;
/** Delete a ShippingMethod */
deleteShippingMethod: DeletionResponse;
/** Delete multiple ShippingMethods */
deleteShippingMethods: Array<DeletionResponse>;
deleteStockLocation: DeletionResponse;
deleteStockLocations: Array<DeletionResponse>;
/** Delete an existing Tag */
deleteTag: DeletionResponse;
/** Deletes multiple TaxCategories */
deleteTaxCategories: Array<DeletionResponse>;
/** Deletes a TaxCategory */
deleteTaxCategory: DeletionResponse;
/** Delete a TaxRate */
deleteTaxRate: DeletionResponse;
/** Delete multiple TaxRates */
deleteTaxRates: Array<DeletionResponse>;
/** Delete a Zone */
deleteZone: DeletionResponse;
/** Delete a Zone */
deleteZones: Array<DeletionResponse>;
duplicateEntity: DuplicateEntityResult;
flushBufferedJobs: Success;
importProducts?: Maybe<ImportInfo>;
/** Authenticates the user using the native authentication strategy. This mutation is an alias for `authenticate({ native: { ... }})` */
login: NativeAuthenticationResult;
logout: Success;
/**
* Allows an Order to be modified after it has been completed by the Customer. The Order must first
* be in the `Modifying` state.
*/
modifyOrder: ModifyOrderResult;
/** Move a Collection to a different parent or index */
moveCollection: Collection;
refundOrder: RefundOrderResult;
reindex: Job;
/** Removes Collections from the specified Channel */
removeCollectionsFromChannel: Array<Collection>;
/** Removes the given coupon code from the draft Order */
removeCouponCodeFromDraftOrder?: Maybe<Order>;
/** Remove Customers from a CustomerGroup */
removeCustomersFromGroup: CustomerGroup;
/** Remove an OrderLine from the draft Order */
removeDraftOrderLine: RemoveOrderItemsResult;
/** Removes Facets from the specified Channel */
removeFacetsFromChannel: Array<RemoveFacetFromChannelResult>;
/** Remove members from a Zone */
removeMembersFromZone: Zone;
/**
* Remove an OptionGroup from a Product. If the OptionGroup is in use by any ProductVariants
* the mutation will return a ProductOptionInUseError, and the OptionGroup will not be removed.
* Setting the `force` argument to `true` will override this and remove the OptionGroup anyway,
* as well as removing any of the group's options from the Product's ProductVariants.
*/
removeOptionGroupFromProduct: RemoveOptionGroupFromProductResult;
/** Removes PaymentMethods from the specified Channel */
removePaymentMethodsFromChannel: Array<PaymentMethod>;
/** Removes ProductVariants from the specified Channel */
removeProductVariantsFromChannel: Array<ProductVariant>;
/** Removes all ProductVariants of Product from the specified Channel */
removeProductsFromChannel: Array<Product>;
/** Removes Promotions from the specified Channel */
removePromotionsFromChannel: Array<Promotion>;
/** Remove all settled jobs in the given queues older than the given date. Returns the number of jobs deleted. */
removeSettledJobs: Scalars['Int']['output'];
/** Removes ShippingMethods from the specified Channel */
removeShippingMethodsFromChannel: Array<ShippingMethod>;
/** Removes StockLocations from the specified Channel */
removeStockLocationsFromChannel: Array<StockLocation>;
runPendingSearchIndexUpdates: Success;
setCustomerForDraftOrder: SetCustomerForDraftOrderResult;
/** Sets the billing address for a draft Order */
setDraftOrderBillingAddress: Order;
/** Allows any custom fields to be set for the active order */
setDraftOrderCustomFields: Order;
/** Sets the shipping address for a draft Order */
setDraftOrderShippingAddress: Order;
/** Sets the shipping method by id, which can be obtained with the `eligibleShippingMethodsForDraftOrder` query */
setDraftOrderShippingMethod: SetOrderShippingMethodResult;
setOrderCustomFields?: Maybe<Order>;
/** Allows a different Customer to be assigned to an Order. Added in v2.2.0. */
setOrderCustomer?: Maybe<Order>;
settlePayment: SettlePaymentResult;
settleRefund: SettleRefundResult;
transitionFulfillmentToState: TransitionFulfillmentToStateResult;
transitionOrderToState?: Maybe<TransitionOrderToStateResult>;
transitionPaymentToState: TransitionPaymentToStateResult;
/** Update the active (currently logged-in) Administrator */
updateActiveAdministrator: Administrator;
/** Update an existing Administrator */
updateAdministrator: Administrator;
/** Update an existing Asset */
updateAsset: Asset;
/** Update an existing Channel */
updateChannel: UpdateChannelResult;
/** Update an existing Collection */
updateCollection: Collection;
/** Update an existing Country */
updateCountry: Country;
/** Update an existing Customer */
updateCustomer: UpdateCustomerResult;
/** Update an existing Address */
updateCustomerAddress: Address;
/** Update an existing CustomerGroup */
updateCustomerGroup: CustomerGroup;
updateCustomerNote: HistoryEntry;
/** Update an existing Facet */
updateFacet: Facet;
/** Update one or more FacetValues */
updateFacetValues: Array<FacetValue>;
updateGlobalSettings: UpdateGlobalSettingsResult;
updateOrderNote: HistoryEntry;
/** Update an existing PaymentMethod */
updatePaymentMethod: PaymentMethod;
/** Update an existing Product */
updateProduct: Product;
/** Create a new ProductOption within a ProductOptionGroup */
updateProductOption: ProductOption;
/** Update an existing ProductOptionGroup */
updateProductOptionGroup: ProductOptionGroup;
/** Update existing ProductVariants */
updateProductVariants: Array<Maybe<ProductVariant>>;
/** Update multiple existing Products */
updateProducts: Array<Product>;
updatePromotion: UpdatePromotionResult;
/** Update an existing Province */
updateProvince: Province;
/** Update an existing Role */
updateRole: Role;
/** Update an existing Seller */
updateSeller: Seller;
/** Update an existing ShippingMethod */
updateShippingMethod: ShippingMethod;
updateStockLocation: StockLocation;
/** Update an existing Tag */
updateTag: Tag;
/** Update an existing TaxCategory */
updateTaxCategory: TaxCategory;
/** Update an existing TaxRate */
updateTaxRate: TaxRate;
/** Update an existing Zone */
updateZone: Zone;
};
export type MutationAddCustomersToGroupArgs = {
customerGroupId: Scalars['ID']['input'];
customerIds: Array<Scalars['ID']['input']>;
};
export type MutationAddFulfillmentToOrderArgs = {
input: FulfillOrderInput;
};
export type MutationAddItemToDraftOrderArgs = {
input: AddItemToDraftOrderInput;
orderId: Scalars['ID']['input'];
};
export type MutationAddManualPaymentToOrderArgs = {
input: ManualPaymentInput;
};
export type MutationAddMembersToZoneArgs = {
memberIds: Array<Scalars['ID']['input']>;
zoneId: Scalars['ID']['input'];
};
export type MutationAddNoteToCustomerArgs = {
input: AddNoteToCustomerInput;
};
export type MutationAddNoteToOrderArgs = {
input: AddNoteToOrderInput;
};
export type MutationAddOptionGroupToProductArgs = {
optionGroupId: Scalars['ID']['input'];
productId: Scalars['ID']['input'];
};
export type MutationAdjustDraftOrderLineArgs = {
input: AdjustDraftOrderLineInput;
orderId: Scalars['ID']['input'];
};
export type MutationApplyCouponCodeToDraftOrderArgs = {
couponCode: Scalars['String']['input'];
orderId: Scalars['ID']['input'];
};
export type MutationAssignAssetsToChannelArgs = {
input: AssignAssetsToChannelInput;
};
export type MutationAssignCollectionsToChannelArgs = {
input: AssignCollectionsToChannelInput;
};
export type MutationAssignFacetsToChannelArgs = {
input: AssignFacetsToChannelInput;
};
export type MutationAssignPaymentMethodsToChannelArgs = {
input: AssignPaymentMethodsToChannelInput;
};
export type MutationAssignProductVariantsToChannelArgs = {
input: AssignProductVariantsToChannelInput;
};
export type MutationAssignProductsToChannelArgs = {
input: AssignProductsToChannelInput;
};
export type MutationAssignPromotionsToChannelArgs = {
input: AssignPromotionsToChannelInput;
};
export type MutationAssignRoleToAdministratorArgs = {
administratorId: Scalars['ID']['input'];
roleId: Scalars['ID']['input'];
};
export type MutationAssignShippingMethodsToChannelArgs = {
input: AssignShippingMethodsToChannelInput;
};
export type MutationAssignStockLocationsToChannelArgs = {
input: AssignStockLocationsToChannelInput;
};
export type MutationAuthenticateArgs = {
input: AuthenticationInput;
rememberMe?: InputMaybe<Scalars['Boolean']['input']>;
};
export type MutationCancelJobArgs = {
jobId: Scalars['ID']['input'];
};
export type MutationCancelOrderArgs = {
input: CancelOrderInput;
};
export type MutationCancelPaymentArgs = {
id: Scalars['ID']['input'];
};
export type MutationCreateAdministratorArgs = {
input: CreateAdministratorInput;
};
export type MutationCreateAssetsArgs = {
input: Array<CreateAssetInput>;
};
export type MutationCreateChannelArgs = {
input: CreateChannelInput;
};
export type MutationCreateCollectionArgs = {
input: CreateCollectionInput;
};
export type MutationCreateCountryArgs = {
input: CreateCountryInput;
};
export type MutationCreateCustomerArgs = {
input: CreateCustomerInput;
password?: InputMaybe<Scalars['String']['input']>;
};
export type MutationCreateCustomerAddressArgs = {
customerId: Scalars['ID']['input'];
input: CreateAddressInput;
};
export type MutationCreateCustomerGroupArgs = {
input: CreateCustomerGroupInput;
};
export type MutationCreateFacetArgs = {
input: CreateFacetInput;
};
export type MutationCreateFacetValuesArgs = {
input: Array<CreateFacetValueInput>;
};
export type MutationCreatePaymentMethodArgs = {
input: CreatePaymentMethodInput;
};
export type MutationCreateProductArgs = {
input: CreateProductInput;
};
export type MutationCreateProductOptionArgs = {
input: CreateProductOptionInput;
};
export type MutationCreateProductOptionGroupArgs = {
input: CreateProductOptionGroupInput;
};
export type MutationCreateProductVariantsArgs = {
input: Array<CreateProductVariantInput>;
};
export type MutationCreatePromotionArgs = {
input: CreatePromotionInput;
};
export type MutationCreateProvinceArgs = {
input: CreateProvinceInput;
};
export type MutationCreateRoleArgs = {
input: CreateRoleInput;
};
export type MutationCreateSellerArgs = {
input: CreateSellerInput;
};
export type MutationCreateShippingMethodArgs = {
input: CreateShippingMethodInput;
};
export type MutationCreateStockLocationArgs = {
input: CreateStockLocationInput;
};
export type MutationCreateTagArgs = {
input: CreateTagInput;
};
export type MutationCreateTaxCategoryArgs = {
input: CreateTaxCategoryInput;
};
export type MutationCreateTaxRateArgs = {
input: CreateTaxRateInput;
};
export type MutationCreateZoneArgs = {
input: CreateZoneInput;
};
export type MutationDeleteAdministratorArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteAdministratorsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteAssetArgs = {
input: DeleteAssetInput;
};
export type MutationDeleteAssetsArgs = {
input: DeleteAssetsInput;
};
export type MutationDeleteChannelArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteChannelsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteCollectionArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCollectionsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteCountriesArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteCountryArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCustomerArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCustomerAddressArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCustomerGroupArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCustomerGroupsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteCustomerNoteArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteCustomersArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteDraftOrderArgs = {
orderId: Scalars['ID']['input'];
};
export type MutationDeleteFacetArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
id: Scalars['ID']['input'];
};
export type MutationDeleteFacetValuesArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteFacetsArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteOrderNoteArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeletePaymentMethodArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
id: Scalars['ID']['input'];
};
export type MutationDeletePaymentMethodsArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteProductArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteProductOptionArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteProductVariantArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteProductVariantsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteProductsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeletePromotionArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeletePromotionsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteProvinceArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteRoleArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteRolesArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteSellerArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteSellersArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteShippingMethodArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteShippingMethodsArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteStockLocationArgs = {
input: DeleteStockLocationInput;
};
export type MutationDeleteStockLocationsArgs = {
input: Array<DeleteStockLocationInput>;
};
export type MutationDeleteTagArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteTaxCategoriesArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteTaxCategoryArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteTaxRateArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteTaxRatesArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDeleteZoneArgs = {
id: Scalars['ID']['input'];
};
export type MutationDeleteZonesArgs = {
ids: Array<Scalars['ID']['input']>;
};
export type MutationDuplicateEntityArgs = {
input: DuplicateEntityInput;
};
export type MutationFlushBufferedJobsArgs = {
bufferIds?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type MutationImportProductsArgs = {
csvFile: Scalars['Upload']['input'];
};
export type MutationLoginArgs = {
password: Scalars['String']['input'];
rememberMe?: InputMaybe<Scalars['Boolean']['input']>;
username: Scalars['String']['input'];
};
export type MutationModifyOrderArgs = {
input: ModifyOrderInput;
};
export type MutationMoveCollectionArgs = {
input: MoveCollectionInput;
};
export type MutationRefundOrderArgs = {
input: RefundOrderInput;
};
export type MutationRemoveCollectionsFromChannelArgs = {
input: RemoveCollectionsFromChannelInput;
};
export type MutationRemoveCouponCodeFromDraftOrderArgs = {
couponCode: Scalars['String']['input'];
orderId: Scalars['ID']['input'];
};
export type MutationRemoveCustomersFromGroupArgs = {
customerGroupId: Scalars['ID']['input'];
customerIds: Array<Scalars['ID']['input']>;
};
export type MutationRemoveDraftOrderLineArgs = {
orderId: Scalars['ID']['input'];
orderLineId: Scalars['ID']['input'];
};
export type MutationRemoveFacetsFromChannelArgs = {
input: RemoveFacetsFromChannelInput;
};
export type MutationRemoveMembersFromZoneArgs = {
memberIds: Array<Scalars['ID']['input']>;
zoneId: Scalars['ID']['input'];
};
export type MutationRemoveOptionGroupFromProductArgs = {
force?: InputMaybe<Scalars['Boolean']['input']>;
optionGroupId: Scalars['ID']['input'];
productId: Scalars['ID']['input'];
};
export type MutationRemovePaymentMethodsFromChannelArgs = {
input: RemovePaymentMethodsFromChannelInput;
};
export type MutationRemoveProductVariantsFromChannelArgs = {
input: RemoveProductVariantsFromChannelInput;
};
export type MutationRemoveProductsFromChannelArgs = {
input: RemoveProductsFromChannelInput;
};
export type MutationRemovePromotionsFromChannelArgs = {
input: RemovePromotionsFromChannelInput;
};
export type MutationRemoveSettledJobsArgs = {
olderThan?: InputMaybe<Scalars['DateTime']['input']>;
queueNames?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type MutationRemoveShippingMethodsFromChannelArgs = {
input: RemoveShippingMethodsFromChannelInput;
};
export type MutationRemoveStockLocationsFromChannelArgs = {
input: RemoveStockLocationsFromChannelInput;
};
export type MutationSetCustomerForDraftOrderArgs = {
customerId?: InputMaybe<Scalars['ID']['input']>;
input?: InputMaybe<CreateCustomerInput>;
orderId: Scalars['ID']['input'];
};
export type MutationSetDraftOrderBillingAddressArgs = {
input: CreateAddressInput;
orderId: Scalars['ID']['input'];
};
export type MutationSetDraftOrderCustomFieldsArgs = {
input: UpdateOrderInput;
orderId: Scalars['ID']['input'];
};
export type MutationSetDraftOrderShippingAddressArgs = {
input: CreateAddressInput;
orderId: Scalars['ID']['input'];
};
export type MutationSetDraftOrderShippingMethodArgs = {
orderId: Scalars['ID']['input'];
shippingMethodId: Scalars['ID']['input'];
};
export type MutationSetOrderCustomFieldsArgs = {
input: UpdateOrderInput;
};
export type MutationSetOrderCustomerArgs = {
input: SetOrderCustomerInput;
};
export type MutationSettlePaymentArgs = {
id: Scalars['ID']['input'];
};
export type MutationSettleRefundArgs = {
input: SettleRefundInput;
};
export type MutationTransitionFulfillmentToStateArgs = {
id: Scalars['ID']['input'];
state: Scalars['String']['input'];
};
export type MutationTransitionOrderToStateArgs = {
id: Scalars['ID']['input'];
state: Scalars['String']['input'];
};
export type MutationTransitionPaymentToStateArgs = {
id: Scalars['ID']['input'];
state: Scalars['String']['input'];
};
export type MutationUpdateActiveAdministratorArgs = {
input: UpdateActiveAdministratorInput;
};
export type MutationUpdateAdministratorArgs = {
input: UpdateAdministratorInput;
};
export type MutationUpdateAssetArgs = {
input: UpdateAssetInput;
};
export type MutationUpdateChannelArgs = {
input: UpdateChannelInput;
};
export type MutationUpdateCollectionArgs = {
input: UpdateCollectionInput;
};
export type MutationUpdateCountryArgs = {
input: UpdateCountryInput;
};
export type MutationUpdateCustomerArgs = {
input: UpdateCustomerInput;
};
export type MutationUpdateCustomerAddressArgs = {
input: UpdateAddressInput;
};
export type MutationUpdateCustomerGroupArgs = {
input: UpdateCustomerGroupInput;
};
export type MutationUpdateCustomerNoteArgs = {
input: UpdateCustomerNoteInput;
};
export type MutationUpdateFacetArgs = {
input: UpdateFacetInput;
};
export type MutationUpdateFacetValuesArgs = {
input: Array<UpdateFacetValueInput>;
};
export type MutationUpdateGlobalSettingsArgs = {
input: UpdateGlobalSettingsInput;
};
export type MutationUpdateOrderNoteArgs = {
input: UpdateOrderNoteInput;
};
export type MutationUpdatePaymentMethodArgs = {
input: UpdatePaymentMethodInput;
};
export type MutationUpdateProductArgs = {
input: UpdateProductInput;
};
export type MutationUpdateProductOptionArgs = {
input: UpdateProductOptionInput;
};
export type MutationUpdateProductOptionGroupArgs = {
input: UpdateProductOptionGroupInput;
};
export type MutationUpdateProductVariantsArgs = {
input: Array<UpdateProductVariantInput>;
};
export type MutationUpdateProductsArgs = {
input: Array<UpdateProductInput>;
};
export type MutationUpdatePromotionArgs = {
input: UpdatePromotionInput;
};
export type MutationUpdateProvinceArgs = {
input: UpdateProvinceInput;
};
export type MutationUpdateRoleArgs = {
input: UpdateRoleInput;
};
export type MutationUpdateSellerArgs = {
input: UpdateSellerInput;
};
export type MutationUpdateShippingMethodArgs = {
input: UpdateShippingMethodInput;
};
export type MutationUpdateStockLocationArgs = {
input: UpdateStockLocationInput;
};
export type MutationUpdateTagArgs = {
input: UpdateTagInput;
};
export type MutationUpdateTaxCategoryArgs = {
input: UpdateTaxCategoryInput;
};
export type MutationUpdateTaxRateArgs = {
input: UpdateTaxRateInput;
};
export type MutationUpdateZoneArgs = {
input: UpdateZoneInput;
};
export type NativeAuthInput = {
password: Scalars['String']['input'];
username: Scalars['String']['input'];
};
/** Returned when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured. */
export type NativeAuthStrategyError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type NativeAuthenticationResult = CurrentUser | InvalidCredentialsError | NativeAuthStrategyError;
/** Returned when attempting to set a negative OrderLine quantity. */
export type NegativeQuantityError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/**
* Returned when invoking a mutation which depends on there being an active Order on the
* current session.
*/
export type NoActiveOrderError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when a call to modifyOrder fails to specify any changes */
export type NoChangesSpecifiedError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Node = {
id: Scalars['ID']['output'];
};
/** Returned if an attempting to refund an Order but neither items nor shipping refund was specified */
export type NothingToRefundError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Operators for filtering on a list of Number fields */
export type NumberListOperators = {
inList: Scalars['Float']['input'];
};
/** Operators for filtering on a Int or Float field */
export type NumberOperators = {
between?: InputMaybe<NumberRange>;
eq?: InputMaybe<Scalars['Float']['input']>;
gt?: InputMaybe<Scalars['Float']['input']>;
gte?: InputMaybe<Scalars['Float']['input']>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
lt?: InputMaybe<Scalars['Float']['input']>;
lte?: InputMaybe<Scalars['Float']['input']>;
};
export type NumberRange = {
end: Scalars['Float']['input'];
start: Scalars['Float']['input'];
};
export type Order = Node & {
/** An order is active as long as the payment process has not been completed */
active: Scalars['Boolean']['output'];
aggregateOrder?: Maybe<Order>;
aggregateOrderId?: Maybe<Scalars['ID']['output']>;
billingAddress?: Maybe<OrderAddress>;
channels: Array<Channel>;
/** A unique code for the Order */
code: Scalars['String']['output'];
/** An array of all coupon codes applied to the Order */
couponCodes: Array<Scalars['String']['output']>;
createdAt: Scalars['DateTime']['output'];
currencyCode: CurrencyCode;
customFields?: Maybe<Scalars['JSON']['output']>;
customer?: Maybe<Customer>;
discounts: Array<Discount>;
fulfillments?: Maybe<Array<Fulfillment>>;
history: HistoryEntryList;
id: Scalars['ID']['output'];
lines: Array<OrderLine>;
modifications: Array<OrderModification>;
nextStates: Array<Scalars['String']['output']>;
/**
* The date & time that the Order was placed, i.e. the Customer
* completed the checkout and the Order is no longer "active"
*/
orderPlacedAt?: Maybe<Scalars['DateTime']['output']>;
payments?: Maybe<Array<Payment>>;
/** Promotions applied to the order. Only gets populated after the payment process has completed. */
promotions: Array<Promotion>;
sellerOrders?: Maybe<Array<Order>>;
shipping: Scalars['Money']['output'];
shippingAddress?: Maybe<OrderAddress>;
shippingLines: Array<ShippingLine>;
shippingWithTax: Scalars['Money']['output'];
state: Scalars['String']['output'];
/**
* The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
* discounts which have been prorated (proportionally distributed) amongst the items of each OrderLine.
* To get a total of all OrderLines which does not account for prorated discounts, use the
* sum of `OrderLine.discountedLinePrice` values.
*/
subTotal: Scalars['Money']['output'];
/** Same as subTotal, but inclusive of tax */
subTotalWithTax: Scalars['Money']['output'];
/**
* Surcharges are arbitrary modifications to the Order total which are neither
* ProductVariants nor discounts resulting from applied Promotions. For example,
* one-off discounts based on customer interaction, or surcharges based on payment
* methods.
*/
surcharges: Array<Surcharge>;
/** A summary of the taxes being applied to this Order */
taxSummary: Array<OrderTaxSummary>;
/** Equal to subTotal plus shipping */
total: Scalars['Money']['output'];
totalQuantity: Scalars['Int']['output'];
/** The final payable amount. Equal to subTotalWithTax plus shippingWithTax */
totalWithTax: Scalars['Money']['output'];
type: OrderType;
updatedAt: Scalars['DateTime']['output'];
};
export type OrderHistoryArgs = {
options?: InputMaybe<HistoryEntryListOptions>;
};
export type OrderAddress = {
city?: Maybe<Scalars['String']['output']>;
company?: Maybe<Scalars['String']['output']>;
country?: Maybe<Scalars['String']['output']>;
countryCode?: Maybe<Scalars['String']['output']>;
customFields?: Maybe<Scalars['JSON']['output']>;
fullName?: Maybe<Scalars['String']['output']>;
phoneNumber?: Maybe<Scalars['String']['output']>;
postalCode?: Maybe<Scalars['String']['output']>;
province?: Maybe<Scalars['String']['output']>;
streetLine1?: Maybe<Scalars['String']['output']>;
streetLine2?: Maybe<Scalars['String']['output']>;
};
export type OrderFilterParameter = {
_and?: InputMaybe<Array<OrderFilterParameter>>;
_or?: InputMaybe<Array<OrderFilterParameter>>;
active?: InputMaybe<BooleanOperators>;
aggregateOrderId?: InputMaybe<IdOperators>;
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
currencyCode?: InputMaybe<StringOperators>;
customerLastName?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
orderPlacedAt?: InputMaybe<DateOperators>;
shipping?: InputMaybe<NumberOperators>;
shippingWithTax?: InputMaybe<NumberOperators>;
state?: InputMaybe<StringOperators>;
subTotal?: InputMaybe<NumberOperators>;
subTotalWithTax?: InputMaybe<NumberOperators>;
total?: InputMaybe<NumberOperators>;
totalQuantity?: InputMaybe<NumberOperators>;
totalWithTax?: InputMaybe<NumberOperators>;
transactionId?: InputMaybe<StringOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
/** Returned when the maximum order size limit has been reached. */
export type OrderLimitError = ErrorResult & {
errorCode: ErrorCode;
maxItems: Scalars['Int']['output'];
message: Scalars['String']['output'];
};
export type OrderLine = Node & {
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
/** The price of the line including discounts, excluding tax */
discountedLinePrice: Scalars['Money']['output'];
/** The price of the line including discounts and tax */
discountedLinePriceWithTax: Scalars['Money']['output'];
/**
* The price of a single unit including discounts, excluding tax.
*
* If Order-level discounts have been applied, this will not be the
* actual taxable unit price (see `proratedUnitPrice`), but is generally the
* correct price to display to customers to avoid confusion
* about the internal handling of distributed Order-level discounts.
*/
discountedUnitPrice: Scalars['Money']['output'];
/** The price of a single unit including discounts and tax */
discountedUnitPriceWithTax: Scalars['Money']['output'];
discounts: Array<Discount>;
featuredAsset?: Maybe<Asset>;
fulfillmentLines?: Maybe<Array<FulfillmentLine>>;
id: Scalars['ID']['output'];
/** The total price of the line excluding tax and discounts. */
linePrice: Scalars['Money']['output'];
/** The total price of the line including tax but excluding discounts. */
linePriceWithTax: Scalars['Money']['output'];
/** The total tax on this line */
lineTax: Scalars['Money']['output'];
order: Order;
/** The quantity at the time the Order was placed */
orderPlacedQuantity: Scalars['Int']['output'];
productVariant: ProductVariant;
/**
* The actual line price, taking into account both item discounts _and_ prorated (proportionally-distributed)
* Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax
* and refund calculations.
*/
proratedLinePrice: Scalars['Money']['output'];
/** The proratedLinePrice including tax */
proratedLinePriceWithTax: Scalars['Money']['output'];
/**
* The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed)
* Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax
* and refund calculations.
*/
proratedUnitPrice: Scalars['Money']['output'];
/** The proratedUnitPrice including tax */
proratedUnitPriceWithTax: Scalars['Money']['output'];
/** The quantity of items purchased */
quantity: Scalars['Int']['output'];
taxLines: Array<TaxLine>;
taxRate: Scalars['Float']['output'];
/** The price of a single unit, excluding tax and discounts */
unitPrice: Scalars['Money']['output'];
/** Non-zero if the unitPrice has changed since it was initially added to Order */
unitPriceChangeSinceAdded: Scalars['Money']['output'];
/** The price of a single unit, including tax but excluding discounts */
unitPriceWithTax: Scalars['Money']['output'];
/** Non-zero if the unitPriceWithTax has changed since it was initially added to Order */
unitPriceWithTaxChangeSinceAdded: Scalars['Money']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type OrderLineInput = {
orderLineId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type OrderList = PaginatedList & {
items: Array<Order>;
totalItems: Scalars['Int']['output'];
};
export type OrderListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<OrderFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<OrderSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type OrderModification = Node & {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
isSettled: Scalars['Boolean']['output'];
lines: Array<OrderModificationLine>;
note: Scalars['String']['output'];
payment?: Maybe<Payment>;
priceChange: Scalars['Money']['output'];
refund?: Maybe<Refund>;
surcharges?: Maybe<Array<Surcharge>>;
updatedAt: Scalars['DateTime']['output'];
};
/** Returned when attempting to modify the contents of an Order that is not in the `AddingItems` state. */
export type OrderModificationError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type OrderModificationLine = {
modification: OrderModification;
modificationId: Scalars['ID']['output'];
orderLine: OrderLine;
orderLineId: Scalars['ID']['output'];
quantity: Scalars['Int']['output'];
};
/** Returned when attempting to modify the contents of an Order that is not in the `Modifying` state. */
export type OrderModificationStateError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type OrderProcessState = {
name: Scalars['String']['output'];
to: Array<Scalars['String']['output']>;
};
export type OrderSortParameter = {
aggregateOrderId?: InputMaybe<SortOrder>;
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
customerLastName?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
orderPlacedAt?: InputMaybe<SortOrder>;
shipping?: InputMaybe<SortOrder>;
shippingWithTax?: InputMaybe<SortOrder>;
state?: InputMaybe<SortOrder>;
subTotal?: InputMaybe<SortOrder>;
subTotalWithTax?: InputMaybe<SortOrder>;
total?: InputMaybe<SortOrder>;
totalQuantity?: InputMaybe<SortOrder>;
totalWithTax?: InputMaybe<SortOrder>;
transactionId?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
/** Returned if there is an error in transitioning the Order state */
export type OrderStateTransitionError = ErrorResult & {
errorCode: ErrorCode;
fromState: Scalars['String']['output'];
message: Scalars['String']['output'];
toState: Scalars['String']['output'];
transitionError: Scalars['String']['output'];
};
/**
* A summary of the taxes being applied to this order, grouped
* by taxRate.
*/
export type OrderTaxSummary = {
/** A description of this tax */
description: Scalars['String']['output'];
/** The total net price of OrderLines to which this taxRate applies */
taxBase: Scalars['Money']['output'];
/** The taxRate as a percentage */
taxRate: Scalars['Float']['output'];
/** The total tax being applied to the Order at this taxRate */
taxTotal: Scalars['Money']['output'];
};
export enum OrderType {
Aggregate = 'Aggregate',
Regular = 'Regular',
Seller = 'Seller'
}
export type PaginatedList = {
items: Array<Node>;
totalItems: Scalars['Int']['output'];
};
export type Payment = Node & {
amount: Scalars['Money']['output'];
createdAt: Scalars['DateTime']['output'];
errorMessage?: Maybe<Scalars['String']['output']>;
id: Scalars['ID']['output'];
metadata?: Maybe<Scalars['JSON']['output']>;
method: Scalars['String']['output'];
nextStates: Array<Scalars['String']['output']>;
refunds: Array<Refund>;
state: Scalars['String']['output'];
transactionId?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
export type PaymentMethod = Node & {
checker?: Maybe<ConfigurableOperation>;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
enabled: Scalars['Boolean']['output'];
handler: ConfigurableOperation;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
translations: Array<PaymentMethodTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type PaymentMethodFilterParameter = {
_and?: InputMaybe<Array<PaymentMethodFilterParameter>>;
_or?: InputMaybe<Array<PaymentMethodFilterParameter>>;
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
enabled?: InputMaybe<BooleanOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type PaymentMethodList = PaginatedList & {
items: Array<PaymentMethod>;
totalItems: Scalars['Int']['output'];
};
export type PaymentMethodListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<PaymentMethodFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<PaymentMethodSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
/**
* Returned when a call to modifyOrder fails to include a paymentMethod even
* though the price has increased as a result of the changes.
*/
export type PaymentMethodMissingError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type PaymentMethodQuote = {
code: Scalars['String']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
eligibilityMessage?: Maybe<Scalars['String']['output']>;
id: Scalars['ID']['output'];
isEligible: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
};
export type PaymentMethodSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type PaymentMethodTranslation = {
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type PaymentMethodTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
/** Returned if an attempting to refund a Payment against OrderLines from a different Order */
export type PaymentOrderMismatchError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when there is an error in transitioning the Payment state */
export type PaymentStateTransitionError = ErrorResult & {
errorCode: ErrorCode;
fromState: Scalars['String']['output'];
message: Scalars['String']['output'];
toState: Scalars['String']['output'];
transitionError: Scalars['String']['output'];
};
/**
* @description
* Permissions for administrators and customers. Used to control access to
* GraphQL resolvers via the {@link Allow} decorator.
*
* ## Understanding Permission.Owner
*
* `Permission.Owner` is a special permission which is used in some Vendure resolvers to indicate that that resolver should only
* be accessible to the "owner" of that resource.
*
* For example, the Shop API `activeCustomer` query resolver should only return the Customer object for the "owner" of that Customer, i.e.
* based on the activeUserId of the current session. As a result, the resolver code looks like this:
*
* @example
* ```TypeScript
* \@Query()
* \@Allow(Permission.Owner)
* async activeCustomer(\@Ctx() ctx: RequestContext): Promise<Customer | undefined> {
* const userId = ctx.activeUserId;
* if (userId) {
* return this.customerService.findOneByUserId(ctx, userId);
* }
* }
* ```
*
* Here we can see that the "ownership" must be enforced by custom logic inside the resolver. Since "ownership" cannot be defined generally
* nor statically encoded at build-time, any resolvers using `Permission.Owner` **must** include logic to enforce that only the owner
* of the resource has access. If not, then it is the equivalent of using `Permission.Public`.
*
*
* @docsCategory common
*/
export enum Permission {
/** Authenticated means simply that the user is logged in */
Authenticated = 'Authenticated',
/** Grants permission to create Administrator */
CreateAdministrator = 'CreateAdministrator',
/** Grants permission to create Asset */
CreateAsset = 'CreateAsset',
/** Grants permission to create Products, Facets, Assets, Collections */
CreateCatalog = 'CreateCatalog',
/** Grants permission to create Channel */
CreateChannel = 'CreateChannel',
/** Grants permission to create Collection */
CreateCollection = 'CreateCollection',
/** Grants permission to create Country */
CreateCountry = 'CreateCountry',
/** Grants permission to create Customer */
CreateCustomer = 'CreateCustomer',
/** Grants permission to create CustomerGroup */
CreateCustomerGroup = 'CreateCustomerGroup',
/** Grants permission to create Facet */
CreateFacet = 'CreateFacet',
/** Grants permission to create Order */
CreateOrder = 'CreateOrder',
/** Grants permission to create PaymentMethod */
CreatePaymentMethod = 'CreatePaymentMethod',
/** Grants permission to create Product */
CreateProduct = 'CreateProduct',
/** Grants permission to create Promotion */
CreatePromotion = 'CreatePromotion',
/** Grants permission to create Seller */
CreateSeller = 'CreateSeller',
/** Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
CreateSettings = 'CreateSettings',
/** Grants permission to create ShippingMethod */
CreateShippingMethod = 'CreateShippingMethod',
/** Grants permission to create StockLocation */
CreateStockLocation = 'CreateStockLocation',
/** Grants permission to create System */
CreateSystem = 'CreateSystem',
/** Grants permission to create Tag */
CreateTag = 'CreateTag',
/** Grants permission to create TaxCategory */
CreateTaxCategory = 'CreateTaxCategory',
/** Grants permission to create TaxRate */
CreateTaxRate = 'CreateTaxRate',
/** Grants permission to create Zone */
CreateZone = 'CreateZone',
/** Grants permission to delete Administrator */
DeleteAdministrator = 'DeleteAdministrator',
/** Grants permission to delete Asset */
DeleteAsset = 'DeleteAsset',
/** Grants permission to delete Products, Facets, Assets, Collections */
DeleteCatalog = 'DeleteCatalog',
/** Grants permission to delete Channel */
DeleteChannel = 'DeleteChannel',
/** Grants permission to delete Collection */
DeleteCollection = 'DeleteCollection',
/** Grants permission to delete Country */
DeleteCountry = 'DeleteCountry',
/** Grants permission to delete Customer */
DeleteCustomer = 'DeleteCustomer',
/** Grants permission to delete CustomerGroup */
DeleteCustomerGroup = 'DeleteCustomerGroup',
/** Grants permission to delete Facet */
DeleteFacet = 'DeleteFacet',
/** Grants permission to delete Order */
DeleteOrder = 'DeleteOrder',
/** Grants permission to delete PaymentMethod */
DeletePaymentMethod = 'DeletePaymentMethod',
/** Grants permission to delete Product */
DeleteProduct = 'DeleteProduct',
/** Grants permission to delete Promotion */
DeletePromotion = 'DeletePromotion',
/** Grants permission to delete Seller */
DeleteSeller = 'DeleteSeller',
/** Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
DeleteSettings = 'DeleteSettings',
/** Grants permission to delete ShippingMethod */
DeleteShippingMethod = 'DeleteShippingMethod',
/** Grants permission to delete StockLocation */
DeleteStockLocation = 'DeleteStockLocation',
/** Grants permission to delete System */
DeleteSystem = 'DeleteSystem',
/** Grants permission to delete Tag */
DeleteTag = 'DeleteTag',
/** Grants permission to delete TaxCategory */
DeleteTaxCategory = 'DeleteTaxCategory',
/** Grants permission to delete TaxRate */
DeleteTaxRate = 'DeleteTaxRate',
/** Grants permission to delete Zone */
DeleteZone = 'DeleteZone',
/** Owner means the user owns this entity, e.g. a Customer's own Order */
Owner = 'Owner',
/** Public means any unauthenticated user may perform the operation */
Public = 'Public',
/** Grants permission to read Administrator */
ReadAdministrator = 'ReadAdministrator',
/** Grants permission to read Asset */
ReadAsset = 'ReadAsset',
/** Grants permission to read Products, Facets, Assets, Collections */
ReadCatalog = 'ReadCatalog',
/** Grants permission to read Channel */
ReadChannel = 'ReadChannel',
/** Grants permission to read Collection */
ReadCollection = 'ReadCollection',
/** Grants permission to read Country */
ReadCountry = 'ReadCountry',
/** Grants permission to read Customer */
ReadCustomer = 'ReadCustomer',
/** Grants permission to read CustomerGroup */
ReadCustomerGroup = 'ReadCustomerGroup',
/** Grants permission to read Facet */
ReadFacet = 'ReadFacet',
/** Grants permission to read Order */
ReadOrder = 'ReadOrder',
/** Grants permission to read PaymentMethod */
ReadPaymentMethod = 'ReadPaymentMethod',
/** Grants permission to read Product */
ReadProduct = 'ReadProduct',
/** Grants permission to read Promotion */
ReadPromotion = 'ReadPromotion',
/** Grants permission to read Seller */
ReadSeller = 'ReadSeller',
/** Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
ReadSettings = 'ReadSettings',
/** Grants permission to read ShippingMethod */
ReadShippingMethod = 'ReadShippingMethod',
/** Grants permission to read StockLocation */
ReadStockLocation = 'ReadStockLocation',
/** Grants permission to read System */
ReadSystem = 'ReadSystem',
/** Grants permission to read Tag */
ReadTag = 'ReadTag',
/** Grants permission to read TaxCategory */
ReadTaxCategory = 'ReadTaxCategory',
/** Grants permission to read TaxRate */
ReadTaxRate = 'ReadTaxRate',
/** Grants permission to read Zone */
ReadZone = 'ReadZone',
/** SuperAdmin has unrestricted access to all operations */
SuperAdmin = 'SuperAdmin',
/** Grants permission to update Administrator */
UpdateAdministrator = 'UpdateAdministrator',
/** Grants permission to update Asset */
UpdateAsset = 'UpdateAsset',
/** Grants permission to update Products, Facets, Assets, Collections */
UpdateCatalog = 'UpdateCatalog',
/** Grants permission to update Channel */
UpdateChannel = 'UpdateChannel',
/** Grants permission to update Collection */
UpdateCollection = 'UpdateCollection',
/** Grants permission to update Country */
UpdateCountry = 'UpdateCountry',
/** Grants permission to update Customer */
UpdateCustomer = 'UpdateCustomer',
/** Grants permission to update CustomerGroup */
UpdateCustomerGroup = 'UpdateCustomerGroup',
/** Grants permission to update Facet */
UpdateFacet = 'UpdateFacet',
/** Grants permission to update GlobalSettings */
UpdateGlobalSettings = 'UpdateGlobalSettings',
/** Grants permission to update Order */
UpdateOrder = 'UpdateOrder',
/** Grants permission to update PaymentMethod */
UpdatePaymentMethod = 'UpdatePaymentMethod',
/** Grants permission to update Product */
UpdateProduct = 'UpdateProduct',
/** Grants permission to update Promotion */
UpdatePromotion = 'UpdatePromotion',
/** Grants permission to update Seller */
UpdateSeller = 'UpdateSeller',
/** Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
UpdateSettings = 'UpdateSettings',
/** Grants permission to update ShippingMethod */
UpdateShippingMethod = 'UpdateShippingMethod',
/** Grants permission to update StockLocation */
UpdateStockLocation = 'UpdateStockLocation',
/** Grants permission to update System */
UpdateSystem = 'UpdateSystem',
/** Grants permission to update Tag */
UpdateTag = 'UpdateTag',
/** Grants permission to update TaxCategory */
UpdateTaxCategory = 'UpdateTaxCategory',
/** Grants permission to update TaxRate */
UpdateTaxRate = 'UpdateTaxRate',
/** Grants permission to update Zone */
UpdateZone = 'UpdateZone'
}
export type PermissionDefinition = {
assignable: Scalars['Boolean']['output'];
description: Scalars['String']['output'];
name: Scalars['String']['output'];
};
export type PreviewCollectionVariantsInput = {
filters: Array<ConfigurableOperationInput>;
inheritFilters: Scalars['Boolean']['input'];
parentId?: InputMaybe<Scalars['ID']['input']>;
};
/** The price range where the result has more than one price */
export type PriceRange = {
max: Scalars['Money']['output'];
min: Scalars['Money']['output'];
};
export type Product = Node & {
assets: Array<Asset>;
channels: Array<Channel>;
collections: Array<Collection>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
enabled: Scalars['Boolean']['output'];
facetValues: Array<FacetValue>;
featuredAsset?: Maybe<Asset>;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
optionGroups: Array<ProductOptionGroup>;
slug: Scalars['String']['output'];
translations: Array<ProductTranslation>;
updatedAt: Scalars['DateTime']['output'];
/** Returns a paginated, sortable, filterable list of ProductVariants */
variantList: ProductVariantList;
/** Returns all ProductVariants */
variants: Array<ProductVariant>;
};
export type ProductVariantListArgs = {
options?: InputMaybe<ProductVariantListOptions>;
};
export type ProductFilterParameter = {
_and?: InputMaybe<Array<ProductFilterParameter>>;
_or?: InputMaybe<Array<ProductFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
enabled?: InputMaybe<BooleanOperators>;
facetValueId?: InputMaybe<IdOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
sku?: InputMaybe<StringOperators>;
slug?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ProductList = PaginatedList & {
items: Array<Product>;
totalItems: Scalars['Int']['output'];
};
export type ProductListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ProductFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ProductSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ProductOption = Node & {
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
group: ProductOptionGroup;
groupId: Scalars['ID']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<ProductOptionTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type ProductOptionGroup = Node & {
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
options: Array<ProductOption>;
translations: Array<ProductOptionGroupTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type ProductOptionGroupTranslation = {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProductOptionGroupTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type ProductOptionInUseError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
optionGroupCode: Scalars['String']['output'];
productVariantCount: Scalars['Int']['output'];
};
export type ProductOptionTranslation = {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProductOptionTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type ProductSortParameter = {
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
slug?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ProductTranslation = {
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
slug: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProductTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
slug?: InputMaybe<Scalars['String']['input']>;
};
export type ProductVariant = Node & {
assets: Array<Asset>;
channels: Array<Channel>;
createdAt: Scalars['DateTime']['output'];
currencyCode: CurrencyCode;
customFields?: Maybe<Scalars['JSON']['output']>;
enabled: Scalars['Boolean']['output'];
facetValues: Array<FacetValue>;
featuredAsset?: Maybe<Asset>;
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
options: Array<ProductOption>;
outOfStockThreshold: Scalars['Int']['output'];
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
prices: Array<ProductVariantPrice>;
product: Product;
productId: Scalars['ID']['output'];
sku: Scalars['String']['output'];
/** @deprecated use stockLevels */
stockAllocated: Scalars['Int']['output'];
stockLevel: Scalars['String']['output'];
stockLevels: Array<StockLevel>;
stockMovements: StockMovementList;
/** @deprecated use stockLevels */
stockOnHand: Scalars['Int']['output'];
taxCategory: TaxCategory;
taxRateApplied: TaxRate;
trackInventory: GlobalFlag;
translations: Array<ProductVariantTranslation>;
updatedAt: Scalars['DateTime']['output'];
useGlobalOutOfStockThreshold: Scalars['Boolean']['output'];
};
export type ProductVariantStockMovementsArgs = {
options?: InputMaybe<StockMovementListOptions>;
};
export type ProductVariantFilterParameter = {
_and?: InputMaybe<Array<ProductVariantFilterParameter>>;
_or?: InputMaybe<Array<ProductVariantFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
currencyCode?: InputMaybe<StringOperators>;
enabled?: InputMaybe<BooleanOperators>;
facetValueId?: InputMaybe<IdOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
outOfStockThreshold?: InputMaybe<NumberOperators>;
price?: InputMaybe<NumberOperators>;
priceWithTax?: InputMaybe<NumberOperators>;
productId?: InputMaybe<IdOperators>;
sku?: InputMaybe<StringOperators>;
stockAllocated?: InputMaybe<NumberOperators>;
stockLevel?: InputMaybe<StringOperators>;
stockOnHand?: InputMaybe<NumberOperators>;
trackInventory?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
useGlobalOutOfStockThreshold?: InputMaybe<BooleanOperators>;
};
export type ProductVariantList = PaginatedList & {
items: Array<ProductVariant>;
totalItems: Scalars['Int']['output'];
};
export type ProductVariantListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ProductVariantFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ProductVariantSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ProductVariantPrice = {
currencyCode: CurrencyCode;
customFields?: Maybe<Scalars['JSON']['output']>;
price: Scalars['Money']['output'];
};
/**
* Used to set up update the price of a ProductVariant in a particular Channel.
* If the `delete` flag is `true`, the price will be deleted for the given Channel.
*/
export type ProductVariantPriceInput = {
currencyCode: CurrencyCode;
delete?: InputMaybe<Scalars['Boolean']['input']>;
price: Scalars['Money']['input'];
};
export type ProductVariantSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
outOfStockThreshold?: InputMaybe<SortOrder>;
price?: InputMaybe<SortOrder>;
priceWithTax?: InputMaybe<SortOrder>;
productId?: InputMaybe<SortOrder>;
sku?: InputMaybe<SortOrder>;
stockAllocated?: InputMaybe<SortOrder>;
stockLevel?: InputMaybe<SortOrder>;
stockOnHand?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ProductVariantTranslation = {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProductVariantTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type Promotion = Node & {
actions: Array<ConfigurableOperation>;
conditions: Array<ConfigurableOperation>;
couponCode?: Maybe<Scalars['String']['output']>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
enabled: Scalars['Boolean']['output'];
endsAt?: Maybe<Scalars['DateTime']['output']>;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
perCustomerUsageLimit?: Maybe<Scalars['Int']['output']>;
startsAt?: Maybe<Scalars['DateTime']['output']>;
translations: Array<PromotionTranslation>;
updatedAt: Scalars['DateTime']['output'];
usageLimit?: Maybe<Scalars['Int']['output']>;
};
export type PromotionFilterParameter = {
_and?: InputMaybe<Array<PromotionFilterParameter>>;
_or?: InputMaybe<Array<PromotionFilterParameter>>;
couponCode?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
enabled?: InputMaybe<BooleanOperators>;
endsAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
perCustomerUsageLimit?: InputMaybe<NumberOperators>;
startsAt?: InputMaybe<DateOperators>;
updatedAt?: InputMaybe<DateOperators>;
usageLimit?: InputMaybe<NumberOperators>;
};
export type PromotionList = PaginatedList & {
items: Array<Promotion>;
totalItems: Scalars['Int']['output'];
};
export type PromotionListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<PromotionFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<PromotionSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type PromotionSortParameter = {
couponCode?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
endsAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
perCustomerUsageLimit?: InputMaybe<SortOrder>;
startsAt?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
usageLimit?: InputMaybe<SortOrder>;
};
export type PromotionTranslation = {
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type PromotionTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
export type Province = Node & Region & {
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
parent?: Maybe<Region>;
parentId?: Maybe<Scalars['ID']['output']>;
translations: Array<RegionTranslation>;
type: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ProvinceFilterParameter = {
_and?: InputMaybe<Array<ProvinceFilterParameter>>;
_or?: InputMaybe<Array<ProvinceFilterParameter>>;
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
enabled?: InputMaybe<BooleanOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
parentId?: InputMaybe<IdOperators>;
type?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ProvinceList = PaginatedList & {
items: Array<Province>;
totalItems: Scalars['Int']['output'];
};
export type ProvinceListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ProvinceFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ProvinceSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ProvinceSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
parentId?: InputMaybe<SortOrder>;
type?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ProvinceTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
/** Returned if the specified quantity of an OrderLine is greater than the number of items in that line */
export type QuantityTooGreatError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
export type Query = {
activeAdministrator?: Maybe<Administrator>;
activeChannel: Channel;
administrator?: Maybe<Administrator>;
administrators: AdministratorList;
/** Get a single Asset by id */
asset?: Maybe<Asset>;
/** Get a list of Assets */
assets: AssetList;
channel?: Maybe<Channel>;
channels: ChannelList;
/** Get a Collection either by id or slug. If neither id nor slug is specified, an error will result. */
collection?: Maybe<Collection>;
collectionFilters: Array<ConfigurableOperationDefinition>;
collections: CollectionList;
countries: CountryList;
country?: Maybe<Country>;
customer?: Maybe<Customer>;
customerGroup?: Maybe<CustomerGroup>;
customerGroups: CustomerGroupList;
customers: CustomerList;
/** Returns a list of eligible shipping methods for the draft Order */
eligibleShippingMethodsForDraftOrder: Array<ShippingMethodQuote>;
entityDuplicators: Array<EntityDuplicatorDefinition>;
facet?: Maybe<Facet>;
facetValues: FacetValueList;
facets: FacetList;
fulfillmentHandlers: Array<ConfigurableOperationDefinition>;
globalSettings: GlobalSettings;
job?: Maybe<Job>;
jobBufferSize: Array<JobBufferSize>;
jobQueues: Array<JobQueue>;
jobs: JobList;
jobsById: Array<Job>;
me?: Maybe<CurrentUser>;
/** Get metrics for the given interval and metric types. */
metricSummary: Array<MetricSummary>;
order?: Maybe<Order>;
orders: OrderList;
paymentMethod?: Maybe<PaymentMethod>;
paymentMethodEligibilityCheckers: Array<ConfigurableOperationDefinition>;
paymentMethodHandlers: Array<ConfigurableOperationDefinition>;
paymentMethods: PaymentMethodList;
pendingSearchIndexUpdates: Scalars['Int']['output'];
/** Used for real-time previews of the contents of a Collection */
previewCollectionVariants: ProductVariantList;
/** Get a Product either by id or slug. If neither id nor slug is specified, an error will result. */
product?: Maybe<Product>;
productOptionGroup?: Maybe<ProductOptionGroup>;
productOptionGroups: Array<ProductOptionGroup>;
/** Get a ProductVariant by id */
productVariant?: Maybe<ProductVariant>;
/** List ProductVariants either all or for the specific product. */
productVariants: ProductVariantList;
/** List Products */
products: ProductList;
promotion?: Maybe<Promotion>;
promotionActions: Array<ConfigurableOperationDefinition>;
promotionConditions: Array<ConfigurableOperationDefinition>;
promotions: PromotionList;
province?: Maybe<Province>;
provinces: ProvinceList;
role?: Maybe<Role>;
roles: RoleList;
search: SearchResponse;
seller?: Maybe<Seller>;
sellers: SellerList;
shippingCalculators: Array<ConfigurableOperationDefinition>;
shippingEligibilityCheckers: Array<ConfigurableOperationDefinition>;
shippingMethod?: Maybe<ShippingMethod>;
shippingMethods: ShippingMethodList;
stockLocation?: Maybe<StockLocation>;
stockLocations: StockLocationList;
tag: Tag;
tags: TagList;
taxCategories: TaxCategoryList;
taxCategory?: Maybe<TaxCategory>;
taxRate?: Maybe<TaxRate>;
taxRates: TaxRateList;
testEligibleShippingMethods: Array<ShippingMethodQuote>;
testShippingMethod: TestShippingMethodResult;
zone?: Maybe<Zone>;
zones: ZoneList;
};
export type QueryAdministratorArgs = {
id: Scalars['ID']['input'];
};
export type QueryAdministratorsArgs = {
options?: InputMaybe<AdministratorListOptions>;
};
export type QueryAssetArgs = {
id: Scalars['ID']['input'];
};
export type QueryAssetsArgs = {
options?: InputMaybe<AssetListOptions>;
};
export type QueryChannelArgs = {
id: Scalars['ID']['input'];
};
export type QueryChannelsArgs = {
options?: InputMaybe<ChannelListOptions>;
};
export type QueryCollectionArgs = {
id?: InputMaybe<Scalars['ID']['input']>;
slug?: InputMaybe<Scalars['String']['input']>;
};
export type QueryCollectionsArgs = {
options?: InputMaybe<CollectionListOptions>;
};
export type QueryCountriesArgs = {
options?: InputMaybe<CountryListOptions>;
};
export type QueryCountryArgs = {
id: Scalars['ID']['input'];
};
export type QueryCustomerArgs = {
id: Scalars['ID']['input'];
};
export type QueryCustomerGroupArgs = {
id: Scalars['ID']['input'];
};
export type QueryCustomerGroupsArgs = {
options?: InputMaybe<CustomerGroupListOptions>;
};
export type QueryCustomersArgs = {
options?: InputMaybe<CustomerListOptions>;
};
export type QueryEligibleShippingMethodsForDraftOrderArgs = {
orderId: Scalars['ID']['input'];
};
export type QueryFacetArgs = {
id: Scalars['ID']['input'];
};
export type QueryFacetValuesArgs = {
options?: InputMaybe<FacetValueListOptions>;
};
export type QueryFacetsArgs = {
options?: InputMaybe<FacetListOptions>;
};
export type QueryJobArgs = {
jobId: Scalars['ID']['input'];
};
export type QueryJobBufferSizeArgs = {
bufferIds?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type QueryJobsArgs = {
options?: InputMaybe<JobListOptions>;
};
export type QueryJobsByIdArgs = {
jobIds: Array<Scalars['ID']['input']>;
};
export type QueryMetricSummaryArgs = {
input?: InputMaybe<MetricSummaryInput>;
};
export type QueryOrderArgs = {
id: Scalars['ID']['input'];
};
export type QueryOrdersArgs = {
options?: InputMaybe<OrderListOptions>;
};
export type QueryPaymentMethodArgs = {
id: Scalars['ID']['input'];
};
export type QueryPaymentMethodsArgs = {
options?: InputMaybe<PaymentMethodListOptions>;
};
export type QueryPreviewCollectionVariantsArgs = {
input: PreviewCollectionVariantsInput;
options?: InputMaybe<ProductVariantListOptions>;
};
export type QueryProductArgs = {
id?: InputMaybe<Scalars['ID']['input']>;
slug?: InputMaybe<Scalars['String']['input']>;
};
export type QueryProductOptionGroupArgs = {
id: Scalars['ID']['input'];
};
export type QueryProductOptionGroupsArgs = {
filterTerm?: InputMaybe<Scalars['String']['input']>;
};
export type QueryProductVariantArgs = {
id: Scalars['ID']['input'];
};
export type QueryProductVariantsArgs = {
options?: InputMaybe<ProductVariantListOptions>;
productId?: InputMaybe<Scalars['ID']['input']>;
};
export type QueryProductsArgs = {
options?: InputMaybe<ProductListOptions>;
};
export type QueryPromotionArgs = {
id: Scalars['ID']['input'];
};
export type QueryPromotionsArgs = {
options?: InputMaybe<PromotionListOptions>;
};
export type QueryProvinceArgs = {
id: Scalars['ID']['input'];
};
export type QueryProvincesArgs = {
options?: InputMaybe<ProvinceListOptions>;
};
export type QueryRoleArgs = {
id: Scalars['ID']['input'];
};
export type QueryRolesArgs = {
options?: InputMaybe<RoleListOptions>;
};
export type QuerySearchArgs = {
input: SearchInput;
};
export type QuerySellerArgs = {
id: Scalars['ID']['input'];
};
export type QuerySellersArgs = {
options?: InputMaybe<SellerListOptions>;
};
export type QueryShippingMethodArgs = {
id: Scalars['ID']['input'];
};
export type QueryShippingMethodsArgs = {
options?: InputMaybe<ShippingMethodListOptions>;
};
export type QueryStockLocationArgs = {
id: Scalars['ID']['input'];
};
export type QueryStockLocationsArgs = {
options?: InputMaybe<StockLocationListOptions>;
};
export type QueryTagArgs = {
id: Scalars['ID']['input'];
};
export type QueryTagsArgs = {
options?: InputMaybe<TagListOptions>;
};
export type QueryTaxCategoriesArgs = {
options?: InputMaybe<TaxCategoryListOptions>;
};
export type QueryTaxCategoryArgs = {
id: Scalars['ID']['input'];
};
export type QueryTaxRateArgs = {
id: Scalars['ID']['input'];
};
export type QueryTaxRatesArgs = {
options?: InputMaybe<TaxRateListOptions>;
};
export type QueryTestEligibleShippingMethodsArgs = {
input: TestEligibleShippingMethodsInput;
};
export type QueryTestShippingMethodArgs = {
input: TestShippingMethodInput;
};
export type QueryZoneArgs = {
id: Scalars['ID']['input'];
};
export type QueryZonesArgs = {
options?: InputMaybe<ZoneListOptions>;
};
export type Refund = Node & {
adjustment: Scalars['Money']['output'];
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
items: Scalars['Money']['output'];
lines: Array<RefundLine>;
metadata?: Maybe<Scalars['JSON']['output']>;
method?: Maybe<Scalars['String']['output']>;
paymentId: Scalars['ID']['output'];
reason?: Maybe<Scalars['String']['output']>;
shipping: Scalars['Money']['output'];
state: Scalars['String']['output'];
total: Scalars['Money']['output'];
transactionId?: Maybe<Scalars['String']['output']>;
updatedAt: Scalars['DateTime']['output'];
};
/** Returned if `amount` is greater than the maximum un-refunded amount of the Payment */
export type RefundAmountError = ErrorResult & {
errorCode: ErrorCode;
maximumRefundable: Scalars['Int']['output'];
message: Scalars['String']['output'];
};
export type RefundLine = {
orderLine: OrderLine;
orderLineId: Scalars['ID']['output'];
quantity: Scalars['Int']['output'];
refund: Refund;
refundId: Scalars['ID']['output'];
};
export type RefundOrderInput = {
adjustment: Scalars['Money']['input'];
/**
* If an amount is specified, this value will be used to create a Refund rather than calculating the
* amount automatically. This was added in v2.2 and will be the preferred way to specify the refund
* amount in the future. The `lines`, `shipping` and `adjustment` fields will likely be removed in a future
* version.
*/
amount?: InputMaybe<Scalars['Money']['input']>;
lines: Array<OrderLineInput>;
paymentId: Scalars['ID']['input'];
reason?: InputMaybe<Scalars['String']['input']>;
shipping: Scalars['Money']['input'];
};
export type RefundOrderResult = AlreadyRefundedError | MultipleOrderError | NothingToRefundError | OrderStateTransitionError | PaymentOrderMismatchError | QuantityTooGreatError | Refund | RefundAmountError | RefundOrderStateError | RefundStateTransitionError;
/** Returned if an attempting to refund an Order which is not in the expected state */
export type RefundOrderStateError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
orderState: Scalars['String']['output'];
};
/**
* Returned when a call to modifyOrder fails to include a refundPaymentId even
* though the price has decreased as a result of the changes.
*/
export type RefundPaymentIdMissingError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
};
/** Returned when there is an error in transitioning the Refund state */
export type RefundStateTransitionError = ErrorResult & {
errorCode: ErrorCode;
fromState: Scalars['String']['output'];
message: Scalars['String']['output'];
toState: Scalars['String']['output'];
transitionError: Scalars['String']['output'];
};
export type Region = {
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
parent?: Maybe<Region>;
parentId?: Maybe<Scalars['ID']['output']>;
translations: Array<RegionTranslation>;
type: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type RegionTranslation = {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type RelationCustomFieldConfig = CustomField & {
description?: Maybe<Array<LocalizedString>>;
entity: Scalars['String']['output'];
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
requiresPermission?: Maybe<Array<Permission>>;
scalarFields: Array<Scalars['String']['output']>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type Release = Node & StockMovement & {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type RemoveCollectionsFromChannelInput = {
channelId: Scalars['ID']['input'];
collectionIds: Array<Scalars['ID']['input']>;
};
export type RemoveFacetFromChannelResult = Facet | FacetInUseError;
export type RemoveFacetsFromChannelInput = {
channelId: Scalars['ID']['input'];
facetIds: Array<Scalars['ID']['input']>;
force?: InputMaybe<Scalars['Boolean']['input']>;
};
export type RemoveOptionGroupFromProductResult = Product | ProductOptionInUseError;
export type RemoveOrderItemsResult = Order | OrderModificationError;
export type RemovePaymentMethodsFromChannelInput = {
channelId: Scalars['ID']['input'];
paymentMethodIds: Array<Scalars['ID']['input']>;
};
export type RemoveProductVariantsFromChannelInput = {
channelId: Scalars['ID']['input'];
productVariantIds: Array<Scalars['ID']['input']>;
};
export type RemoveProductsFromChannelInput = {
channelId: Scalars['ID']['input'];
productIds: Array<Scalars['ID']['input']>;
};
export type RemovePromotionsFromChannelInput = {
channelId: Scalars['ID']['input'];
promotionIds: Array<Scalars['ID']['input']>;
};
export type RemoveShippingMethodsFromChannelInput = {
channelId: Scalars['ID']['input'];
shippingMethodIds: Array<Scalars['ID']['input']>;
};
export type RemoveStockLocationsFromChannelInput = {
channelId: Scalars['ID']['input'];
stockLocationIds: Array<Scalars['ID']['input']>;
};
export type Return = Node & StockMovement & {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type Role = Node & {
channels: Array<Channel>;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
permissions: Array<Permission>;
updatedAt: Scalars['DateTime']['output'];
};
export type RoleFilterParameter = {
_and?: InputMaybe<Array<RoleFilterParameter>>;
_or?: InputMaybe<Array<RoleFilterParameter>>;
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type RoleList = PaginatedList & {
items: Array<Role>;
totalItems: Scalars['Int']['output'];
};
export type RoleListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<RoleFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<RoleSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type RoleSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type Sale = Node & StockMovement & {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type SearchInput = {
collectionId?: InputMaybe<Scalars['ID']['input']>;
collectionSlug?: InputMaybe<Scalars['String']['input']>;
facetValueFilters?: InputMaybe<Array<FacetValueFilterInput>>;
/** @deprecated Use `facetValueFilters` instead */
facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
/** @deprecated Use `facetValueFilters` instead */
facetValueOperator?: InputMaybe<LogicalOperator>;
groupByProduct?: InputMaybe<Scalars['Boolean']['input']>;
skip?: InputMaybe<Scalars['Int']['input']>;
sort?: InputMaybe<SearchResultSortParameter>;
take?: InputMaybe<Scalars['Int']['input']>;
term?: InputMaybe<Scalars['String']['input']>;
};
export type SearchReindexResponse = {
success: Scalars['Boolean']['output'];
};
export type SearchResponse = {
collections: Array<CollectionResult>;
facetValues: Array<FacetValueResult>;
items: Array<SearchResult>;
totalItems: Scalars['Int']['output'];
};
export type SearchResult = {
/** An array of ids of the Channels in which this result appears */
channelIds: Array<Scalars['ID']['output']>;
/** An array of ids of the Collections in which this result appears */
collectionIds: Array<Scalars['ID']['output']>;
currencyCode: CurrencyCode;
description: Scalars['String']['output'];
enabled: Scalars['Boolean']['output'];
facetIds: Array<Scalars['ID']['output']>;
facetValueIds: Array<Scalars['ID']['output']>;
price: SearchResultPrice;
priceWithTax: SearchResultPrice;
productAsset?: Maybe<SearchResultAsset>;
productId: Scalars['ID']['output'];
productName: Scalars['String']['output'];
productVariantAsset?: Maybe<SearchResultAsset>;
productVariantId: Scalars['ID']['output'];
productVariantName: Scalars['String']['output'];
/** A relevance score for the result. Differs between database implementations */
score: Scalars['Float']['output'];
sku: Scalars['String']['output'];
slug: Scalars['String']['output'];
};
export type SearchResultAsset = {
focalPoint?: Maybe<Coordinate>;
id: Scalars['ID']['output'];
preview: Scalars['String']['output'];
};
/** The price of a search result product, either as a range or as a single price */
export type SearchResultPrice = PriceRange | SinglePrice;
export type SearchResultSortParameter = {
name?: InputMaybe<SortOrder>;
price?: InputMaybe<SortOrder>;
};
export type Seller = Node & {
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type SellerFilterParameter = {
_and?: InputMaybe<Array<SellerFilterParameter>>;
_or?: InputMaybe<Array<SellerFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type SellerList = PaginatedList & {
items: Array<Seller>;
totalItems: Scalars['Int']['output'];
};
export type SellerListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<SellerFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<SellerSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type SellerSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ServerConfig = {
/**
* This field is deprecated in v2.2 in favor of the entityCustomFields field,
* which allows custom fields to be defined on user-supplies entities.
*/
customFieldConfig: CustomFields;
entityCustomFields: Array<EntityCustomFields>;
moneyStrategyPrecision: Scalars['Int']['output'];
orderProcess: Array<OrderProcessState>;
permissions: Array<PermissionDefinition>;
permittedAssetTypes: Array<Scalars['String']['output']>;
};
export type SetCustomerForDraftOrderResult = EmailAddressConflictError | Order;
export type SetOrderCustomerInput = {
customerId: Scalars['ID']['input'];
note?: InputMaybe<Scalars['String']['input']>;
orderId: Scalars['ID']['input'];
};
export type SetOrderShippingMethodResult = IneligibleShippingMethodError | NoActiveOrderError | Order | OrderModificationError;
/** Returned if the Payment settlement fails */
export type SettlePaymentError = ErrorResult & {
errorCode: ErrorCode;
message: Scalars['String']['output'];
paymentErrorMessage: Scalars['String']['output'];
};
export type SettlePaymentResult = OrderStateTransitionError | Payment | PaymentStateTransitionError | SettlePaymentError;
export type SettleRefundInput = {
id: Scalars['ID']['input'];
transactionId: Scalars['String']['input'];
};
export type SettleRefundResult = Refund | RefundStateTransitionError;
export type ShippingLine = {
discountedPrice: Scalars['Money']['output'];
discountedPriceWithTax: Scalars['Money']['output'];
discounts: Array<Discount>;
id: Scalars['ID']['output'];
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
shippingMethod: ShippingMethod;
};
export type ShippingMethod = Node & {
calculator: ConfigurableOperation;
checker: ConfigurableOperation;
code: Scalars['String']['output'];
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
fulfillmentHandlerCode: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
translations: Array<ShippingMethodTranslation>;
updatedAt: Scalars['DateTime']['output'];
};
export type ShippingMethodFilterParameter = {
_and?: InputMaybe<Array<ShippingMethodFilterParameter>>;
_or?: InputMaybe<Array<ShippingMethodFilterParameter>>;
code?: InputMaybe<StringOperators>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
fulfillmentHandlerCode?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
languageCode?: InputMaybe<StringOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ShippingMethodList = PaginatedList & {
items: Array<ShippingMethod>;
totalItems: Scalars['Int']['output'];
};
export type ShippingMethodListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ShippingMethodFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ShippingMethodSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ShippingMethodQuote = {
code: Scalars['String']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
/** Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult */
metadata?: Maybe<Scalars['JSON']['output']>;
name: Scalars['String']['output'];
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
};
export type ShippingMethodSortParameter = {
code?: InputMaybe<SortOrder>;
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
fulfillmentHandlerCode?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ShippingMethodTranslation = {
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
languageCode: LanguageCode;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ShippingMethodTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
};
/** The price value where the result has a single price */
export type SinglePrice = {
value: Scalars['Money']['output'];
};
export enum SortOrder {
ASC = 'ASC',
DESC = 'DESC'
}
export type StockAdjustment = Node & StockMovement & {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type StockLevel = Node & {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
stockAllocated: Scalars['Int']['output'];
stockLocation: StockLocation;
stockLocationId: Scalars['ID']['output'];
stockOnHand: Scalars['Int']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type StockLevelInput = {
stockLocationId: Scalars['ID']['input'];
stockOnHand: Scalars['Int']['input'];
};
export type StockLocation = Node & {
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type StockLocationFilterParameter = {
_and?: InputMaybe<Array<StockLocationFilterParameter>>;
_or?: InputMaybe<Array<StockLocationFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
description?: InputMaybe<StringOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type StockLocationList = PaginatedList & {
items: Array<StockLocation>;
totalItems: Scalars['Int']['output'];
};
export type StockLocationListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<StockLocationFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<StockLocationSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type StockLocationSortParameter = {
createdAt?: InputMaybe<SortOrder>;
description?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type StockMovement = {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
productVariant: ProductVariant;
quantity: Scalars['Int']['output'];
type: StockMovementType;
updatedAt: Scalars['DateTime']['output'];
};
export type StockMovementItem = Allocation | Cancellation | Release | Return | Sale | StockAdjustment;
export type StockMovementList = {
items: Array<StockMovementItem>;
totalItems: Scalars['Int']['output'];
};
export type StockMovementListOptions = {
skip?: InputMaybe<Scalars['Int']['input']>;
take?: InputMaybe<Scalars['Int']['input']>;
type?: InputMaybe<StockMovementType>;
};
export enum StockMovementType {
ADJUSTMENT = 'ADJUSTMENT',
ALLOCATION = 'ALLOCATION',
CANCELLATION = 'CANCELLATION',
RELEASE = 'RELEASE',
RETURN = 'RETURN',
SALE = 'SALE'
}
export type StringCustomFieldConfig = CustomField & {
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
length?: Maybe<Scalars['Int']['output']>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
options?: Maybe<Array<StringFieldOption>>;
pattern?: Maybe<Scalars['String']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
requiresPermission?: Maybe<Array<Permission>>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type StringFieldOption = {
label?: Maybe<Array<LocalizedString>>;
value: Scalars['String']['output'];
};
/** Operators for filtering on a list of String fields */
export type StringListOperators = {
inList: Scalars['String']['input'];
};
/** Operators for filtering on a String field */
export type StringOperators = {
contains?: InputMaybe<Scalars['String']['input']>;
eq?: InputMaybe<Scalars['String']['input']>;
in?: InputMaybe<Array<Scalars['String']['input']>>;
isNull?: InputMaybe<Scalars['Boolean']['input']>;
notContains?: InputMaybe<Scalars['String']['input']>;
notEq?: InputMaybe<Scalars['String']['input']>;
notIn?: InputMaybe<Array<Scalars['String']['input']>>;
regex?: InputMaybe<Scalars['String']['input']>;
};
/** Indicates that an operation succeeded, where we do not want to return any more specific information. */
export type Success = {
success: Scalars['Boolean']['output'];
};
export type Surcharge = Node & {
createdAt: Scalars['DateTime']['output'];
description: Scalars['String']['output'];
id: Scalars['ID']['output'];
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
sku?: Maybe<Scalars['String']['output']>;
taxLines: Array<TaxLine>;
taxRate: Scalars['Float']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type SurchargeInput = {
description: Scalars['String']['input'];
price: Scalars['Money']['input'];
priceIncludesTax: Scalars['Boolean']['input'];
sku?: InputMaybe<Scalars['String']['input']>;
taxDescription?: InputMaybe<Scalars['String']['input']>;
taxRate?: InputMaybe<Scalars['Float']['input']>;
};
export type Tag = Node & {
createdAt: Scalars['DateTime']['output'];
id: Scalars['ID']['output'];
updatedAt: Scalars['DateTime']['output'];
value: Scalars['String']['output'];
};
export type TagFilterParameter = {
_and?: InputMaybe<Array<TagFilterParameter>>;
_or?: InputMaybe<Array<TagFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
updatedAt?: InputMaybe<DateOperators>;
value?: InputMaybe<StringOperators>;
};
export type TagList = PaginatedList & {
items: Array<Tag>;
totalItems: Scalars['Int']['output'];
};
export type TagListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<TagFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<TagSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type TagSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
value?: InputMaybe<SortOrder>;
};
export type TaxCategory = Node & {
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
isDefault: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type TaxCategoryFilterParameter = {
_and?: InputMaybe<Array<TaxCategoryFilterParameter>>;
_or?: InputMaybe<Array<TaxCategoryFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
isDefault?: InputMaybe<BooleanOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type TaxCategoryList = PaginatedList & {
items: Array<TaxCategory>;
totalItems: Scalars['Int']['output'];
};
export type TaxCategoryListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<TaxCategoryFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<TaxCategorySortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type TaxCategorySortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type TaxLine = {
description: Scalars['String']['output'];
taxRate: Scalars['Float']['output'];
};
export type TaxRate = Node & {
category: TaxCategory;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
customerGroup?: Maybe<CustomerGroup>;
enabled: Scalars['Boolean']['output'];
id: Scalars['ID']['output'];
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
value: Scalars['Float']['output'];
zone: Zone;
};
export type TaxRateFilterParameter = {
_and?: InputMaybe<Array<TaxRateFilterParameter>>;
_or?: InputMaybe<Array<TaxRateFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
enabled?: InputMaybe<BooleanOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
value?: InputMaybe<NumberOperators>;
};
export type TaxRateList = PaginatedList & {
items: Array<TaxRate>;
totalItems: Scalars['Int']['output'];
};
export type TaxRateListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<TaxRateFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<TaxRateSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type TaxRateSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
value?: InputMaybe<SortOrder>;
};
export type TestEligibleShippingMethodsInput = {
lines: Array<TestShippingMethodOrderLineInput>;
shippingAddress: CreateAddressInput;
};
export type TestShippingMethodInput = {
calculator: ConfigurableOperationInput;
checker: ConfigurableOperationInput;
lines: Array<TestShippingMethodOrderLineInput>;
shippingAddress: CreateAddressInput;
};
export type TestShippingMethodOrderLineInput = {
productVariantId: Scalars['ID']['input'];
quantity: Scalars['Int']['input'];
};
export type TestShippingMethodQuote = {
metadata?: Maybe<Scalars['JSON']['output']>;
price: Scalars['Money']['output'];
priceWithTax: Scalars['Money']['output'];
};
export type TestShippingMethodResult = {
eligible: Scalars['Boolean']['output'];
quote?: Maybe<TestShippingMethodQuote>;
};
export type TextCustomFieldConfig = CustomField & {
description?: Maybe<Array<LocalizedString>>;
internal?: Maybe<Scalars['Boolean']['output']>;
label?: Maybe<Array<LocalizedString>>;
list: Scalars['Boolean']['output'];
name: Scalars['String']['output'];
nullable?: Maybe<Scalars['Boolean']['output']>;
readonly?: Maybe<Scalars['Boolean']['output']>;
requiresPermission?: Maybe<Array<Permission>>;
type: Scalars['String']['output'];
ui?: Maybe<Scalars['JSON']['output']>;
};
export type TransitionFulfillmentToStateResult = Fulfillment | FulfillmentStateTransitionError;
export type TransitionOrderToStateResult = Order | OrderStateTransitionError;
export type TransitionPaymentToStateResult = Payment | PaymentStateTransitionError;
export type UpdateActiveAdministratorInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress?: InputMaybe<Scalars['String']['input']>;
firstName?: InputMaybe<Scalars['String']['input']>;
lastName?: InputMaybe<Scalars['String']['input']>;
password?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateAddressInput = {
city?: InputMaybe<Scalars['String']['input']>;
company?: InputMaybe<Scalars['String']['input']>;
countryCode?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
defaultBillingAddress?: InputMaybe<Scalars['Boolean']['input']>;
defaultShippingAddress?: InputMaybe<Scalars['Boolean']['input']>;
fullName?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
phoneNumber?: InputMaybe<Scalars['String']['input']>;
postalCode?: InputMaybe<Scalars['String']['input']>;
province?: InputMaybe<Scalars['String']['input']>;
streetLine1?: InputMaybe<Scalars['String']['input']>;
streetLine2?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateAdministratorInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress?: InputMaybe<Scalars['String']['input']>;
firstName?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
lastName?: InputMaybe<Scalars['String']['input']>;
password?: InputMaybe<Scalars['String']['input']>;
roleIds?: InputMaybe<Array<Scalars['ID']['input']>>;
};
export type UpdateAssetInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
focalPoint?: InputMaybe<CoordinateInput>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
tags?: InputMaybe<Array<Scalars['String']['input']>>;
};
export type UpdateChannelInput = {
availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
code?: InputMaybe<Scalars['String']['input']>;
/** @deprecated Use defaultCurrencyCode instead */
currencyCode?: InputMaybe<CurrencyCode>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
defaultCurrencyCode?: InputMaybe<CurrencyCode>;
defaultLanguageCode?: InputMaybe<LanguageCode>;
defaultShippingZoneId?: InputMaybe<Scalars['ID']['input']>;
defaultTaxZoneId?: InputMaybe<Scalars['ID']['input']>;
id: Scalars['ID']['input'];
outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
pricesIncludeTax?: InputMaybe<Scalars['Boolean']['input']>;
sellerId?: InputMaybe<Scalars['ID']['input']>;
token?: InputMaybe<Scalars['String']['input']>;
trackInventory?: InputMaybe<Scalars['Boolean']['input']>;
};
export type UpdateChannelResult = Channel | LanguageNotAvailableError;
export type UpdateCollectionInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
filters?: InputMaybe<Array<ConfigurableOperationInput>>;
id: Scalars['ID']['input'];
inheritFilters?: InputMaybe<Scalars['Boolean']['input']>;
isPrivate?: InputMaybe<Scalars['Boolean']['input']>;
parentId?: InputMaybe<Scalars['ID']['input']>;
translations?: InputMaybe<Array<UpdateCollectionTranslationInput>>;
};
export type UpdateCollectionTranslationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id?: InputMaybe<Scalars['ID']['input']>;
languageCode: LanguageCode;
name?: InputMaybe<Scalars['String']['input']>;
slug?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateCountryInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<CountryTranslationInput>>;
};
export type UpdateCustomerGroupInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateCustomerInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
emailAddress?: InputMaybe<Scalars['String']['input']>;
firstName?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
lastName?: InputMaybe<Scalars['String']['input']>;
phoneNumber?: InputMaybe<Scalars['String']['input']>;
title?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateCustomerNoteInput = {
note: Scalars['String']['input'];
noteId: Scalars['ID']['input'];
};
export type UpdateCustomerResult = Customer | EmailAddressConflictError;
export type UpdateFacetInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
isPrivate?: InputMaybe<Scalars['Boolean']['input']>;
translations?: InputMaybe<Array<FacetTranslationInput>>;
};
export type UpdateFacetValueInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<FacetValueTranslationInput>>;
};
export type UpdateGlobalSettingsInput = {
availableLanguages?: InputMaybe<Array<LanguageCode>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
trackInventory?: InputMaybe<Scalars['Boolean']['input']>;
};
export type UpdateGlobalSettingsResult = ChannelDefaultLanguageError | GlobalSettings;
export type UpdateOrderAddressInput = {
city?: InputMaybe<Scalars['String']['input']>;
company?: InputMaybe<Scalars['String']['input']>;
countryCode?: InputMaybe<Scalars['String']['input']>;
fullName?: InputMaybe<Scalars['String']['input']>;
phoneNumber?: InputMaybe<Scalars['String']['input']>;
postalCode?: InputMaybe<Scalars['String']['input']>;
province?: InputMaybe<Scalars['String']['input']>;
streetLine1?: InputMaybe<Scalars['String']['input']>;
streetLine2?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateOrderInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
};
export type UpdateOrderItemsResult = InsufficientStockError | NegativeQuantityError | Order | OrderLimitError | OrderModificationError;
export type UpdateOrderNoteInput = {
isPublic?: InputMaybe<Scalars['Boolean']['input']>;
note?: InputMaybe<Scalars['String']['input']>;
noteId: Scalars['ID']['input'];
};
export type UpdatePaymentMethodInput = {
checker?: InputMaybe<ConfigurableOperationInput>;
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
handler?: InputMaybe<ConfigurableOperationInput>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<PaymentMethodTranslationInput>>;
};
export type UpdateProductInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<ProductTranslationInput>>;
};
export type UpdateProductOptionGroupInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<ProductOptionGroupTranslationInput>>;
};
export type UpdateProductOptionInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<ProductOptionGroupTranslationInput>>;
};
export type UpdateProductVariantInput = {
assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
id: Scalars['ID']['input'];
optionIds?: InputMaybe<Array<Scalars['ID']['input']>>;
outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
/** Sets the price for the ProductVariant in the Channel's default currency */
price?: InputMaybe<Scalars['Money']['input']>;
/** Allows multiple prices to be set for the ProductVariant in different currencies. */
prices?: InputMaybe<Array<ProductVariantPriceInput>>;
sku?: InputMaybe<Scalars['String']['input']>;
stockLevels?: InputMaybe<Array<StockLevelInput>>;
stockOnHand?: InputMaybe<Scalars['Int']['input']>;
taxCategoryId?: InputMaybe<Scalars['ID']['input']>;
trackInventory?: InputMaybe<GlobalFlag>;
translations?: InputMaybe<Array<ProductVariantTranslationInput>>;
useGlobalOutOfStockThreshold?: InputMaybe<Scalars['Boolean']['input']>;
};
export type UpdatePromotionInput = {
actions?: InputMaybe<Array<ConfigurableOperationInput>>;
conditions?: InputMaybe<Array<ConfigurableOperationInput>>;
couponCode?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
endsAt?: InputMaybe<Scalars['DateTime']['input']>;
id: Scalars['ID']['input'];
perCustomerUsageLimit?: InputMaybe<Scalars['Int']['input']>;
startsAt?: InputMaybe<Scalars['DateTime']['input']>;
translations?: InputMaybe<Array<PromotionTranslationInput>>;
usageLimit?: InputMaybe<Scalars['Int']['input']>;
};
export type UpdatePromotionResult = MissingConditionsError | Promotion;
export type UpdateProvinceInput = {
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
id: Scalars['ID']['input'];
translations?: InputMaybe<Array<ProvinceTranslationInput>>;
};
export type UpdateRoleInput = {
channelIds?: InputMaybe<Array<Scalars['ID']['input']>>;
code?: InputMaybe<Scalars['String']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
permissions?: InputMaybe<Array<Permission>>;
};
export type UpdateSellerInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateShippingMethodInput = {
calculator?: InputMaybe<ConfigurableOperationInput>;
checker?: InputMaybe<ConfigurableOperationInput>;
code?: InputMaybe<Scalars['String']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
fulfillmentHandler?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
translations: Array<ShippingMethodTranslationInput>;
};
export type UpdateStockLocationInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
description?: InputMaybe<Scalars['String']['input']>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateTagInput = {
id: Scalars['ID']['input'];
value?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateTaxCategoryInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
isDefault?: InputMaybe<Scalars['Boolean']['input']>;
name?: InputMaybe<Scalars['String']['input']>;
};
export type UpdateTaxRateInput = {
categoryId?: InputMaybe<Scalars['ID']['input']>;
customFields?: InputMaybe<Scalars['JSON']['input']>;
customerGroupId?: InputMaybe<Scalars['ID']['input']>;
enabled?: InputMaybe<Scalars['Boolean']['input']>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
value?: InputMaybe<Scalars['Float']['input']>;
zoneId?: InputMaybe<Scalars['ID']['input']>;
};
export type UpdateZoneInput = {
customFields?: InputMaybe<Scalars['JSON']['input']>;
id: Scalars['ID']['input'];
name?: InputMaybe<Scalars['String']['input']>;
};
export type User = Node & {
authenticationMethods: Array<AuthenticationMethod>;
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
identifier: Scalars['String']['output'];
lastLogin?: Maybe<Scalars['DateTime']['output']>;
roles: Array<Role>;
updatedAt: Scalars['DateTime']['output'];
verified: Scalars['Boolean']['output'];
};
export type Zone = Node & {
createdAt: Scalars['DateTime']['output'];
customFields?: Maybe<Scalars['JSON']['output']>;
id: Scalars['ID']['output'];
members: Array<Region>;
name: Scalars['String']['output'];
updatedAt: Scalars['DateTime']['output'];
};
export type ZoneFilterParameter = {
_and?: InputMaybe<Array<ZoneFilterParameter>>;
_or?: InputMaybe<Array<ZoneFilterParameter>>;
createdAt?: InputMaybe<DateOperators>;
id?: InputMaybe<IdOperators>;
name?: InputMaybe<StringOperators>;
updatedAt?: InputMaybe<DateOperators>;
};
export type ZoneList = PaginatedList & {
items: Array<Zone>;
totalItems: Scalars['Int']['output'];
};
export type ZoneListOptions = {
/** Allows the results to be filtered */
filter?: InputMaybe<ZoneFilterParameter>;
/** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
filterOperator?: InputMaybe<LogicalOperator>;
/** Skips the first n results, for use in pagination */
skip?: InputMaybe<Scalars['Int']['input']>;
/** Specifies which properties to sort the results by */
sort?: InputMaybe<ZoneSortParameter>;
/** Takes n results, for use in pagination */
take?: InputMaybe<Scalars['Int']['input']>;
};
export type ZoneSortParameter = {
createdAt?: InputMaybe<SortOrder>;
id?: InputMaybe<SortOrder>;
name?: InputMaybe<SortOrder>;
updatedAt?: InputMaybe<SortOrder>;
};
export type ReindexMutationVariables = Exact<{ [key: string]: never; }>;
export type ReindexMutation = { reindex: { id: string, queueName: string, state: JobState, progress: number, duration: number, result?: any | null } };
export type GetCollectionListQueryVariables = Exact<{ [key: string]: never; }>;
export type GetCollectionListQuery = { collections: { items: Array<{ id: string, name: string }> } };
export type SearchProductsAdminQueryVariables = Exact<{
input: SearchInput;
}>;
export type SearchProductsAdminQuery = { search: { totalItems: number, items: Array<{ enabled: boolean, productId: string, productName: string, slug: string, description: string, productVariantId: string, productVariantName: string, sku: string, productAsset?: { id: string, preview: string, focalPoint?: { x: number, y: number } | null } | null, productVariantAsset?: { id: string, preview: string, focalPoint?: { x: number, y: number } | null } | null }> } };
export type SearchFacetValuesQueryVariables = Exact<{
input: SearchInput;
}>;
export type SearchFacetValuesQuery = { search: { totalItems: number, facetValues: Array<{ count: number, facetValue: { id: string, name: string } }> } };
export type SearchCollectionsQueryVariables = Exact<{
input: SearchInput;
}>;
export type SearchCollectionsQuery = { search: { totalItems: number, collections: Array<{ count: number, collection: { id: string, name: string } }> } };
export type SearchGetPricesQueryVariables = Exact<{
input: SearchInput;
}>;
export type SearchGetPricesQuery = { search: { items: Array<{ price: { min: number, max: number } | { value: number }, priceWithTax: { min: number, max: number } | { value: number } }> } };
export type GetJobInfoQueryVariables = Exact<{
id: Scalars['ID']['input'];
}>;
export type GetJobInfoQuery = { job?: { id: string, queueName: string, state: JobState, progress: number, duration: number, result?: any | null } | null };
export const ReindexDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"mutation","name":{"kind":"Name","value":"Reindex"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"reindex"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"queueName"}},{"kind":"Field","name":{"kind":"Name","value":"state"}},{"kind":"Field","name":{"kind":"Name","value":"progress"}},{"kind":"Field","name":{"kind":"Name","value":"duration"}},{"kind":"Field","name":{"kind":"Name","value":"result"}}]}}]}}]} as unknown as DocumentNode<ReindexMutation, ReindexMutationVariables>;
export const GetCollectionListDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"GetCollectionList"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"collections"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"items"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]}}]}}]} as unknown as DocumentNode<GetCollectionListQuery, GetCollectionListQueryVariables>;
export const SearchProductsAdminDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"SearchProductsAdmin"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"SearchInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"search"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"totalItems"}},{"kind":"Field","name":{"kind":"Name","value":"items"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"enabled"}},{"kind":"Field","name":{"kind":"Name","value":"productId"}},{"kind":"Field","name":{"kind":"Name","value":"productName"}},{"kind":"Field","name":{"kind":"Name","value":"slug"}},{"kind":"Field","name":{"kind":"Name","value":"description"}},{"kind":"Field","name":{"kind":"Name","value":"productAsset"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"preview"}},{"kind":"Field","name":{"kind":"Name","value":"focalPoint"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"x"}},{"kind":"Field","name":{"kind":"Name","value":"y"}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"productVariantId"}},{"kind":"Field","name":{"kind":"Name","value":"productVariantName"}},{"kind":"Field","name":{"kind":"Name","value":"productVariantAsset"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"preview"}},{"kind":"Field","name":{"kind":"Name","value":"focalPoint"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"x"}},{"kind":"Field","name":{"kind":"Name","value":"y"}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"sku"}}]}}]}}]}}]} as unknown as DocumentNode<SearchProductsAdminQuery, SearchProductsAdminQueryVariables>;
export const SearchFacetValuesDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"SearchFacetValues"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"SearchInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"search"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"totalItems"}},{"kind":"Field","name":{"kind":"Name","value":"facetValues"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"count"}},{"kind":"Field","name":{"kind":"Name","value":"facetValue"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]}}]}}]}}]} as unknown as DocumentNode<SearchFacetValuesQuery, SearchFacetValuesQueryVariables>;
export const SearchCollectionsDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"SearchCollections"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"SearchInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"search"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"totalItems"}},{"kind":"Field","name":{"kind":"Name","value":"collections"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"count"}},{"kind":"Field","name":{"kind":"Name","value":"collection"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"name"}}]}}]}}]}}]}}]} as unknown as DocumentNode<SearchCollectionsQuery, SearchCollectionsQueryVariables>;
export const SearchGetPricesDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"SearchGetPrices"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"input"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"SearchInput"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"search"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"input"},"value":{"kind":"Variable","name":{"kind":"Name","value":"input"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"items"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"price"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"PriceRange"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"min"}},{"kind":"Field","name":{"kind":"Name","value":"max"}}]}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"SinglePrice"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]}},{"kind":"Field","name":{"kind":"Name","value":"priceWithTax"},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"PriceRange"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"min"}},{"kind":"Field","name":{"kind":"Name","value":"max"}}]}},{"kind":"InlineFragment","typeCondition":{"kind":"NamedType","name":{"kind":"Name","value":"SinglePrice"}},"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"value"}}]}}]}}]}}]}}]}}]} as unknown as DocumentNode<SearchGetPricesQuery, SearchGetPricesQueryVariables>;
export const GetJobInfoDocument = {"kind":"Document","definitions":[{"kind":"OperationDefinition","operation":"query","name":{"kind":"Name","value":"GetJobInfo"},"variableDefinitions":[{"kind":"VariableDefinition","variable":{"kind":"Variable","name":{"kind":"Name","value":"id"}},"type":{"kind":"NonNullType","type":{"kind":"NamedType","name":{"kind":"Name","value":"ID"}}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"job"},"arguments":[{"kind":"Argument","name":{"kind":"Name","value":"jobId"},"value":{"kind":"Variable","name":{"kind":"Name","value":"id"}}}],"selectionSet":{"kind":"SelectionSet","selections":[{"kind":"Field","name":{"kind":"Name","value":"id"}},{"kind":"Field","name":{"kind":"Name","value":"queueName"}},{"kind":"Field","name":{"kind":"Name","value":"state"}},{"kind":"Field","name":{"kind":"Name","value":"progress"}},{"kind":"Field","name":{"kind":"Name","value":"duration"}},{"kind":"Field","name":{"kind":"Name","value":"result"}}]}}]}}]} as unknown as DocumentNode<GetJobInfoQuery, GetJobInfoQueryVariables>; |
import { LanguageCode, LogicalOperator, SortOrder } from '@vendure/common/lib/generated-types';
import { DeepRequired } from '@vendure/core';
import { describe, expect, it } from 'vitest';
import { buildElasticBody } from './build-elastic-body';
import { defaultOptions, SearchConfig } from './options';
describe('buildElasticBody()', () => {
const searchConfig = defaultOptions.searchConfig;
const CHANNEL_ID = 42;
const CHANNEL_ID_TERM = { term: { channelId: CHANNEL_ID } };
const LANGUAGE_CODE_TERM = { term: { languageCode: LanguageCode.en } };
it('search term', () => {
const result = buildElasticBody({ term: 'test' }, searchConfig, CHANNEL_ID, LanguageCode.en);
expect(result.query).toEqual({
bool: {
filter: [CHANNEL_ID_TERM, LANGUAGE_CODE_TERM],
must: [
{
multi_match: {
query: 'test',
type: 'best_fields',
fields: ['productName^1', 'productVariantName^1', 'description^1', 'sku^1'],
},
},
],
},
});
});
it('facetValueIds AND', () => {
const result = buildElasticBody(
{ facetValueIds: ['1', '2'], facetValueOperator: LogicalOperator.AND },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [
CHANNEL_ID_TERM,
LANGUAGE_CODE_TERM,
{
bool: {
must: [{ term: { facetValueIds: '1' } }, { term: { facetValueIds: '2' } }],
},
},
],
},
});
});
it('facetValueIds OR', () => {
const result = buildElasticBody(
{ facetValueIds: ['1', '2'], facetValueOperator: LogicalOperator.OR },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [
CHANNEL_ID_TERM,
LANGUAGE_CODE_TERM,
{
bool: {
should: [{ term: { facetValueIds: '1' } }, { term: { facetValueIds: '2' } }],
},
},
],
},
});
});
it('facetValueFilters AND with OR', () => {
const result = buildElasticBody(
{ facetValueFilters: [{ and: '1' }, { or: ['2', '3'] }] },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [
CHANNEL_ID_TERM,
LANGUAGE_CODE_TERM,
{ term: { facetValueIds: '1' } },
{
bool: {
should: [{ term: { facetValueIds: '2' } }, { term: { facetValueIds: '3' } }],
},
},
],
},
});
});
it('facetValueFilters AND', () => {
const result = buildElasticBody(
{ facetValueFilters: [{ and: '1' }, { and: '2' }] },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [
CHANNEL_ID_TERM,
LANGUAGE_CODE_TERM,
{ term: { facetValueIds: '1' } },
{ term: { facetValueIds: '2' } },
],
},
});
});
it('facetValueFilters OR', () => {
const result = buildElasticBody(
{ facetValueFilters: [{ or: ['1', '2'] }] },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [
CHANNEL_ID_TERM,
LANGUAGE_CODE_TERM,
{
bool: {
should: [{ term: { facetValueIds: '1' } }, { term: { facetValueIds: '2' } }],
},
},
],
},
});
});
it('facetValueFilters with facetValueIds AND', () => {
const result = buildElasticBody(
{
facetValueFilters: [{ and: '1' }, { or: ['2', '3'] }],
facetValueIds: ['1', '2'],
facetValueOperator: LogicalOperator.AND,
},
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [
CHANNEL_ID_TERM,
LANGUAGE_CODE_TERM,
{
bool: {
must: [{ term: { facetValueIds: '1' } }, { term: { facetValueIds: '2' } }],
},
},
{ term: { facetValueIds: '1' } },
{
bool: {
should: [{ term: { facetValueIds: '2' } }, { term: { facetValueIds: '3' } }],
},
},
],
},
});
});
it('facetValueFilters with facetValueIds OR', () => {
const result = buildElasticBody(
{
facetValueFilters: [{ and: '1' }, { or: ['2', '3'] }],
facetValueIds: ['1', '2'],
facetValueOperator: LogicalOperator.OR,
},
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [
CHANNEL_ID_TERM,
LANGUAGE_CODE_TERM,
{
bool: {
should: [{ term: { facetValueIds: '1' } }, { term: { facetValueIds: '2' } }],
},
},
{ term: { facetValueIds: '1' } },
{
bool: {
should: [{ term: { facetValueIds: '2' } }, { term: { facetValueIds: '3' } }],
},
},
],
},
});
});
it('collectionId', () => {
const result = buildElasticBody({ collectionId: '1' }, searchConfig, CHANNEL_ID, LanguageCode.en);
expect(result.query).toEqual({
bool: {
filter: [CHANNEL_ID_TERM, LANGUAGE_CODE_TERM, { term: { collectionIds: '1' } }],
},
});
});
it('collectionSlug', () => {
const result = buildElasticBody(
{ collectionSlug: 'plants' },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [CHANNEL_ID_TERM, LANGUAGE_CODE_TERM, { term: { collectionSlugs: 'plants' } }],
},
});
});
it('paging', () => {
const result = buildElasticBody({ skip: 20, take: 10 }, searchConfig, CHANNEL_ID, LanguageCode.en);
expect(result).toEqual({
from: 20,
size: 10,
query: { bool: { filter: [CHANNEL_ID_TERM, LANGUAGE_CODE_TERM] } },
sort: [],
track_total_hits: 10000,
});
});
it('inStock is True and groupByProduct', () => {
const result = buildElasticBody(
{ inStock: true, groupByProduct: true },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [CHANNEL_ID_TERM, LANGUAGE_CODE_TERM, { term: { productInStock: true } }],
},
});
});
it('inStock is False and groupByProduct', () => {
const result = buildElasticBody(
{ inStock: false, groupByProduct: true },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [CHANNEL_ID_TERM, LANGUAGE_CODE_TERM, { term: { productInStock: false } }],
},
});
});
it('inStock is undefined and groupByProduct', () => {
const result = buildElasticBody({ groupByProduct: true }, searchConfig, CHANNEL_ID, LanguageCode.en);
expect(result.query).toEqual({
bool: {
filter: [CHANNEL_ID_TERM, LANGUAGE_CODE_TERM],
},
});
});
it('inStock is True and not groupByProduct', () => {
const result = buildElasticBody(
{ inStock: true, groupByProduct: false },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [CHANNEL_ID_TERM, LANGUAGE_CODE_TERM, { term: { inStock: true } }],
},
});
});
it('inStock is False and not groupByProduct', () => {
const result = buildElasticBody(
{ inStock: false, groupByProduct: false },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [CHANNEL_ID_TERM, LANGUAGE_CODE_TERM, { term: { inStock: false } }],
},
});
});
it('inStock is undefined and not groupByProduct', () => {
const result = buildElasticBody({ groupByProduct: false }, searchConfig, CHANNEL_ID, LanguageCode.en);
expect(result.query).toEqual({
bool: {
filter: [CHANNEL_ID_TERM, LANGUAGE_CODE_TERM],
},
});
});
describe('sorting', () => {
it('name', () => {
const result = buildElasticBody(
{ sort: { name: SortOrder.DESC } },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.sort).toEqual([{ 'productName.keyword': { order: 'desc' } }]);
});
it('price', () => {
const result = buildElasticBody(
{ sort: { price: SortOrder.ASC } },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.sort).toEqual([{ price: { order: 'asc' } }]);
});
it('grouped price', () => {
const result = buildElasticBody(
{ sort: { price: SortOrder.ASC }, groupByProduct: true },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.sort).toEqual([{ price: { order: 'asc' } }]);
});
});
it('enabledOnly true', () => {
const result = buildElasticBody({}, searchConfig, CHANNEL_ID, LanguageCode.en, true);
expect(result.query).toEqual({
bool: {
filter: [CHANNEL_ID_TERM, LANGUAGE_CODE_TERM, { term: { enabled: true } }],
},
});
});
it('enabledOnly false', () => {
const result = buildElasticBody({}, searchConfig, CHANNEL_ID, LanguageCode.en, false);
expect(result.query).toEqual({
bool: { filter: [CHANNEL_ID_TERM, LANGUAGE_CODE_TERM] },
});
});
it('combined inputs', () => {
const result = buildElasticBody(
{
term: 'test',
take: 25,
skip: 0,
sort: {
name: SortOrder.DESC,
},
groupByProduct: true,
collectionId: '42',
facetValueIds: ['6', '7'],
},
searchConfig,
CHANNEL_ID,
LanguageCode.en,
true,
);
expect(result).toEqual({
collapse: {
field: 'productId',
},
from: 0,
size: 25,
query: {
bool: {
must: [
{
multi_match: {
query: 'test',
type: 'best_fields',
fields: ['productName^1', 'productVariantName^1', 'description^1', 'sku^1'],
},
},
],
filter: [
CHANNEL_ID_TERM,
LANGUAGE_CODE_TERM,
{
bool: {
should: [{ term: { facetValueIds: '6' } }, { term: { facetValueIds: '7' } }],
},
},
{ term: { collectionIds: '42' } },
{ term: { enabled: true } },
],
},
},
sort: [{ 'productName.keyword': { order: 'desc' } }],
track_total_hits: 10000,
});
});
it('multiMatchType option', () => {
const result = buildElasticBody(
{ term: 'test' },
{ ...searchConfig, multiMatchType: 'phrase' },
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [CHANNEL_ID_TERM, LANGUAGE_CODE_TERM],
must: [
{
multi_match: {
query: 'test',
type: 'phrase',
fields: ['productName^1', 'productVariantName^1', 'description^1', 'sku^1'],
},
},
],
},
});
});
it('boostFields option', () => {
const config: DeepRequired<SearchConfig> = {
...searchConfig,
...{
boostFields: {
description: 2,
productName: 3,
productVariantName: 4,
sku: 5,
},
},
};
const result = buildElasticBody({ term: 'test' }, config, CHANNEL_ID, LanguageCode.en);
expect(result.query).toEqual({
bool: {
filter: [CHANNEL_ID_TERM, LANGUAGE_CODE_TERM],
must: [
{
multi_match: {
query: 'test',
type: 'best_fields',
fields: ['productName^3', 'productVariantName^4', 'description^2', 'sku^5'],
},
},
],
},
});
});
it('scriptFields option', () => {
const config: DeepRequired<SearchConfig> = {
...searchConfig,
...{
scriptFields: {
test: {
graphQlType: 'String',
context: 'both',
scriptFn: input => ({
script: `doc['property'].dummyScript(${input.term as string})`,
}),
},
},
},
};
const result = buildElasticBody({ term: 'test' }, config, CHANNEL_ID, LanguageCode.en);
expect(result.script_fields).toEqual({
test: {
script: 'doc[\'property\'].dummyScript(test)',
},
});
});
describe('price ranges', () => {
it('not grouped by product', () => {
const result = buildElasticBody(
{ priceRange: { min: 500, max: 1500 }, groupByProduct: false },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [
CHANNEL_ID_TERM,
LANGUAGE_CODE_TERM,
{
range: {
price: {
gte: 500,
lte: 1500,
},
},
},
],
},
});
});
it('not grouped by product, with tax', () => {
const result = buildElasticBody(
{ priceRangeWithTax: { min: 500, max: 1500 }, groupByProduct: false },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [
CHANNEL_ID_TERM,
LANGUAGE_CODE_TERM,
{
range: {
priceWithTax: {
gte: 500,
lte: 1500,
},
},
},
],
},
});
});
it('grouped by product', () => {
const result = buildElasticBody(
{ priceRange: { min: 500, max: 1500 }, groupByProduct: true },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [
CHANNEL_ID_TERM,
LANGUAGE_CODE_TERM,
{
range: {
price: {
gte: 500,
lte: 1500,
},
},
},
],
},
});
});
it('grouped by product, with tax', () => {
const result = buildElasticBody(
{ priceRangeWithTax: { min: 500, max: 1500 }, groupByProduct: true },
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [
CHANNEL_ID_TERM,
LANGUAGE_CODE_TERM,
{
range: {
priceWithTax: {
gte: 500,
lte: 1500,
},
},
},
],
},
});
});
it('combined with collectionId and facetValueIds filters', () => {
const result = buildElasticBody(
{
priceRangeWithTax: { min: 500, max: 1500 },
groupByProduct: true,
collectionId: '3',
facetValueIds: ['5'],
},
searchConfig,
CHANNEL_ID,
LanguageCode.en,
);
expect(result.query).toEqual({
bool: {
filter: [
CHANNEL_ID_TERM,
LANGUAGE_CODE_TERM,
{
bool: {
should: [{ term: { facetValueIds: '5' } }],
},
},
{ term: { collectionIds: '3' } },
{
range: {
priceWithTax: {
gte: 500,
lte: 1500,
},
},
},
],
},
});
});
});
});
|
import { LanguageCode, LogicalOperator, PriceRange, SortOrder } from '@vendure/common/lib/generated-types';
import { DeepRequired, ID, UserInputError } from '@vendure/core';
import { SearchConfig } from './options';
import { CustomScriptMapping, ElasticSearchInput, ElasticSearchSortInput, SearchRequestBody } from './types';
/**
* Given a SearchInput object, returns the corresponding Elasticsearch body.
*/
export function buildElasticBody(
input: ElasticSearchInput,
searchConfig: DeepRequired<SearchConfig>,
channelId: ID,
languageCode: LanguageCode,
enabledOnly: boolean = false,
): SearchRequestBody {
const {
term,
facetValueIds,
facetValueOperator,
collectionId,
collectionSlug,
groupByProduct,
skip,
take,
sort,
priceRangeWithTax,
priceRange,
facetValueFilters,
inStock,
} = input;
const query: any = {
bool: {},
};
ensureBoolFilterExists(query);
query.bool.filter.push({ term: { channelId } });
query.bool.filter.push({ term: { languageCode } });
if (term) {
query.bool.must = [
{
multi_match: {
query: term,
type: searchConfig.multiMatchType,
fields: [
`productName^${searchConfig.boostFields.productName}`,
`productVariantName^${searchConfig.boostFields.productVariantName}`,
`description^${searchConfig.boostFields.description}`,
`sku^${searchConfig.boostFields.sku}`,
],
},
},
];
}
if (facetValueIds && facetValueIds.length) {
ensureBoolFilterExists(query);
const operator = facetValueOperator === LogicalOperator.AND ? 'must' : 'should';
query.bool.filter = query.bool.filter.concat([
{
bool: { [operator]: facetValueIds.map(id => ({ term: { facetValueIds: id } })) },
},
]);
}
if (facetValueFilters && facetValueFilters.length) {
ensureBoolFilterExists(query);
facetValueFilters.forEach(facetValueFilter => {
if (facetValueFilter.and && facetValueFilter.or && facetValueFilter.or.length) {
throw new UserInputError('error.facetfilterinput-invalid-input');
}
if (facetValueFilter.and) {
query.bool.filter.push({ term: { facetValueIds: facetValueFilter.and } });
}
if (facetValueFilter.or && facetValueFilter.or.length) {
query.bool.filter.push({
bool: { ['should']: facetValueFilter.or.map(id => ({ term: { facetValueIds: id } })) },
});
}
});
}
if (collectionId) {
ensureBoolFilterExists(query);
query.bool.filter.push({ term: { collectionIds: collectionId } });
}
if (collectionSlug) {
ensureBoolFilterExists(query);
query.bool.filter.push({ term: { collectionSlugs: collectionSlug } });
}
if (enabledOnly) {
ensureBoolFilterExists(query);
query.bool.filter.push({ term: { enabled: true } });
}
if (priceRange) {
ensureBoolFilterExists(query);
query.bool.filter = query.bool.filter.concat(createPriceFilters(priceRange, false));
}
if (priceRangeWithTax) {
ensureBoolFilterExists(query);
query.bool.filter = query.bool.filter.concat(createPriceFilters(priceRangeWithTax, true));
}
if (inStock !== undefined) {
ensureBoolFilterExists(query);
if (groupByProduct) {
query.bool.filter.push({ term: { productInStock: inStock } });
} else {
query.bool.filter.push({ term: { inStock } });
}
}
const sortArray: ElasticSearchSortInput = [];
if (sort) {
if (sort.name) {
sortArray.push({
'productName.keyword': { order: sort.name === SortOrder.ASC ? 'asc' : 'desc' },
});
}
if (sort.price) {
const priceField = 'price';
sortArray.push({ [priceField]: { order: sort.price === SortOrder.ASC ? 'asc' : 'desc' } });
}
}
const scriptFields: any | undefined = createScriptFields(
searchConfig.scriptFields,
input,
groupByProduct,
);
const body: SearchRequestBody = {
query: searchConfig.mapQuery
? searchConfig.mapQuery(query, input, searchConfig, channelId, enabledOnly)
: query,
sort: searchConfig.mapSort ? searchConfig.mapSort(sortArray, input) : sortArray,
from: skip || 0,
size: take || 10,
track_total_hits: searchConfig.totalItemsMaxSize,
...(scriptFields !== undefined
? {
_source: true,
script_fields: scriptFields,
}
: undefined),
};
if (groupByProduct) {
body.collapse = { field: 'productId' };
}
return body;
}
function ensureBoolFilterExists(query: { bool: { filter?: any } }) {
if (!query.bool.filter) {
query.bool.filter = [];
}
}
function createScriptFields(
scriptFields: { [fieldName: string]: CustomScriptMapping<[ElasticSearchInput]> },
input: ElasticSearchInput,
groupByProduct?: boolean,
): any | undefined {
if (scriptFields) {
const fields = Object.keys(scriptFields);
if (fields.length) {
const result: any = {};
for (const name of fields) {
const scriptField = scriptFields[name];
if (scriptField.context === 'product' && groupByProduct === true) {
(result )[name] = scriptField.scriptFn(input);
}
if (scriptField.context === 'variant' && groupByProduct === false) {
(result )[name] = scriptField.scriptFn(input);
}
if (scriptField.context === 'both' || scriptField.context === undefined) {
(result )[name] = scriptField.scriptFn(input);
}
}
return result;
}
}
return undefined;
}
function createPriceFilters(range: PriceRange, withTax: boolean): any[] {
const withTaxFix = withTax ? 'WithTax' : '';
return [
{
range: {
['price' + withTaxFix]: {
gte: range.min,
lte: range.max,
},
},
},
];
}
|
export const ELASTIC_SEARCH_OPTIONS = Symbol('ELASTIC_SEARCH_OPTIONS');
export const VARIANT_INDEX_NAME = 'variants';
export const loggerCtx = 'ElasticsearchPlugin';
|
import { Injectable } from '@nestjs/common';
import { HealthCheckError, HealthIndicator, HealthIndicatorResult } from '@nestjs/terminus';
import { ElasticsearchService } from './elasticsearch.service';
@Injectable()
export class ElasticsearchHealthIndicator extends HealthIndicator {
constructor(private elasticsearchService: ElasticsearchService) {
super();
}
async isHealthy(): Promise<HealthIndicatorResult> {
let isHealthy = false;
let error = '';
try {
await this.elasticsearchService.checkConnection();
isHealthy = true;
} catch (e: any) {
error = e.message;
}
const result = this.getStatus('elasticsearch', isHealthy, { message: error });
if (isHealthy) {
return result;
}
this.throwHealthCheckError(result);
}
startupCheckFailed(message: string): never {
const result = this.getStatus('elasticsearch', false, { message });
return this.throwHealthCheckError(result);
}
private throwHealthCheckError(result: HealthIndicatorResult): never {
throw new HealthCheckError('Elasticsearch not available', result);
}
}
|
import { Client } from '@elastic/elasticsearch';
import { Inject, Injectable, OnModuleDestroy, OnModuleInit } from '@nestjs/common';
import { SearchResultAsset } from '@vendure/common/lib/generated-types';
import {
Collection,
CollectionService,
ConfigService,
DeepRequired,
EventBus,
FacetValue,
FacetValueService,
InternalServerError,
Job,
Logger,
RequestContext,
SearchEvent,
SearchService,
} from '@vendure/core';
import equal from 'fast-deep-equal/es6';
import { buildElasticBody } from './build-elastic-body';
import { ELASTIC_SEARCH_OPTIONS, loggerCtx, VARIANT_INDEX_NAME } from './constants';
import { ElasticsearchIndexService } from './indexing/elasticsearch-index.service';
import { createIndices, getClient } from './indexing/indexing-utils';
import { ElasticsearchOptions } from './options';
import {
CustomMapping,
CustomScriptContext,
CustomScriptMapping,
ElasticSearchInput,
ElasticSearchResponse,
ElasticSearchResult,
ProductIndexItem,
SearchHit,
SearchPriceData,
SearchResponseBody,
VariantIndexItem,
} from './types';
@Injectable()
export class ElasticsearchService implements OnModuleInit, OnModuleDestroy {
private client: Client;
constructor(
@Inject(ELASTIC_SEARCH_OPTIONS) private options: DeepRequired<ElasticsearchOptions>,
private searchService: SearchService,
private elasticsearchIndexService: ElasticsearchIndexService,
private configService: ConfigService,
private facetValueService: FacetValueService,
private collectionService: CollectionService,
private eventBus: EventBus,
) {
searchService.adopt(this);
}
onModuleInit(): any {
this.client = getClient(this.options);
}
onModuleDestroy(): any {
return this.client.close();
}
async checkConnection(): Promise<void> {
await new Promise<void>(async (resolve, reject) => {
const { connectionAttempts, connectionAttemptInterval } = this.options;
let attempts = 0;
Logger.verbose('Pinging Elasticsearch...', loggerCtx);
while (attempts < connectionAttempts) {
attempts++;
try {
const pingResult = await this.client.ping({}, { requestTimeout: 1000 });
if (pingResult.body) {
Logger.verbose('Ping to Elasticsearch successful', loggerCtx);
return resolve();
}
} catch (e: any) {
Logger.verbose(
`Ping to Elasticsearch failed with error "${e.message as string}"`,
loggerCtx,
);
}
Logger.verbose(
`Connection to Elasticsearch could not be made, trying again after ${connectionAttemptInterval}ms (attempt ${attempts} of ${connectionAttempts})`,
loggerCtx,
);
await new Promise(resolve1 => setTimeout(resolve1, connectionAttemptInterval));
}
reject('Could not connection to Elasticsearch. Aborting bootstrap.');
});
}
async createIndicesIfNotExists() {
const { indexPrefix } = this.options;
const createIndex = async (indexName: string) => {
const index = indexPrefix + indexName;
const result = await this.client.indices.exists({ index });
if (!result.body) {
Logger.verbose(`Index "${index}" does not exist. Creating...`, loggerCtx);
await createIndices(
this.client,
indexPrefix,
this.options.indexSettings,
this.options.indexMappingProperties,
);
} else {
Logger.verbose(`Index "${index}" exists`, loggerCtx);
const existingIndexSettingsResult = await this.client.indices.getSettings({ index });
const existingIndexSettings =
existingIndexSettingsResult.body[Object.keys(existingIndexSettingsResult.body)[0]]
.settings.index;
const tempName = new Date().getTime();
const nameSalt = Math.random().toString(36).substring(7);
const tempPrefix = 'temp-' + `${tempName}-${nameSalt}-`;
const tempIndex = tempPrefix + indexName;
await createIndices(
this.client,
tempPrefix,
this.options.indexSettings,
this.options.indexMappingProperties,
false,
);
const tempIndexSettingsResult = await this.client.indices.getSettings({ index: tempIndex });
const tempIndexSettings = tempIndexSettingsResult.body[tempIndex].settings.index;
const indexParamsToExclude = [
'routing',
'number_of_shards',
'provided_name',
'creation_date',
'number_of_replicas',
'uuid',
'version',
];
for (const param of indexParamsToExclude) {
delete tempIndexSettings[param];
delete existingIndexSettings[param];
}
if (!equal(tempIndexSettings, existingIndexSettings))
Logger.warn(
`Index "${index}" settings differs from index setting in vendure config! Consider re-indexing the data.`,
loggerCtx,
);
else {
const existingIndexMappingsResult = await this.client.indices.getMapping({ index });
const existingIndexMappings =
existingIndexMappingsResult.body[Object.keys(existingIndexMappingsResult.body)[0]]
.mappings;
const tempIndexMappingsResult = await this.client.indices.getMapping({
index: tempIndex,
});
const tempIndexMappings = tempIndexMappingsResult.body[tempIndex].mappings;
if (!equal(tempIndexMappings, existingIndexMappings))
// eslint-disable-next-line max-len
Logger.warn(
`Index "${index}" mapping differs from index mapping in vendure config! Consider re-indexing the data.`,
loggerCtx,
);
}
await this.client.indices.delete({
index: [tempPrefix + 'variants'],
});
}
};
await createIndex(VARIANT_INDEX_NAME);
}
/**
* Perform a fulltext search according to the provided input arguments.
*/
async search(
ctx: RequestContext,
input: ElasticSearchInput,
enabledOnly: boolean = false,
): Promise<Omit<ElasticSearchResponse, 'facetValues' | 'collections' | 'priceRange'>> {
const { indexPrefix } = this.options;
const { groupByProduct } = input;
const elasticSearchBody = buildElasticBody(
input,
this.options.searchConfig,
ctx.channelId,
ctx.languageCode,
enabledOnly,
);
if (groupByProduct) {
try {
const { body }: { body: SearchResponseBody<VariantIndexItem> } = await this.client.search({
index: indexPrefix + VARIANT_INDEX_NAME,
body: elasticSearchBody,
});
const totalItems = await this.totalHits(ctx, input, groupByProduct);
await this.eventBus.publish(new SearchEvent(ctx, input));
return {
items: body.hits.hits.map(hit => this.mapProductToSearchResult(hit)),
totalItems,
};
} catch (e: any) {
if (e.meta.body.error.type && e.meta.body.error.type === 'search_phase_execution_exception') {
// Log runtime error of the script exception instead of stacktrace
Logger.error(
e.message,
loggerCtx,
JSON.stringify(e.meta.body.error.root_cause || [], null, 2),
);
Logger.verbose(JSON.stringify(e.meta.body.error.failed_shards || [], null, 2), loggerCtx);
} else {
Logger.error(e.message, loggerCtx, e.stack);
}
throw e;
}
} else {
try {
const { body }: { body: SearchResponseBody<VariantIndexItem> } = await this.client.search({
index: indexPrefix + VARIANT_INDEX_NAME,
body: elasticSearchBody,
});
await this.eventBus.publish(new SearchEvent(ctx, input));
return {
items: body.hits.hits.map(hit => this.mapVariantToSearchResult(hit)),
totalItems: body.hits.total ? body.hits.total.value : 0,
};
} catch (e: any) {
if (e.meta.body.error.type && e.meta.body.error.type === 'search_phase_execution_exception') {
// Log runtime error of the script exception instead of stacktrace
Logger.error(
e.message,
loggerCtx,
JSON.stringify(e.meta.body.error.root_cause || [], null, 2),
);
Logger.verbose(JSON.stringify(e.meta.body.error.failed_shards || [], null, 2), loggerCtx);
} else {
Logger.error(e.message, loggerCtx, e.stack);
}
throw e;
}
}
}
async totalHits(
ctx: RequestContext,
input: ElasticSearchInput,
enabledOnly: boolean = false,
): Promise<number> {
const { indexPrefix, searchConfig } = this.options;
const elasticSearchBody = buildElasticBody(
input,
searchConfig,
ctx.channelId,
ctx.languageCode,
enabledOnly,
);
elasticSearchBody.from = 0;
elasticSearchBody.size = 0;
elasticSearchBody.aggs = {
total: {
cardinality: {
field: 'productId',
},
},
};
const { body }: { body: SearchResponseBody<VariantIndexItem> } = await this.client.search({
index: indexPrefix + VARIANT_INDEX_NAME,
body: elasticSearchBody,
});
const { aggregations } = body;
if (!aggregations) {
throw new InternalServerError(
'An error occurred when querying Elasticsearch for priceRange aggregations',
);
}
return aggregations.total ? aggregations.total.value : 0;
}
/**
* Return a list of all FacetValues which appear in the result set.
*/
async facetValues(
ctx: RequestContext,
input: ElasticSearchInput,
enabledOnly: boolean = false,
): Promise<Array<{ facetValue: FacetValue; count: number }>> {
const { groupByProduct } = input;
const buckets = await this.getDistinctBucketsOfField(
ctx,
input,
enabledOnly,
'facetValueIds',
this.options.searchConfig.facetValueMaxSize,
);
const facetValues = await this.facetValueService.findByIds(
ctx,
buckets.map(b => b.key),
);
return facetValues.map(facetValue => {
const bucket = buckets.find(b => b.key.toString() === facetValue.id.toString());
let count;
if (groupByProduct) {
count = bucket ? bucket.total.value : 0;
} else {
count = bucket ? bucket.doc_count : 0;
}
return {
facetValue,
count,
};
});
}
/**
* Return a list of all Collections which appear in the result set.
*/
async collections(
ctx: RequestContext,
input: ElasticSearchInput,
enabledOnly: boolean = false,
): Promise<Array<{ collection: Collection; count: number }>> {
const { groupByProduct } = input;
const buckets = await this.getDistinctBucketsOfField(
ctx,
input,
enabledOnly,
'collectionIds',
this.options.searchConfig.collectionMaxSize,
);
const collections = await this.collectionService.findByIds(
ctx,
buckets.map(b => b.key),
);
return collections.map(collection => {
const bucket = buckets.find(b => b.key.toString() === collection.id.toString());
let count;
if (groupByProduct) {
count = bucket ? bucket.total.value : 0;
} else {
count = bucket ? bucket.doc_count : 0;
}
return {
collection,
count,
};
});
}
async getDistinctBucketsOfField(
ctx: RequestContext,
input: ElasticSearchInput,
enabledOnly: boolean = false,
field: string,
aggregation_max_size: number,
): Promise<Array<{ key: string; doc_count: number; total: { value: number } }>> {
const { indexPrefix } = this.options;
const { groupByProduct } = input;
const elasticSearchBody = buildElasticBody(
input,
this.options.searchConfig,
ctx.channelId,
ctx.languageCode,
enabledOnly,
);
elasticSearchBody.from = 0;
elasticSearchBody.size = 0;
elasticSearchBody.aggs = {
aggregation_field: {
terms: {
field,
size: aggregation_max_size,
},
},
};
if (groupByProduct) {
elasticSearchBody.aggs.aggregation_field.aggs = {
total: {
cardinality: {
field: 'productId',
},
},
};
}
let body: SearchResponseBody<VariantIndexItem>;
try {
const result = await this.client.search<SearchResponseBody<VariantIndexItem>>({
index: indexPrefix + VARIANT_INDEX_NAME,
body: elasticSearchBody,
});
body = result.body;
} catch (e: any) {
Logger.error(e.message, loggerCtx, e.stack);
throw e;
}
return body.aggregations ? body.aggregations.aggregation_field.buckets : [];
}
async priceRange(ctx: RequestContext, input: ElasticSearchInput): Promise<SearchPriceData> {
const { indexPrefix, searchConfig } = this.options;
const elasticSearchBody = buildElasticBody(
input,
searchConfig,
ctx.channelId,
ctx.languageCode,
true,
);
elasticSearchBody.from = 0;
elasticSearchBody.size = 0;
elasticSearchBody.aggs = {
minPrice: {
min: {
field: 'price',
},
},
minPriceWithTax: {
min: {
field: 'priceWithTax',
},
},
maxPrice: {
max: {
field: 'price',
},
},
maxPriceWithTax: {
max: {
field: 'priceWithTax',
},
},
prices: {
histogram: {
field: 'price',
interval: searchConfig.priceRangeBucketInterval,
},
},
pricesWithTax: {
histogram: {
field: 'priceWithTax',
interval: searchConfig.priceRangeBucketInterval,
},
},
};
const { body }: { body: SearchResponseBody<VariantIndexItem> } = await this.client.search({
index: indexPrefix + VARIANT_INDEX_NAME,
body: elasticSearchBody,
});
const { aggregations } = body;
if (!aggregations) {
throw new InternalServerError(
'An error occurred when querying Elasticsearch for priceRange aggregations',
);
}
const mapPriceBuckets = (b: { key: string; doc_count: number }) => ({
to: Number.parseInt(b.key, 10) + searchConfig.priceRangeBucketInterval,
count: b.doc_count,
});
return {
range: {
min: aggregations.minPrice.value || 0,
max: aggregations.maxPrice.value || 0,
},
rangeWithTax: {
min: aggregations.minPriceWithTax.value || 0,
max: aggregations.maxPriceWithTax.value || 0,
},
buckets: aggregations.prices.buckets.map(mapPriceBuckets).filter(x => 0 < x.count),
bucketsWithTax: aggregations.pricesWithTax.buckets.map(mapPriceBuckets).filter(x => 0 < x.count),
};
}
/**
* Rebuilds the full search index.
*/
async reindex(ctx: RequestContext): Promise<Job> {
const job = await this.elasticsearchIndexService.reindex(ctx);
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
return job;
}
private mapVariantToSearchResult(hit: SearchHit<VariantIndexItem>): ElasticSearchResult {
const source = hit._source;
const fields = hit.fields;
const { productAsset, productVariantAsset } = this.getSearchResultAssets(source);
const result = {
...source,
productAsset,
productVariantAsset,
price: {
value: source.price,
},
priceWithTax: {
value: source.priceWithTax,
},
score: hit._score || 0,
};
ElasticsearchService.addCustomMappings(
result,
source,
this.options.customProductMappings,
this.options.customProductVariantMappings,
false,
);
ElasticsearchService.addScriptMappings(
result,
fields,
this.options.searchConfig?.scriptFields,
'variant',
);
return result;
}
private mapProductToSearchResult(hit: SearchHit<VariantIndexItem>): ElasticSearchResult {
const source = hit._source;
const fields = hit.fields;
const { productAsset, productVariantAsset } = this.getSearchResultAssets(source);
const result = {
...source,
productAsset,
productVariantAsset,
enabled: source.productEnabled,
productId: source.productId.toString(),
productName: source.productName,
productVariantId: source.productVariantId.toString(),
productVariantName: source.productVariantName,
facetIds: source.productFacetIds as string[],
facetValueIds: source.productFacetValueIds as string[],
collectionIds: source.productCollectionIds as string[],
sku: source.sku,
slug: source.slug,
price: {
min: source.productPriceMin,
max: source.productPriceMax,
},
priceWithTax: {
min: source.productPriceWithTaxMin,
max: source.productPriceWithTaxMax,
},
channelIds: [],
inStock: source.productInStock,
score: hit._score || 0,
};
ElasticsearchService.addCustomMappings(
result,
source,
this.options.customProductMappings,
this.options.customProductVariantMappings,
true,
);
ElasticsearchService.addScriptMappings(
result,
fields,
this.options.searchConfig?.scriptFields,
'product',
);
return result;
}
private getSearchResultAssets(source: ProductIndexItem | VariantIndexItem): {
productAsset: SearchResultAsset | undefined;
productVariantAsset: SearchResultAsset | undefined;
} {
const productAsset: SearchResultAsset | undefined = source.productAssetId
? {
id: source.productAssetId.toString(),
preview: source.productPreview,
focalPoint: source.productPreviewFocalPoint,
}
: undefined;
const productVariantAsset: SearchResultAsset | undefined = source.productVariantAssetId
? {
id: source.productVariantAssetId.toString(),
preview: source.productVariantPreview,
focalPoint: source.productVariantPreviewFocalPoint,
}
: undefined;
return { productAsset, productVariantAsset };
}
private static addCustomMappings(
result: any,
source: any,
productMappings: { [fieldName: string]: CustomMapping<any> },
variantMappings: { [fieldName: string]: CustomMapping<any> },
groupByProduct: boolean,
): any {
const productCustomMappings = Object.keys(productMappings);
if (productCustomMappings.length) {
const customMappingsResult: any = {};
for (const name of productCustomMappings) {
customMappingsResult[name] = source[`product-${name}`];
}
result.customProductMappings = customMappingsResult;
if (groupByProduct) {
result.customMappings = customMappingsResult;
}
}
const variantCustomMappings = Object.keys(variantMappings);
if (variantCustomMappings.length) {
const customMappingsResult: any = {};
for (const name of variantCustomMappings) {
customMappingsResult[name] = source[`variant-${name}`];
}
result.customProductVariantMappings = customMappingsResult;
if (!groupByProduct) {
result.customMappings = customMappingsResult;
}
}
return result;
}
private static addScriptMappings(
result: any,
fields: any,
mappings: { [fieldName: string]: CustomScriptMapping<any> },
environment: CustomScriptContext,
): any {
const customMappings = Object.keys(mappings || {});
if (customMappings.length) {
const customScriptFieldsResult: any = {};
for (const name of customMappings) {
const env = mappings[name].context;
if (env === environment || env === 'both') {
const fieldVal = fields[name] || undefined;
if (Array.isArray(fieldVal)) {
if (fieldVal.length === 1) {
customScriptFieldsResult[name] = fieldVal[0];
}
if (fieldVal.length > 1) {
customScriptFieldsResult[name] = JSON.stringify(fieldVal);
}
} else {
customScriptFieldsResult[name] = fieldVal;
}
}
}
result.customScriptFields = customScriptFieldsResult;
}
return result;
}
}
|
import { ClientOptions } from '@elastic/elasticsearch';
import {
DeepRequired,
EntityRelationPaths,
ID,
Injector,
LanguageCode,
Product,
ProductVariant,
RequestContext
} from '@vendure/core';
import deepmerge from 'deepmerge';
import {
CustomMapping,
CustomScriptMapping,
ElasticSearchInput,
ElasticSearchSortInput,
GraphQlPrimitive,
PrimitiveTypeVariations,
} from './types';
/**
* @description
* Configuration options for the {@link ElasticsearchPlugin}.
*
* @docsCategory core plugins/ElasticsearchPlugin
* @docsPage ElasticsearchOptions
*/
export interface ElasticsearchOptions {
/**
* @description
* The host of the Elasticsearch server. May also be specified in `clientOptions.node`.
*
* @default 'http://localhost'
*/
host?: string;
/**
* @description
* The port of the Elasticsearch server. May also be specified in `clientOptions.node`.
*
* @default 9200
*/
port?: number;
/**
* @description
* Maximum amount of attempts made to connect to the ElasticSearch server on startup.
*
* @default 10
*/
connectionAttempts?: number;
/**
* @description
* Interval in milliseconds between attempts to connect to the ElasticSearch server on startup.
*
* @default 5000
*/
connectionAttemptInterval?: number;
/**
* @description
* Options to pass directly to the
* [Elasticsearch Node.js client](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html). For example, to
* set authentication or other more advanced options.
* Note that if the `node` or `nodes` option is specified, it will override the values provided in the `host` and `port` options.
*/
clientOptions?: ClientOptions;
/**
* @description
* Prefix for the indices created by the plugin.
*
* @default
* 'vendure-'
*/
indexPrefix?: string;
/**
* @description
* [These options](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/index-modules.html#index-modules-settings)
* are directly passed to index settings. To apply some settings indices will be recreated.
*
* @example
* ```ts
* // Configuring an English stemmer
* indexSettings: {
* analysis: {
* analyzer: {
* custom_analyzer: {
* tokenizer: 'standard',
* filter: [
* 'lowercase',
* 'english_stemmer'
* ]
* }
* },
* filter : {
* english_stemmer : {
* type : 'stemmer',
* name : 'english'
* }
* }
* }
* },
* ```
* A more complete example can be found in the discussion thread
* [How to make elastic plugin to search by substring with stemming](https://github.com/vendure-ecommerce/vendure/discussions/1066).
*
* @since 1.2.0
* @default
* {}
*/
indexSettings?: object;
/**
* @description
* This option allow to redefine or define new properties in mapping. More about elastic
* [mapping](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html)
* After changing this option indices will be recreated.
*
* @example
* ```ts
* // Configuring custom analyzer for the `productName` field.
* indexMappingProperties: {
* productName: {
* type: 'text',
* analyzer:'custom_analyzer',
* fields: {
* keyword: {
* type: 'keyword',
* ignore_above: 256,
* }
* }
* }
* }
* ```
*
* To reference a field defined by `customProductMappings` or `customProductVariantMappings`, you will
* need to prefix the name with `'product-<name>'` or `'variant-<name>'` respectively, e.g.:
*
* @example
* ```ts
* customProductMappings: {
* variantCount: {
* graphQlType: 'Int!',
* valueFn: (product, variants) => variants.length,
* },
* },
* indexMappingProperties: {
* 'product-variantCount': {
* type: 'integer',
* }
* }
* ```
*
* @since 1.2.0
* @default
* {}
*/
indexMappingProperties?: {
[indexName: string]: object;
};
/**
* @description
* Products limit chunk size for each loop iteration when indexing products.
*
* @default 2500
* @since 2.1.7
*/
reindexProductsChunkSize?: number;
/**
* @description
* Index operations are performed in bulk, with each bulk operation containing a number of individual
* index operations. This option sets the maximum number of operations in the memory buffer before a
* bulk operation is executed.
*
* @default 3000
* @since 2.1.7
*/
reindexBulkOperationSizeLimit?: number;
/**
* @description
* Configuration of the internal Elasticsearch query.
*/
searchConfig?: SearchConfig;
/**
* @description
* Custom mappings may be defined which will add the defined data to the
* Elasticsearch index and expose that data via the SearchResult GraphQL type,
* adding a new `customMappings`, `customProductMappings` & `customProductVariantMappings` fields.
*
* The `graphQlType` property may be one of `String`, `Int`, `Float`, `Boolean`, `ID` or list
* versions thereof (`[String!]` etc) and can be appended with a `!` to indicate non-nullable fields.
*
* The `public` (default = `true`) property is used to reveal or hide the property in the GraphQL API schema.
* If this property is set to `false` it's not accessible in the `customMappings` field but it's still getting
* parsed to the elasticsearch index.
*
* This config option defines custom mappings which are accessible when the "groupByProduct"
* input options is set to `true`. In addition, custom variant mappings can be accessed by using
* the `customProductVariantMappings` field, which is always available.
*
* @example
* ```ts
* customProductMappings: {
* variantCount: {
* graphQlType: 'Int!',
* valueFn: (product, variants) => variants.length,
* },
* reviewRating: {
* graphQlType: 'Float',
* public: true,
* valueFn: product => (product.customFields as any).reviewRating,
* },
* priority: {
* graphQlType: 'Int!',
* public: false,
* valueFn: product => (product.customFields as any).priority,
* },
* }
* ```
*
* @example
* ```graphql
* query SearchProducts($input: SearchInput!) {
* search(input: $input) {
* totalItems
* items {
* productId
* productName
* customProductMappings {
* variantCount
* reviewRating
* }
* customMappings {
* ...on CustomProductMappings {
* variantCount
* reviewRating
* }
* }
* }
* }
* }
* ```
*/
customProductMappings?: {
[fieldName: string]: CustomMapping<[Product, ProductVariant[], LanguageCode, Injector, RequestContext]>;
};
/**
* @description
* This config option defines custom mappings which are accessible when the "groupByProduct"
* input options is set to `false`. In addition, custom product mappings can be accessed by using
* the `customProductMappings` field, which is always available.
*
* @example
* ```graphql
* query SearchProducts($input: SearchInput!) {
* search(input: $input) {
* totalItems
* items {
* productId
* productName
* customProductVariantMappings {
* weight
* }
* customMappings {
* ...on CustomProductVariantMappings {
* weight
* }
* }
* }
* }
* }
* ```
*/
customProductVariantMappings?: {
[fieldName: string]: CustomMapping<[ProductVariant, LanguageCode, Injector, RequestContext]>;
};
/**
* @description
* If set to `true`, updates to Products, ProductVariants and Collections will not immediately
* trigger an update to the search index. Instead, all these changes will be buffered and will
* only be run via a call to the `runPendingSearchIndexUpdates` mutation in the Admin API.
*
* This is very useful for installations with a large number of ProductVariants and/or
* Collections, as the buffering allows better control over when these expensive jobs are run,
* and also performs optimizations to minimize the amount of work that needs to be performed by
* the worker.
*
* @since 1.3.0
* @default false
*/
bufferUpdates?: boolean;
/**
* @description
* Additional product relations that will be fetched from DB while reindexing. This can be used
* in combination with `customProductMappings` to ensure that the required relations are joined
* before the `product` object is passed to the `valueFn`.
*
* @example
* ```ts
* {
* hydrateProductRelations: ['assets.asset'],
* customProductMappings: {
* assetPreviews: {
* graphQlType: '[String!]',
* // Here we can be sure that the `product.assets` array is populated
* // with an Asset object
* valueFn: (product) => product.assets.map(a => a.asset.preview),
* }
* }
* }
* ```
*
* @default []
* @since 1.3.0
*/
hydrateProductRelations?: Array<EntityRelationPaths<Product>>;
/**
* @description
* Additional variant relations that will be fetched from DB while reindexing. See
* `hydrateProductRelations` for more explanation and a usage example.
*
* @default []
* @since 1.3.0
*/
hydrateProductVariantRelations?: Array<EntityRelationPaths<ProductVariant>>;
/**
* @description
* Allows the `SearchInput` type to be extended with new input fields. This allows arbitrary
* data to be passed in, which can then be used e.g. in the `mapQuery()` function or
* custom `scriptFields` functions.
*
* @example
* ```ts
* extendSearchInputType: {
* longitude: 'Float',
* latitude: 'Float',
* radius: 'Float',
* }
* ```
*
* This allows the search query to include these new fields:
*
* @example
* ```graphql
* query {
* search(input: {
* longitude: 101.7117,
* latitude: 3.1584,
* radius: 50.00
* }) {
* items {
* productName
* }
* }
* }
* ```
*
* @default {}
* @since 1.3.0
*/
extendSearchInputType?: {
[name: string]: PrimitiveTypeVariations<GraphQlPrimitive>;
};
/**
* @description
* Adds a list of sort parameters. This is mostly important to make the
* correct sort order values available inside `input` parameter of the `mapSort` option.
*
* @example
* ```ts
* extendSearchSortType: ["distance"]
* ```
*
* will extend the `SearchResultSortParameter` input type like this:
*
* @example
* ```GraphQl
* extend input SearchResultSortParameter {
* distance: SortOrder
* }
* ```
*
* @default []
* @since 1.4.0
*/
extendSearchSortType?: string[];
}
/**
* @description
* Configuration options for the internal Elasticsearch query which is generated when performing a search.
*
* @docsCategory core plugins/ElasticsearchPlugin
* @docsPage ElasticsearchOptions
*/
export interface SearchConfig {
/**
* @description
* The maximum number of FacetValues to return from the search query. Internally, this
* value sets the "size" property of an Elasticsearch aggregation.
*
* @default
* 50
*/
facetValueMaxSize?: number;
/**
* @description
* The maximum number of Collections to return from the search query. Internally, this
* value sets the "size" property of an Elasticsearch aggregation.
*
* @since 1.1.0
* @default
* 50
*/
collectionMaxSize?: number;
/**
* @description
* The maximum number of totalItems to return from the search query. Internally, this
* value sets the "track_total_hits" property of an Elasticsearch query.
* If this parameter is set to "True", accurate count of totalItems will be returned.
* If this parameter is set to "False", totalItems will be returned as 0.
* If this parameter is set to integer, accurate count of totalItems will be returned not bigger than integer.
*
* @since 1.2.0
* @default
* 10000
*/
totalItemsMaxSize?: number | boolean;
// prettier-ignore
/**
* @description
* Defines the
* [multi match type](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html#multi-match-types)
* used when matching against a search term.
*
* @default
* 'best_fields'
*/
multiMatchType?: 'best_fields' | 'most_fields' | 'cross_fields' | 'phrase' | 'phrase_prefix' | 'bool_prefix';
/**
* @description
* Set custom boost values for particular fields when matching against a search term.
*/
boostFields?: BoostFieldsConfig;
/**
* @description
* The interval used to group search results into buckets according to price range. For example, setting this to
* `2000` will group into buckets every $20.00:
*
* ```json
* {
* "data": {
* "search": {
* "totalItems": 32,
* "priceRange": {
* "buckets": [
* {
* "to": 2000,
* "count": 21
* },
* {
* "to": 4000,
* "count": 7
* },
* {
* "to": 6000,
* "count": 3
* },
* {
* "to": 12000,
* "count": 1
* }
* ]
* }
* }
* }
* }
* ```
*/
priceRangeBucketInterval?: number;
/**
* @description
* This config option allows the the modification of the whole (already built) search query. This allows
* for e.g. wildcard / fuzzy searches on the index.
*
* @example
* ```ts
* mapQuery: (query, input, searchConfig, channelId, enabledOnly){
* if(query.bool.must){
* delete query.bool.must;
* }
* query.bool.should = [
* {
* query_string: {
* query: "*" + term + "*",
* fields: [
* `productName^${searchConfig.boostFields.productName}`,
* `productVariantName^${searchConfig.boostFields.productVariantName}`,
* ]
* }
* },
* {
* multi_match: {
* query: term,
* type: searchConfig.multiMatchType,
* fields: [
* `description^${searchConfig.boostFields.description}`,
* `sku^${searchConfig.boostFields.sku}`,
* ],
* },
* },
* ];
*
* return query;
* }
* ```
*/
mapQuery?: (
query: any,
input: ElasticSearchInput,
searchConfig: DeepRequired<SearchConfig>,
channelId: ID,
enabledOnly: boolean,
) => any;
/**
* @description
* Sets `script_fields` inside the elasticsearch body which allows returning a script evaluation for each hit.
*
* The script field definition consists of three properties:
*
* * `graphQlType`: This is the type that will be returned when this script field is queried
* via the GraphQL API. It may be one of `String`, `Int`, `Float`, `Boolean`, `ID` or list
* versions thereof (`[String!]` etc) and can be appended with a `!` to indicate non-nullable fields.
* * `context`: determines whether this script field is available when grouping by product. Can be
* `product`, `variant` or `both`.
* * `scriptFn`: This is the function to run on each hit. Should return an object with a `script` property,
* as covered in the
* [Elasticsearch script fields docs](https://www.elastic.co/guide/en/elasticsearch/reference/7.15/search-fields.html#script-fields)
*
* @example
* ```ts
* extendSearchInputType: {
* latitude: 'Float',
* longitude: 'Float',
* },
* indexMappingProperties: {
* // The `product-location` field corresponds to the `location` customProductMapping
* // defined below. Here we specify that it would be index as a `geo_point` type,
* // which will allow us to perform geo-spacial calculations on it in our script field.
* 'product-location': {
* type: 'geo_point', // contains function arcDistance
* },
* },
* customProductMappings: {
* location: {
* graphQlType: 'String',
* valueFn: (product: Product) => {
* // Assume that the Product entity has this customField defined
* const custom = product.customFields.location;
* return `${custom.latitude},${custom.longitude}`;
* },
* }
* },
* searchConfig: {
* scriptFields: {
* distance: {
* graphQlType: 'Float!',
* // Run this script only when grouping results by product
* context: 'product',
* scriptFn: (input) => {
* // The SearchInput was extended with latitude and longitude
* // via the `extendSearchInputType` option above.
* const lat = input.latitude;
* const lon = input.longitude;
* return {
* script: `doc['product-location'].arcDistance(${lat}, ${lon})`,
* }
* }
* }
* }
* }
* ```
*
* @since 1.3.0
*/
scriptFields?: { [fieldName: string]: CustomScriptMapping<[ElasticSearchInput]> };
/**
* @description
* Allows extending the `sort` input of the elasticsearch body as covered in
* [Elasticsearch sort docs](https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html)
*
* The `sort` input parameter contains the ElasticSearchSortInput generated for the default sort parameters "name" and "price".
* If neither of those are applied it will be empty.
*
* @example
* ```ts
* mapSort: (sort, input) => {
* // Assuming `extendSearchSortType: ["priority"]`
* // Assuming priority is never undefined
* const { priority } = input.sort;
* return [
* ...sort,
* {
* // The `product-priority` field corresponds to the `priority` customProductMapping
* // Depending on the index type, this field might require a
* // more detailed input (example: 'productName.keyword')
* ["product-priority"]: {
* order: priority === SortOrder.ASC ? 'asc' : 'desc'
* }
* }
* ];
* }
* ```
*
* A more generic example would be a sort function based on a product location like this:
* @example
* ```ts
* extendSearchInputType: {
* latitude: 'Float',
* longitude: 'Float',
* },
* extendSearchSortType: ["distance"],
* indexMappingProperties: {
* // The `product-location` field corresponds to the `location` customProductMapping
* // defined below. Here we specify that it would be index as a `geo_point` type,
* // which will allow us to perform geo-spacial calculations on it in our script field.
* 'product-location': {
* type: 'geo_point',
* },
* },
* customProductMappings: {
* location: {
* graphQlType: 'String',
* valueFn: (product: Product) => {
* // Assume that the Product entity has this customField defined
* const custom = product.customFields.location;
* return `${custom.latitude},${custom.longitude}`;
* },
* }
* },
* searchConfig: {
* mapSort: (sort, input) => {
* // Assuming distance is never undefined
* const { distance } = input.sort;
* return [
* ...sort,
* {
* ["_geo_distance"]: {
* "product-location": [
* input.longitude,
* input.latitude
* ],
* order: distance === SortOrder.ASC ? 'asc' : 'desc',
* unit: "km"
* }
* }
* ];
* }
* }
* ```
*
* @default {}
* @since 1.4.0
*/
mapSort?: (sort: ElasticSearchSortInput, input: ElasticSearchInput) => ElasticSearchSortInput;
}
/**
* @description
* Configuration for [boosting](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html#field-boost)
* the scores of given fields when performing a search against a term.
*
* Boosting a field acts as a score multiplier for matches against that field.
*
* @docsCategory core plugins/ElasticsearchPlugin
* @docsPage ElasticsearchOptions
*/
export interface BoostFieldsConfig {
/**
* @description
* Defines the boost factor for the productName field.
*
* @default 1
*/
productName?: number;
/**
* @description
* Defines the boost factor for the productVariantName field.
*
* @default 1
*/
productVariantName?: number;
/**
* @description
* Defines the boost factor for the description field.
*
* @default 1
*/
description?: number;
/**
* @description
* Defines the boost factor for the sku field.
*
* @default 1
*/
sku?: number;
}
export type ElasticsearchRuntimeOptions = DeepRequired<Omit<ElasticsearchOptions, 'clientOptions'>> & {
clientOptions?: ClientOptions;
};
export const defaultOptions: ElasticsearchRuntimeOptions = {
host: 'http://localhost',
port: 9200,
connectionAttempts: 10,
connectionAttemptInterval: 5000,
indexPrefix: 'vendure-',
indexSettings: {},
indexMappingProperties: {},
reindexProductsChunkSize: 2500,
reindexBulkOperationSizeLimit: 3000,
searchConfig: {
facetValueMaxSize: 50,
collectionMaxSize: 50,
totalItemsMaxSize: 10000,
multiMatchType: 'best_fields',
boostFields: {
productName: 1,
productVariantName: 1,
description: 1,
sku: 1,
},
priceRangeBucketInterval: 1000,
mapQuery: query => query,
mapSort: sort => sort,
scriptFields: {},
},
customProductMappings: {},
customProductVariantMappings: {},
bufferUpdates: false,
hydrateProductRelations: [],
hydrateProductVariantRelations: [],
extendSearchInputType: {},
extendSearchSortType: [],
};
export function mergeWithDefaults(userOptions: ElasticsearchOptions): ElasticsearchRuntimeOptions {
const { clientOptions, ...pluginOptions } = userOptions;
const merged = deepmerge(defaultOptions, pluginOptions) as ElasticsearchRuntimeOptions;
return { ...merged, clientOptions };
}
|
import { NodeOptions } from '@elastic/elasticsearch';
import { OnApplicationBootstrap } from '@nestjs/common';
import {
AssetEvent,
BUFFER_SEARCH_INDEX_UPDATES,
CollectionModificationEvent,
EventBus,
HealthCheckRegistryService,
ID,
idsAreEqual,
Logger,
PluginCommonModule,
ProductChannelEvent,
ProductEvent,
ProductVariantChannelEvent,
ProductVariantEvent,
SearchJobBufferService,
TaxRateModificationEvent,
Type,
VendurePlugin,
} from '@vendure/core';
import { buffer, debounceTime, delay, filter, map } from 'rxjs/operators';
import { generateSchemaExtensions } from './api/api-extensions';
import { CustomMappingsResolver } from './api/custom-mappings.resolver';
import { CustomScriptFieldsResolver } from './api/custom-script-fields.resolver';
import {
AdminElasticSearchResolver,
EntityElasticSearchResolver,
ShopElasticSearchResolver,
} from './api/elasticsearch-resolver';
import { ELASTIC_SEARCH_OPTIONS, loggerCtx } from './constants';
import { ElasticsearchHealthIndicator } from './elasticsearch.health';
import { ElasticsearchService } from './elasticsearch.service';
import { ElasticsearchIndexService } from './indexing/elasticsearch-index.service';
import { ElasticsearchIndexerController } from './indexing/indexer.controller';
import { ElasticsearchOptions, ElasticsearchRuntimeOptions, mergeWithDefaults } from './options';
function getCustomResolvers(options: ElasticsearchRuntimeOptions) {
const requiresUnionResolver =
0 < Object.keys(options.customProductMappings || {}).length &&
0 < Object.keys(options.customProductVariantMappings || {}).length;
const requiresUnionScriptResolver =
0 <
Object.values(options.searchConfig.scriptFields || {}).filter(
field => field.context !== 'product',
).length &&
0 <
Object.values(options.searchConfig.scriptFields || {}).filter(
field => field.context !== 'variant',
).length;
return [
...(requiresUnionResolver ? [CustomMappingsResolver] : []),
...(requiresUnionScriptResolver ? [CustomScriptFieldsResolver] : []),
];
}
/**
* @description
* This plugin allows your product search to be powered by [Elasticsearch](https://github.com/elastic/elasticsearch) - a powerful Open Source search
* engine. This is a drop-in replacement for the DefaultSearchPlugin which exposes many powerful configuration options enabling your storefront
* to support a wide range of use-cases such as indexing of custom properties, fine control over search index configuration, and to leverage
* advanced Elasticsearch features like spacial search.
*
* ## Installation
*
* **Requires Elasticsearch v7.0 < required Elasticsearch version < 7.10 **
* Elasticsearch version 7.10.2 will throw error due to incompatibility with elasticsearch-js client.
* [Check here for more info](https://github.com/elastic/elasticsearch-js/issues/1519).
*
* `yarn add \@elastic/elasticsearch \@vendure/elasticsearch-plugin`
*
* or
*
* `npm install \@elastic/elasticsearch \@vendure/elasticsearch-plugin`
*
* Make sure to remove the `DefaultSearchPlugin` if it is still in the VendureConfig plugins array.
*
* Then add the `ElasticsearchPlugin`, calling the `.init()` method with {@link ElasticsearchOptions}:
*
* @example
* ```ts
* import { ElasticsearchPlugin } from '\@vendure/elasticsearch-plugin';
*
* const config: VendureConfig = {
* // Add an instance of the plugin to the plugins array
* plugins: [
* ElasticsearchPlugin.init({
* host: 'http://localhost',
* port: 9200,
* }),
* ],
* };
* ```
*
* ## Search API Extensions
* This plugin extends the default search query of the Shop API, allowing richer querying of your product data.
*
* The [SearchResponse](/reference/graphql-api/admin/object-types/#searchresponse) type is extended with information
* about price ranges in the result set:
* ```graphql
* extend type SearchResponse {
* prices: SearchResponsePriceData!
* }
*
* type SearchResponsePriceData {
* range: PriceRange!
* rangeWithTax: PriceRange!
* buckets: [PriceRangeBucket!]!
* bucketsWithTax: [PriceRangeBucket!]!
* }
*
* type PriceRangeBucket {
* to: Int!
* count: Int!
* }
*
* extend input SearchInput {
* priceRange: PriceRangeInput
* priceRangeWithTax: PriceRangeInput
* }
*
* input PriceRangeInput {
* min: Int!
* max: Int!
* }
* ```
*
* This `SearchResponsePriceData` type allows you to query data about the range of prices in the result set.
*
* ## Example Request & Response
*
* ```graphql
* {
* search (input: {
* term: "table easel"
* groupByProduct: true
* priceRange: {
min: 500
max: 7000
}
* }) {
* totalItems
* prices {
* range {
* min
* max
* }
* buckets {
* to
* count
* }
* }
* items {
* productName
* score
* price {
* ...on PriceRange {
* min
* max
* }
* }
* }
* }
* }
* ```
*
* ```json
*{
* "data": {
* "search": {
* "totalItems": 9,
* "prices": {
* "range": {
* "min": 999,
* "max": 6396,
* },
* "buckets": [
* {
* "to": 1000,
* "count": 1
* },
* {
* "to": 2000,
* "count": 2
* },
* {
* "to": 3000,
* "count": 3
* },
* {
* "to": 4000,
* "count": 1
* },
* {
* "to": 5000,
* "count": 1
* },
* {
* "to": 7000,
* "count": 1
* }
* ]
* },
* "items": [
* {
* "productName": "Loxley Yorkshire Table Easel",
* "score": 30.58831,
* "price": {
* "min": 4984,
* "max": 4984
* }
* },
* // ... truncated
* ]
* }
* }
*}
* ```
*
* @docsCategory core plugins/ElasticsearchPlugin
*/
@VendurePlugin({
imports: [PluginCommonModule],
providers: [
ElasticsearchIndexService,
ElasticsearchService,
ElasticsearchHealthIndicator,
ElasticsearchIndexerController,
SearchJobBufferService,
{ provide: ELASTIC_SEARCH_OPTIONS, useFactory: () => ElasticsearchPlugin.options },
{
provide: BUFFER_SEARCH_INDEX_UPDATES,
useFactory: () => ElasticsearchPlugin.options.bufferUpdates === true,
},
],
adminApiExtensions: {
resolvers: () => [
AdminElasticSearchResolver,
EntityElasticSearchResolver,
...getCustomResolvers(ElasticsearchPlugin.options),
],
schema: () => generateSchemaExtensions(ElasticsearchPlugin.options as any),
},
shopApiExtensions: {
resolvers: () => [
ShopElasticSearchResolver,
EntityElasticSearchResolver,
...getCustomResolvers(ElasticsearchPlugin.options),
],
// `any` cast is there due to a strange error "Property '[Symbol.iterator]' is missing in type... URLSearchParams"
// which looks like possibly a TS/definitions bug.
schema: () => generateSchemaExtensions(ElasticsearchPlugin.options as any),
},
compatibility: '^2.0.0',
})
export class ElasticsearchPlugin implements OnApplicationBootstrap {
private static options: ElasticsearchRuntimeOptions;
/** @internal */
constructor(
private eventBus: EventBus,
private elasticsearchService: ElasticsearchService,
private elasticsearchIndexService: ElasticsearchIndexService,
private elasticsearchHealthIndicator: ElasticsearchHealthIndicator,
private healthCheckRegistryService: HealthCheckRegistryService,
) {}
/**
* Set the plugin options.
*/
static init(options: ElasticsearchOptions): Type<ElasticsearchPlugin> {
this.options = mergeWithDefaults(options);
return ElasticsearchPlugin;
}
/** @internal */
async onApplicationBootstrap(): Promise<void> {
const nodeName = this.nodeName();
try {
await this.elasticsearchService.checkConnection();
} catch (e: any) {
Logger.error(`Could not connect to Elasticsearch instance at "${nodeName}"`, loggerCtx);
Logger.error(JSON.stringify(e), loggerCtx);
this.healthCheckRegistryService.registerIndicatorFunction(() =>
this.elasticsearchHealthIndicator.startupCheckFailed(e.message),
);
return;
}
Logger.info(`Successfully connected to Elasticsearch instance at "${nodeName}"`, loggerCtx);
await this.elasticsearchService.createIndicesIfNotExists();
this.healthCheckRegistryService.registerIndicatorFunction(() =>
this.elasticsearchHealthIndicator.isHealthy(),
);
this.eventBus.ofType(ProductEvent).subscribe(event => {
if (event.type === 'deleted') {
return this.elasticsearchIndexService.deleteProduct(event.ctx, event.product);
} else {
return this.elasticsearchIndexService.updateProduct(event.ctx, event.product);
}
});
this.eventBus.ofType(ProductVariantEvent).subscribe(event => {
if (event.type === 'deleted') {
return this.elasticsearchIndexService.deleteVariant(event.ctx, event.variants);
} else {
return this.elasticsearchIndexService.updateVariants(event.ctx, event.variants);
}
});
this.eventBus.ofType(AssetEvent).subscribe(event => {
if (event.type === 'updated') {
return this.elasticsearchIndexService.updateAsset(event.ctx, event.asset);
}
if (event.type === 'deleted') {
return this.elasticsearchIndexService.deleteAsset(event.ctx, event.asset);
}
});
this.eventBus.ofType(ProductChannelEvent).subscribe(event => {
if (event.type === 'assigned') {
return this.elasticsearchIndexService.assignProductToChannel(
event.ctx,
event.product,
event.channelId,
);
} else {
return this.elasticsearchIndexService.removeProductFromChannel(
event.ctx,
event.product,
event.channelId,
);
}
});
this.eventBus.ofType(ProductVariantChannelEvent).subscribe(event => {
if (event.type === 'assigned') {
return this.elasticsearchIndexService.assignVariantToChannel(
event.ctx,
event.productVariant.id,
event.channelId,
);
} else {
return this.elasticsearchIndexService.removeVariantFromChannel(
event.ctx,
event.productVariant.id,
event.channelId,
);
}
});
// TODO: Remove this buffering logic because because we have dedicated buffering based on #1137
const collectionModification$ = this.eventBus.ofType(CollectionModificationEvent);
const closingNotifier$ = collectionModification$.pipe(debounceTime(50));
collectionModification$
.pipe(
buffer(closingNotifier$),
filter(events => 0 < events.length),
map(events => ({
ctx: events[0].ctx,
ids: events.reduce((ids, e) => [...ids, ...e.productVariantIds], [] as ID[]),
})),
filter(e => 0 < e.ids.length),
)
.subscribe(events => {
return this.elasticsearchIndexService.updateVariantsById(events.ctx, events.ids);
});
this.eventBus
.ofType(TaxRateModificationEvent)
// The delay prevents a "TransactionNotStartedError" (in SQLite/sqljs) by allowing any existing
// transactions to complete before a new job is added to the queue (assuming the SQL-based
// JobQueueStrategy).
// TODO: should be able to remove owing to f0fd6625
.pipe(delay(1))
.subscribe(event => {
const defaultTaxZone = event.ctx.channel.defaultTaxZone;
if (defaultTaxZone && idsAreEqual(defaultTaxZone.id, event.taxRate.zone.id)) {
return this.elasticsearchService.reindex(event.ctx);
}
});
}
/**
* Returns a string representation of the target node(s) that the Elasticsearch
* client is configured to connect to.
*/
private nodeName(): string {
const { host, port, clientOptions } = ElasticsearchPlugin.options;
const node = clientOptions?.node;
const nodes = clientOptions?.nodes;
if (nodes) {
return [...(Array.isArray(nodes) ? nodes : [nodes])].join(', ');
}
if (node) {
if (Array.isArray(node)) {
return (node as any[])
.map((n: string | NodeOptions) => {
return typeof n === 'string' ? n : n.url.toString();
})
.join(', ');
} else {
return typeof node === 'string' ? node : node.url.toString();
}
}
return `${host}:${port}`;
}
}
|
import {
Coordinate,
CurrencyCode,
LanguageCode,
PriceRange,
SearchInput,
SearchResponse,
SearchResult,
} from '@vendure/common/lib/generated-types';
import { ID, JsonCompatible } from '@vendure/common/lib/shared-types';
import { Asset, SerializedRequestContext } from '@vendure/core';
export type ElasticSearchResult = SearchResult & {
inStock: boolean;
};
export type ElasticSearchInput = SearchInput & {
priceRange?: PriceRange;
priceRangeWithTax?: PriceRange;
inStock?: boolean;
[extendedInputField: string]: any;
};
export type ElasticSearchResponse = SearchResponse & {
priceRange: SearchPriceData;
items: ElasticSearchResult[];
};
export type SearchPriceData = {
range: PriceRange;
rangeWithTax: PriceRange;
buckets: PriceRangeBucket[];
bucketsWithTax: PriceRangeBucket[];
};
export type PriceRangeBucket = {
to: number;
count: number;
};
export enum ElasticSearchSortMode {
/** Pick the lowest value */
MIN = 'min',
/** Pick the highest value */
MAX = 'max',
/** Use the sum of all values as sort value. Only applicable for number based array fields */
SUM = 'sum',
/** Use the average of all values as sort value. Only applicable for number based array fields */
AVG = 'avg',
/** Use the median of all values as sort value. Only applicable for number based array fields */
MEDIAN = 'median',
}
export type ElasticSearchSortParameter = {
missing?: '_last' | '_first' | string;
mode?: ElasticSearchSortMode;
order: 'asc' | 'desc';
} & { [key: string]: any };
export type ElasticSearchSortInput = Array<{ [key: string]: ElasticSearchSortParameter }>;
export type IndexItemAssets = {
productAssetId: ID | undefined;
productPreview: string;
productPreviewFocalPoint: Coordinate | undefined;
productVariantAssetId: ID | undefined;
productVariantPreview: string;
productVariantPreviewFocalPoint: Coordinate | undefined;
};
export type VariantIndexItem = Omit<
SearchResult,
'score' | 'price' | 'priceWithTax' | 'productAsset' | 'productVariantAsset'
> &
IndexItemAssets & {
channelId: ID;
languageCode: LanguageCode;
price: number;
priceWithTax: number;
collectionSlugs: string[];
productEnabled: boolean;
productPriceMin: number;
productPriceMax: number;
productPriceWithTaxMin: number;
productPriceWithTaxMax: number;
productFacetIds: ID[];
productFacetValueIds: ID[];
productCollectionIds: ID[];
productCollectionSlugs: string[];
productChannelIds: ID[];
[customMapping: string]: any;
inStock: boolean;
productInStock: boolean;
};
export type ProductIndexItem = IndexItemAssets & {
sku: string;
slug: string;
productId: ID;
channelId: ID;
languageCode: LanguageCode;
productName: string;
productVariantId: ID;
productVariantName: string;
currencyCode: CurrencyCode;
description: string;
facetIds: ID[];
facetValueIds: ID[];
collectionIds: ID[];
collectionSlugs: string[];
channelIds: ID[];
enabled: boolean;
productEnabled: boolean;
priceMin: number;
priceMax: number;
priceWithTaxMin: number;
priceWithTaxMax: number;
[customMapping: string]: any;
};
export type SearchHit<T> = {
_id: string;
_index: string;
_score: number;
_source: T;
_type: string;
fields?: any;
};
export type SearchRequestBody = {
query?: any;
sort?: any[];
from?: number;
size?: number;
track_total_hits?: number | boolean;
aggs?: any;
collapse?: any;
_source?: boolean;
script_fields?: any;
};
export type SearchResponseBody<T = any> = {
hits: {
hits: Array<SearchHit<T>>;
total: {
relation: string;
value: number;
};
max_score: number;
};
timed_out: boolean;
took: number;
_shards: {
failed: number;
skipped: number;
successful: number;
total: number;
};
aggregations?: {
[key: string]: {
doc_count_error_upper_bound: 0;
sum_other_doc_count: 89;
buckets: Array<{ key: string; doc_count: number; total: { value: number } }>;
value: any;
};
};
};
export type BulkOperationType = 'index' | 'update' | 'delete';
export type BulkOperation = { [operation in BulkOperationType]?: { _id: string } };
export type BulkOperationDoc<T> = T | { doc: T; doc_as_upsert?: boolean };
export type BulkResponseResult = {
[operation in BulkOperationType]?: {
_index: string;
_type: string;
_id: string;
_version?: number;
result?: string;
_shards: {
total: number;
successful: number;
failed: number;
};
status: number;
_seq_no?: number;
_primary_term?: number;
error?: any;
};
};
export type BulkResponseBody = {
took: number;
errors: boolean;
items: BulkResponseResult[];
};
export interface ReindexMessageResponse {
total: number;
completed: number;
duration: number;
}
export type ReindexMessageData = {
ctx: SerializedRequestContext;
};
export type UpdateProductMessageData = {
ctx: SerializedRequestContext;
productId: ID;
};
export type UpdateVariantMessageData = {
ctx: SerializedRequestContext;
variantIds: ID[];
};
export interface UpdateVariantsByIdMessageData {
ctx: SerializedRequestContext;
ids: ID[];
}
export interface ProductChannelMessageData {
ctx: SerializedRequestContext;
productId: ID;
channelId: ID;
}
export type VariantChannelMessageData = {
ctx: SerializedRequestContext;
productVariantId: ID;
channelId: ID;
};
export interface UpdateAssetMessageData {
ctx: SerializedRequestContext;
asset: JsonCompatible<Required<Asset>>;
}
type Maybe<T> = T | undefined;
type NamedJobData<Type extends string, MessageData> = { type: Type } & MessageData;
export type ReindexJobData = NamedJobData<'reindex', ReindexMessageData>;
type UpdateProductJobData = NamedJobData<'update-product', UpdateProductMessageData>;
type UpdateVariantsJobData = NamedJobData<'update-variants', UpdateVariantMessageData>;
type DeleteProductJobData = NamedJobData<'delete-product', UpdateProductMessageData>;
type DeleteVariantJobData = NamedJobData<'delete-variant', UpdateVariantMessageData>;
type UpdateVariantsByIdJobData = NamedJobData<'update-variants-by-id', UpdateVariantsByIdMessageData>;
type UpdateAssetJobData = NamedJobData<'update-asset', UpdateAssetMessageData>;
type DeleteAssetJobData = NamedJobData<'delete-asset', UpdateAssetMessageData>;
type AssignProductToChannelJobData = NamedJobData<'assign-product-to-channel', ProductChannelMessageData>;
type RemoveProductFromChannelJobData = NamedJobData<'remove-product-from-channel', ProductChannelMessageData>;
type AssignVariantToChannelJobData = NamedJobData<'assign-variant-to-channel', VariantChannelMessageData>;
type RemoveVariantFromChannelJobData = NamedJobData<'remove-variant-from-channel', VariantChannelMessageData>;
export type UpdateIndexQueueJobData =
| ReindexJobData
| UpdateProductJobData
| UpdateVariantsJobData
| DeleteProductJobData
| DeleteVariantJobData
| UpdateVariantsByIdJobData
| UpdateAssetJobData
| DeleteAssetJobData
| AssignProductToChannelJobData
| RemoveProductFromChannelJobData
| AssignVariantToChannelJobData
| RemoveVariantFromChannelJobData;
export type GraphQlPrimitive = 'ID' | 'String' | 'Int' | 'Float' | 'Boolean';
export type PrimitiveTypeVariations<T extends GraphQlPrimitive> = T | `${T}!` | `[${T}!]` | `[${T}!]!`;
type GraphQlPermittedReturnType = PrimitiveTypeVariations<GraphQlPrimitive>;
type CustomMappingDefinition<Args extends any[], T extends GraphQlPermittedReturnType, R> = {
graphQlType: T;
public?: boolean;
valueFn: (...args: Args) => Promise<R> | R;
};
type TypeVariationMap<GqlType extends GraphQlPrimitive, TsType> = {
[Key in PrimitiveTypeVariations<GqlType>]: Key extends `[${string}!]!`
? TsType[]
: Key extends `[${string}!]`
? Maybe<TsType[]>
: Key extends `${string}!`
? TsType
: Maybe<TsType>;
};
type GraphQlTypeMap = TypeVariationMap<'ID', ID> &
TypeVariationMap<'String', string> &
TypeVariationMap<'Int', number> &
TypeVariationMap<'Float', number> &
TypeVariationMap<'Boolean', boolean>;
export type CustomMapping<Args extends any[]> = {
[Type in GraphQlPermittedReturnType]: CustomMappingDefinition<Args, Type, GraphQlTypeMap[Type]>;
}[GraphQlPermittedReturnType];
export type CustomScriptContext = 'product' | 'variant' | 'both';
type CustomScriptMappingDefinition<Args extends any[], T extends GraphQlPermittedReturnType> = {
graphQlType: T;
context: CustomScriptContext;
scriptFn: (...args: Args) => { script: string };
};
export type CustomScriptMapping<Args extends any[]> = {
[Type in GraphQlPermittedReturnType]: CustomScriptMappingDefinition<Args, Type>;
}[GraphQlPermittedReturnType];
|
import { gql } from 'graphql-tag';
import { DocumentNode } from 'graphql';
import { ElasticsearchOptions } from '../options';
export function generateSchemaExtensions(options: ElasticsearchOptions): DocumentNode {
const customMappingTypes = generateCustomMappingTypes(options);
const inputExtensions = Object.entries(options.extendSearchInputType || {});
const sortExtensions = options.extendSearchSortType || [];
const sortExtensionGql = `
extend input SearchResultSortParameter {
${sortExtensions.map(key => `${key}: SortOrder`).join('\n ')}
}`;
return gql`
extend type SearchResponse {
prices: SearchResponsePriceData!
}
extend type SearchResult {
inStock: Boolean
}
type SearchResponsePriceData {
range: PriceRange!
rangeWithTax: PriceRange!
buckets: [PriceRangeBucket!]!
bucketsWithTax: [PriceRangeBucket!]!
}
type PriceRangeBucket {
to: Int!
count: Int!
}
extend input SearchInput {
priceRange: PriceRangeInput
priceRangeWithTax: PriceRangeInput
inStock: Boolean
${inputExtensions.map(([name, type]) => `${name}: ${type}`).join('\n ')}
}
${sortExtensions.length > 0 ? sortExtensionGql : ''}
input PriceRangeInput {
min: Int!
max: Int!
}
${customMappingTypes ? customMappingTypes : ''}
`;
}
function generateCustomMappingTypes(options: ElasticsearchOptions): DocumentNode | undefined {
const productMappings = Object.entries(options.customProductMappings || {}).filter(
([, value]) => value.public ?? true,
);
const variantMappings = Object.entries(options.customProductVariantMappings || {}).filter(
([, value]) => value.public ?? true,
);
const searchInputTypeExtensions = Object.entries(options.extendSearchInputType || {});
const scriptProductFields = Object.entries(options.searchConfig?.scriptFields || {}).filter(
([, scriptField]) => scriptField.context !== 'variant',
);
const scriptVariantFields = Object.entries(options.searchConfig?.scriptFields || {}).filter(
([, scriptField]) => scriptField.context !== 'product',
);
let sdl = '';
if (scriptProductFields.length || scriptVariantFields.length) {
if (scriptProductFields.length) {
sdl += `
type CustomProductScriptFields {
${scriptProductFields.map(([name, def]) => `${name}: ${def.graphQlType}`).join('\n')}
}
`;
}
if (scriptVariantFields.length) {
sdl += `
type CustomProductVariantScriptFields {
${scriptVariantFields.map(([name, def]) => `${name}: ${def.graphQlType}`).join('\n')}
}
`;
}
if (scriptProductFields.length && scriptVariantFields.length) {
sdl += `
union CustomScriptFields = CustomProductScriptFields | CustomProductVariantScriptFields
extend type SearchResult {
customScriptFields: CustomScriptFields!
}
`;
} else if (scriptProductFields.length) {
sdl += `
extend type SearchResult {
customScriptFields: CustomProductScriptFields!
}
`;
} else if (scriptVariantFields.length) {
sdl += `
extend type SearchResult {
customScriptFields: CustomProductVariantScriptFields!
}
`;
}
}
if (productMappings.length || variantMappings.length) {
if (productMappings.length) {
sdl += `
type CustomProductMappings {
${productMappings.map(([name, def]) => `${name}: ${def.graphQlType}`).join('\n')}
}
`;
}
if (variantMappings.length) {
sdl += `
type CustomProductVariantMappings {
${variantMappings.map(([name, def]) => `${name}: ${def.graphQlType}`).join('\n')}
}
`;
}
if (productMappings.length && variantMappings.length) {
sdl += `
union CustomMappings = CustomProductMappings | CustomProductVariantMappings
extend type SearchResult {
customMappings: CustomMappings! @deprecated(reason: "Use customProductMappings or customProductVariantMappings")
customProductMappings: CustomProductMappings!
customProductVariantMappings: CustomProductVariantMappings!
}
`;
} else if (productMappings.length) {
sdl += `
extend type SearchResult {
customMappings: CustomProductMappings! @deprecated(reason: "Use customProductMappings or customProductVariantMappings")
customProductMappings: CustomProductMappings!
}
`;
} else if (variantMappings.length) {
sdl += `
extend type SearchResult {
customMappings: CustomProductVariantMappings! @deprecated(reason: "Use customProductMappings or customProductVariantMappings")
customProductVariantMappings: CustomProductVariantMappings!
}
`;
}
}
return sdl.length
? gql`
${sdl}
`
: undefined;
}
|
import { Inject } from '@nestjs/common';
import { ResolveField, Resolver } from '@nestjs/graphql';
import { DeepRequired } from '@vendure/common/lib/shared-types';
import { ELASTIC_SEARCH_OPTIONS } from '../constants';
import { ElasticsearchOptions } from '../options';
/**
* This resolver is only required if both customProductMappings and customProductVariantMappings are
* defined, since this particular configuration will result in a union type for the
* `SearchResult.customMappings` GraphQL field.
*/
@Resolver('CustomMappings')
export class CustomMappingsResolver {
constructor(@Inject(ELASTIC_SEARCH_OPTIONS) private options: DeepRequired<ElasticsearchOptions>) {}
@ResolveField()
__resolveType(value: any): string {
const productPropertyNames = Object.keys(this.options.customProductMappings);
return Object.keys(value).every(k => productPropertyNames.includes(k))
? 'CustomProductMappings'
: 'CustomProductVariantMappings';
}
}
|
import { Inject } from '@nestjs/common';
import { ResolveField, Resolver } from '@nestjs/graphql';
import { DeepRequired } from '@vendure/common/lib/shared-types';
import { ELASTIC_SEARCH_OPTIONS } from '../constants';
import { ElasticsearchOptions } from '../options';
/**
* This resolver is only required if scriptFields are defined for both products and product variants.
* This particular configuration will result in a union type for the
* `SearchResult.customScriptFields` GraphQL field.
*/
@Resolver('CustomScriptFields')
export class CustomScriptFieldsResolver {
constructor(@Inject(ELASTIC_SEARCH_OPTIONS) private options: DeepRequired<ElasticsearchOptions>) {}
@ResolveField()
__resolveType(value: any): string {
const productScriptFields = Object.entries(this.options.searchConfig?.scriptFields || {})
.filter(([, scriptField]) => scriptField.context !== 'variant')
.map(([k]) => k);
return Object.keys(value).every(k => productScriptFields.includes(k))
? 'CustomProductScriptFields'
: 'CustomProductVariantScriptFields';
}
}
|
import { Args, Mutation, Parent, Query, ResolveField, Resolver } from '@nestjs/graphql';
import {
Job as GraphQLJob,
Permission,
QuerySearchArgs,
SearchResponse,
} from '@vendure/common/lib/generated-types';
import { Omit } from '@vendure/common/lib/omit';
import {
Allow,
Collection,
Ctx,
FacetValue,
RequestContext,
SearchJobBufferService,
SearchResolver,
} from '@vendure/core';
import { ElasticsearchService } from '../elasticsearch.service';
import { ElasticSearchInput, SearchPriceData } from '../types';
@Resolver('SearchResponse')
export class ShopElasticSearchResolver implements Pick<SearchResolver, 'search'> {
constructor(private elasticsearchService: ElasticsearchService) {}
@Query()
@Allow(Permission.Public)
async search(
@Ctx() ctx: RequestContext,
@Args() args: QuerySearchArgs,
): Promise<Omit<SearchResponse, 'facetValues' | 'collections'>> {
const result = await this.elasticsearchService.search(ctx, args.input, true);
// ensure the facetValues property resolver has access to the input args
(result as any).input = args.input;
return result;
}
@ResolveField()
async prices(
@Ctx() ctx: RequestContext,
@Parent() parent: { input: ElasticSearchInput },
): Promise<SearchPriceData> {
return this.elasticsearchService.priceRange(ctx, parent.input);
}
}
@Resolver('SearchResponse')
export class AdminElasticSearchResolver implements Pick<SearchResolver, 'search' | 'reindex'> {
constructor(
private elasticsearchService: ElasticsearchService,
private searchJobBufferService: SearchJobBufferService,
) {}
@Query()
@Allow(Permission.ReadCatalog, Permission.ReadProduct)
async search(
@Ctx() ctx: RequestContext,
@Args() args: QuerySearchArgs,
): Promise<Omit<SearchResponse, 'facetValues' | 'collections'>> {
const result = await this.elasticsearchService.search(ctx, args.input, false);
// ensure the facetValues property resolver has access to the input args
(result as any).input = args.input;
return result;
}
@Mutation()
@Allow(Permission.UpdateCatalog, Permission.UpdateProduct)
async reindex(@Ctx() ctx: RequestContext): Promise<GraphQLJob> {
return this.elasticsearchService.reindex(ctx) as unknown as GraphQLJob;
}
@Query()
@Allow(Permission.ReadCatalog, Permission.ReadProduct)
async pendingSearchIndexUpdates(...args: any[]): Promise<any> {
return this.searchJobBufferService.getPendingSearchUpdates();
}
@Mutation()
@Allow(Permission.UpdateCatalog, Permission.UpdateProduct)
async runPendingSearchIndexUpdates(...args: any[]): Promise<any> {
// Intentionally not awaiting this method call
void this.searchJobBufferService.runPendingSearchUpdates();
return { success: true };
}
}
@Resolver('SearchResponse')
export class EntityElasticSearchResolver implements Pick<SearchResolver, 'facetValues' | 'collections'> {
constructor(private elasticsearchService: ElasticsearchService) {}
@ResolveField()
async facetValues(
@Ctx() ctx: RequestContext,
@Parent() parent: Omit<SearchResponse, 'facetValues' | 'collections'>,
): Promise<Array<{ facetValue: FacetValue; count: number }>> {
const facetValues = await this.elasticsearchService.facetValues(ctx, (parent as any).input, true);
return facetValues.filter(i => !i.facetValue.facet.isPrivate);
}
@ResolveField()
async collections(
@Ctx() ctx: RequestContext,
@Parent() parent: Omit<SearchResponse, 'facetValues' | 'collections'>,
): Promise<Array<{ collection: Collection; count: number }>> {
const collections = await this.elasticsearchService.collections(ctx, (parent as any).input, true);
return collections.filter(i => !i.collection.isPrivate);
}
}
|
import { Injectable, OnApplicationBootstrap } from '@nestjs/common';
import { assertNever } from '@vendure/common/lib/shared-utils';
import {
Asset,
ID,
Job,
JobQueue,
JobQueueService,
Logger,
Product,
ProductVariant,
RequestContext,
} from '@vendure/core';
import { Observable } from 'rxjs';
import { loggerCtx } from '../constants';
import { UpdateIndexQueueJobData } from '../types';
import { ElasticsearchIndexerController, ReindexMessageResponse } from './indexer.controller';
@Injectable()
export class ElasticsearchIndexService implements OnApplicationBootstrap {
private updateIndexQueue: JobQueue<UpdateIndexQueueJobData>;
constructor(
private jobService: JobQueueService,
private indexerController: ElasticsearchIndexerController,
) {}
async onApplicationBootstrap() {
this.updateIndexQueue = await this.jobService.createQueue({
name: 'update-search-index',
process: job => {
const data = job.data;
switch (data.type) {
case 'reindex':
Logger.verbose('sending ReindexMessage');
return this.jobWithProgress(job, this.indexerController.reindex(data));
case 'update-product':
return this.indexerController.updateProduct(data);
case 'update-variants':
return this.indexerController.updateVariants(data);
case 'delete-product':
return this.indexerController.deleteProduct(data);
case 'delete-variant':
return this.indexerController.deleteVariants(data);
case 'update-variants-by-id':
return this.jobWithProgress(job, this.indexerController.updateVariantsById(data));
case 'update-asset':
return this.indexerController.updateAsset(data);
case 'delete-asset':
return this.indexerController.deleteAsset(data);
case 'assign-product-to-channel':
return this.indexerController.assignProductToChannel(data);
case 'remove-product-from-channel':
return this.indexerController.removeProductFromChannel(data);
case 'assign-variant-to-channel':
return this.indexerController.assignVariantToChannel(data);
case 'remove-variant-from-channel':
return this.indexerController.removeVariantFromChannel(data);
default:
assertNever(data);
return Promise.resolve();
}
},
});
}
reindex(ctx: RequestContext) {
return this.updateIndexQueue.add({ type: 'reindex', ctx: ctx.serialize() }, { ctx });
}
updateProduct(ctx: RequestContext, product: Product) {
return this.updateIndexQueue.add({
type: 'update-product',
ctx: ctx.serialize(),
productId: product.id,
},
{ ctx });
}
updateVariants(ctx: RequestContext, variants: ProductVariant[]) {
const variantIds = variants.map(v => v.id);
return this.updateIndexQueue.add({ type: 'update-variants', ctx: ctx.serialize(), variantIds }, { ctx });
}
deleteProduct(ctx: RequestContext, product: Product) {
return this.updateIndexQueue.add({
type: 'delete-product',
ctx: ctx.serialize(),
productId: product.id,
},
{ ctx });
}
deleteVariant(ctx: RequestContext, variants: ProductVariant[]) {
const variantIds = variants.map(v => v.id);
return this.updateIndexQueue.add({ type: 'delete-variant', ctx: ctx.serialize(), variantIds }, { ctx });
}
assignProductToChannel(ctx: RequestContext, product: Product, channelId: ID) {
return this.updateIndexQueue.add({
type: 'assign-product-to-channel',
ctx: ctx.serialize(),
productId: product.id,
channelId,
},
{ ctx });
}
removeProductFromChannel(ctx: RequestContext, product: Product, channelId: ID) {
return this.updateIndexQueue.add({
type: 'remove-product-from-channel',
ctx: ctx.serialize(),
productId: product.id,
channelId,
},
{ ctx });
}
assignVariantToChannel(ctx: RequestContext, productVariantId: ID, channelId: ID) {
return this.updateIndexQueue.add({
type: 'assign-variant-to-channel',
ctx: ctx.serialize(),
productVariantId,
channelId,
},
{ ctx });
}
removeVariantFromChannel(ctx: RequestContext, productVariantId: ID, channelId: ID) {
return this.updateIndexQueue.add({
type: 'remove-variant-from-channel',
ctx: ctx.serialize(),
productVariantId,
channelId,
},
{ ctx });
}
updateVariantsById(ctx: RequestContext, ids: ID[]) {
return this.updateIndexQueue.add({ type: 'update-variants-by-id', ctx: ctx.serialize(), ids }, { ctx });
}
updateAsset(ctx: RequestContext, asset: Asset) {
return this.updateIndexQueue.add({ type: 'update-asset', ctx: ctx.serialize(), asset: asset as any }, { ctx });
}
deleteAsset(ctx: RequestContext, asset: Asset) {
return this.updateIndexQueue.add({ type: 'delete-asset', ctx: ctx.serialize(), asset: asset as any }, { ctx });
}
private jobWithProgress(
job: Job<UpdateIndexQueueJobData>,
ob: Observable<ReindexMessageResponse>,
): Promise<any> {
return new Promise((resolve, reject) => {
let total: number | undefined;
let duration = 0;
let completed = 0;
ob.subscribe({
next: (response: ReindexMessageResponse) => {
if (!total) {
total = response.total;
}
duration = response.duration;
completed = response.completed;
const progress = total === 0 ? 100 : Math.ceil((completed / total) * 100);
job.setProgress(progress);
},
complete: () => {
resolve({
success: true,
indexedItemCount: total,
timeTaken: duration,
});
},
error: (err: any) => {
Logger.error(err.message || JSON.stringify(err), loggerCtx, err.stack);
reject(err);
},
});
});
}
}
|
import { Client } from '@elastic/elasticsearch';
import { Inject, Injectable, OnModuleDestroy, OnModuleInit } from '@nestjs/common';
import { ModuleRef } from '@nestjs/core';
import { unique } from '@vendure/common/lib/unique';
import {
Asset,
asyncObservable,
AsyncQueue,
Channel,
Collection,
ConfigService,
EntityRelationPaths,
FacetValue,
ID,
Injector,
InternalServerError,
LanguageCode,
Logger,
MutableRequestContext,
Product,
ProductPriceApplicator,
ProductVariant,
ProductVariantService,
RequestContext,
RequestContextCacheService,
TransactionalConnection,
Translatable,
Translation,
} from '@vendure/core';
import { Observable } from 'rxjs';
import { In, IsNull } from 'typeorm';
import { ELASTIC_SEARCH_OPTIONS, VARIANT_INDEX_NAME, loggerCtx } from '../constants';
import { ElasticsearchOptions } from '../options';
import {
BulkOperation,
BulkOperationDoc,
BulkResponseBody,
ProductChannelMessageData,
ProductIndexItem,
ReindexMessageData,
UpdateAssetMessageData,
UpdateProductMessageData,
UpdateVariantMessageData,
UpdateVariantsByIdMessageData,
VariantChannelMessageData,
VariantIndexItem,
} from '../types';
import { createIndices, getClient, getIndexNameByAlias } from './indexing-utils';
export const defaultProductRelations: Array<EntityRelationPaths<Product>> = [
'featuredAsset',
'facetValues',
'facetValues.facet',
'channels',
'channels.defaultTaxZone',
];
export const defaultVariantRelations: Array<EntityRelationPaths<ProductVariant>> = [
'featuredAsset',
'facetValues',
'facetValues.facet',
'collections',
'taxCategory',
'channels',
'channels.defaultTaxZone',
];
export interface ReindexMessageResponse {
total: number;
completed: number;
duration: number;
}
type BulkVariantOperation = {
index: typeof VARIANT_INDEX_NAME;
operation: BulkOperation | BulkOperationDoc<VariantIndexItem>;
};
@Injectable()
export class ElasticsearchIndexerController implements OnModuleInit, OnModuleDestroy {
private client: Client;
private asyncQueue = new AsyncQueue('elasticsearch-indexer', 5);
private productRelations: Array<EntityRelationPaths<Product>>;
private variantRelations: Array<EntityRelationPaths<ProductVariant>>;
private injector: Injector;
constructor(
private connection: TransactionalConnection,
@Inject(ELASTIC_SEARCH_OPTIONS) private options: Required<ElasticsearchOptions>,
private productPriceApplicator: ProductPriceApplicator,
private configService: ConfigService,
private productVariantService: ProductVariantService,
private requestContextCache: RequestContextCacheService,
private moduleRef: ModuleRef,
) {}
onModuleInit(): any {
this.client = getClient(this.options);
this.productRelations = this.getReindexRelations(
defaultProductRelations,
this.options.hydrateProductRelations,
);
this.variantRelations = this.getReindexRelations(
defaultVariantRelations,
this.options.hydrateProductVariantRelations,
);
this.injector = new Injector(this.moduleRef);
}
onModuleDestroy(): any {
return this.client.close();
}
/**
* Updates the search index only for the affected product.
*/
async updateProduct({ ctx: rawContext, productId }: UpdateProductMessageData): Promise<boolean> {
const ctx = MutableRequestContext.deserialize(rawContext);
await this.updateProductsInternal(ctx, [productId]);
return true;
}
/**
* Updates the search index only for the affected product.
*/
async deleteProduct({ ctx: rawContext, productId }: UpdateProductMessageData): Promise<boolean> {
await this.deleteProductOperations(RequestContext.deserialize(rawContext), productId);
return true;
}
/**
* Updates the search index only for the affected product.
*/
async assignProductToChannel({
ctx: rawContext,
productId,
channelId,
}: ProductChannelMessageData): Promise<boolean> {
const ctx = MutableRequestContext.deserialize(rawContext);
await this.updateProductsInternal(ctx, [productId]);
return true;
}
/**
* Updates the search index only for the affected product.
*/
async removeProductFromChannel({
ctx: rawContext,
productId,
channelId,
}: ProductChannelMessageData): Promise<boolean> {
const ctx = MutableRequestContext.deserialize(rawContext);
await this.updateProductsInternal(ctx, [productId]);
return true;
}
async assignVariantToChannel({
ctx: rawContext,
productVariantId,
channelId,
}: VariantChannelMessageData): Promise<boolean> {
const productIds = await this.getProductIdsByVariantIds([productVariantId]);
const ctx = MutableRequestContext.deserialize(rawContext);
await this.updateProductsInternal(ctx, productIds);
return true;
}
async removeVariantFromChannel({
ctx: rawContext,
productVariantId,
channelId,
}: VariantChannelMessageData): Promise<boolean> {
const productIds = await this.getProductIdsByVariantIds([productVariantId]);
const ctx = MutableRequestContext.deserialize(rawContext);
await this.updateProductsInternal(ctx, productIds);
return true;
}
/**
* Updates the search index only for the affected entities.
*/
async updateVariants({ ctx: rawContext, variantIds }: UpdateVariantMessageData): Promise<boolean> {
const ctx = MutableRequestContext.deserialize(rawContext);
return this.asyncQueue.push(async () => {
const productIds = await this.getProductIdsByVariantIds(variantIds);
await this.updateProductsInternal(ctx, productIds);
return true;
});
}
async deleteVariants({ ctx: rawContext, variantIds }: UpdateVariantMessageData): Promise<boolean> {
const ctx = MutableRequestContext.deserialize(rawContext);
const productIds = await this.getProductIdsByVariantIds(variantIds);
for (const productId of productIds) {
await this.updateProductsInternal(ctx, [productId]);
}
return true;
}
updateVariantsById({
ctx: rawContext,
ids,
}: UpdateVariantsByIdMessageData): Observable<ReindexMessageResponse> {
const ctx = MutableRequestContext.deserialize(rawContext);
return asyncObservable(async observer => {
return this.asyncQueue.push(async () => {
const timeStart = Date.now();
const productIds = await this.getProductIdsByVariantIds(ids);
if (productIds.length) {
let finishedProductsCount = 0;
for (const productId of productIds) {
await this.updateProductsInternal(ctx, [productId]);
finishedProductsCount++;
observer.next({
total: productIds.length,
completed: Math.min(finishedProductsCount, productIds.length),
duration: +new Date() - timeStart,
});
}
}
Logger.verbose('Completed updating variants', loggerCtx);
return {
total: productIds.length,
completed: productIds.length,
duration: +new Date() - timeStart,
};
});
});
}
reindex({ ctx: rawContext }: ReindexMessageData): Observable<ReindexMessageResponse> {
return asyncObservable(async observer => {
return this.asyncQueue.push(async () => {
const timeStart = Date.now();
const ctx = MutableRequestContext.deserialize(rawContext);
const reindexTempName = new Date().getTime();
const variantIndexName = `${this.options.indexPrefix}${VARIANT_INDEX_NAME}`;
const variantIndexNameForReindex = `${VARIANT_INDEX_NAME}-reindex-${reindexTempName}`;
const reindexVariantAliasName = `${this.options.indexPrefix}${variantIndexNameForReindex}`;
try {
await createIndices(
this.client,
this.options.indexPrefix,
this.options.indexSettings,
this.options.indexMappingProperties,
true,
`-reindex-${reindexTempName}`,
);
} catch (e: any) {
Logger.error('Could not recreate indices.', loggerCtx);
Logger.error(JSON.stringify(e), loggerCtx);
throw e;
}
const totalProductIds = await this.connection.rawConnection
.getRepository(Product)
.createQueryBuilder('product')
.where('product.deletedAt IS NULL')
.getCount();
Logger.verbose(`Will reindex ${totalProductIds} products`, loggerCtx);
let productIds = [];
let skip = 0;
let finishedProductsCount = 0;
do {
productIds = await this.connection.rawConnection
.getRepository(Product)
.createQueryBuilder('product')
.select('product.id')
.where('product.deletedAt IS NULL')
.skip(skip)
.take(this.options.reindexProductsChunkSize)
.getMany();
for (const { id: productId } of productIds) {
await this.updateProductsOperationsOnly(ctx, productId, variantIndexNameForReindex);
finishedProductsCount++;
observer.next({
total: totalProductIds,
completed: Math.min(finishedProductsCount, totalProductIds),
duration: +new Date() - timeStart,
});
}
skip += this.options.reindexProductsChunkSize;
Logger.verbose(`Done ${finishedProductsCount} / ${totalProductIds} products`);
} while (productIds.length >= this.options.reindexProductsChunkSize);
// Switch the index to the new reindexed one
await this.switchAlias(reindexVariantAliasName, variantIndexName);
Logger.verbose('Completed reindexing!', loggerCtx);
return {
total: totalProductIds,
completed: totalProductIds,
duration: +new Date() - timeStart,
};
});
});
}
async executeBulkOperationsByChunks(
chunkSize: number,
operations: BulkVariantOperation[],
index = VARIANT_INDEX_NAME,
): Promise<void> {
Logger.verbose(
`Will execute ${operations.length} bulk update operations with index ${index}`,
loggerCtx,
);
let i;
let j;
let processedOperation = 0;
for (i = 0, j = operations.length; i < j; i += chunkSize) {
const operationsChunks = operations.slice(i, i + chunkSize);
await this.executeBulkOperations(operationsChunks, index);
processedOperation += operationsChunks.length;
Logger.verbose(
`Executing operation chunks ${processedOperation}/${operations.length}`,
loggerCtx,
);
}
}
async updateAsset(data: UpdateAssetMessageData): Promise<boolean> {
const result = await this.updateAssetFocalPointForIndex(VARIANT_INDEX_NAME, data.asset);
await this.client.indices.refresh({
index: [this.options.indexPrefix + VARIANT_INDEX_NAME],
});
return result;
}
async deleteAsset(data: UpdateAssetMessageData): Promise<boolean> {
const result = await this.deleteAssetForIndex(VARIANT_INDEX_NAME, data.asset);
await this.client.indices.refresh({
index: [this.options.indexPrefix + VARIANT_INDEX_NAME],
});
return result;
}
private async updateAssetFocalPointForIndex(indexName: string, asset: Asset): Promise<boolean> {
const focalPoint = asset.focalPoint || null;
const params = { focalPoint };
return this.updateAssetForIndex(
indexName,
asset,
{
source: 'ctx._source.productPreviewFocalPoint = params.focalPoint',
params,
},
{
source: 'ctx._source.productVariantPreviewFocalPoint = params.focalPoint',
params,
},
);
}
private async deleteAssetForIndex(indexName: string, asset: Asset): Promise<boolean> {
return this.updateAssetForIndex(
indexName,
asset,
{ source: 'ctx._source.productAssetId = null' },
{ source: 'ctx._source.productVariantAssetId = null' },
);
}
private async updateAssetForIndex(
indexName: string,
asset: Asset,
updateProductScript: { source: string; params?: any },
updateVariantScript: { source: string; params?: any },
): Promise<boolean> {
const result1 = await this.client.update_by_query({
index: this.options.indexPrefix + indexName,
body: {
script: updateProductScript,
query: {
term: {
productAssetId: asset.id,
},
},
},
});
for (const failure of result1.body.failures) {
Logger.error(`${failure.cause.type as string}: ${failure.cause.reason as string}`, loggerCtx);
}
const result2 = await this.client.update_by_query({
index: this.options.indexPrefix + indexName,
body: {
script: updateVariantScript,
query: {
term: {
productVariantAssetId: asset.id,
},
},
},
});
for (const failure of result1.body.failures) {
Logger.error(`${failure.cause.type as string}: ${failure.cause.reason as string}`, loggerCtx);
}
return result1.body.failures.length === 0 && result2.body.failures === 0;
}
private async updateProductsInternal(ctx: MutableRequestContext, productIds: ID[]) {
await this.updateProductsOperations(ctx, productIds);
}
private async switchAlias(reindexVariantAliasName: string, variantIndexName: string): Promise<void> {
try {
const reindexVariantAliasExist = await this.client.indices.existsAlias({
name: reindexVariantAliasName,
});
if (reindexVariantAliasExist) {
const reindexVariantIndexName = await getIndexNameByAlias(
this.client,
reindexVariantAliasName,
);
const originalVariantAliasExist = await this.client.indices.existsAlias({
name: variantIndexName,
});
const originalVariantIndexExist = await this.client.indices.exists({
index: variantIndexName,
});
const originalVariantIndexName = await getIndexNameByAlias(this.client, variantIndexName);
const actions = [
{
remove: {
index: reindexVariantIndexName,
alias: reindexVariantAliasName,
},
},
{
add: {
index: reindexVariantIndexName,
alias: variantIndexName,
},
},
];
if (originalVariantAliasExist.body) {
actions.push({
remove: {
index: originalVariantIndexName,
alias: variantIndexName,
},
});
} else if (originalVariantIndexExist.body) {
await this.client.indices.delete({
index: [variantIndexName],
});
}
await this.client.indices.updateAliases({
body: {
actions,
},
});
if (originalVariantAliasExist.body) {
await this.client.indices.delete({
index: [originalVariantIndexName],
});
}
}
} catch (e: any) {
Logger.error('Could not switch indexes');
} finally {
const reindexVariantAliasExist = await this.client.indices.existsAlias({
name: reindexVariantAliasName,
});
if (reindexVariantAliasExist.body) {
const reindexVariantAliasResult = await this.client.indices.getAlias({
name: reindexVariantAliasName,
});
const reindexVariantIndexName = Object.keys(reindexVariantAliasResult.body)[0];
await this.client.indices.delete({
index: [reindexVariantIndexName],
});
}
}
}
private async updateProductsOperationsOnly(
ctx: MutableRequestContext,
productId: ID,
index = VARIANT_INDEX_NAME,
): Promise<void> {
let operations: BulkVariantOperation[] = [];
let product: Product | undefined;
try {
product = await this.connection
.getRepository(ctx, Product)
.find({
where: { id: productId, deletedAt: IsNull() },
relations: this.productRelations,
})
.then(result => result[0] ?? undefined);
} catch (e: any) {
Logger.error(e.message, loggerCtx, e.stack);
throw e;
}
if (!product) {
return;
}
let updatedProductVariants: ProductVariant[] = [];
try {
updatedProductVariants = await this.connection.rawConnection.getRepository(ProductVariant).find({
relations: this.variantRelations,
where: {
productId,
deletedAt: IsNull(),
},
order: {
id: 'ASC',
},
});
} catch (e: any) {
Logger.error(e.message, loggerCtx, e.stack);
}
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
updatedProductVariants.forEach(variant => (variant.product = product!));
if (!product.enabled) {
updatedProductVariants.forEach(v => (v.enabled = false));
}
Logger.debug(`Updating Product (${productId})`, loggerCtx);
const languageVariants: LanguageCode[] = [];
languageVariants.push(...product.translations.map(t => t.languageCode));
for (const variant of updatedProductVariants)
languageVariants.push(...variant.translations.map(t => t.languageCode));
const uniqueLanguageVariants = unique(languageVariants);
for (const channel of product.channels) {
ctx.setChannel(channel);
const variantsInChannel = updatedProductVariants.filter(v =>
v.channels.map(c => c.id).includes(ctx.channelId),
);
for (const variant of variantsInChannel)
await this.productPriceApplicator.applyChannelPriceAndTax(variant, ctx);
for (const languageCode of uniqueLanguageVariants) {
if (variantsInChannel.length) {
for (const variant of variantsInChannel) {
operations.push(
{
index: VARIANT_INDEX_NAME,
operation: {
update: {
_id: ElasticsearchIndexerController.getId(
variant.id,
ctx.channelId,
languageCode,
),
},
},
},
{
index: VARIANT_INDEX_NAME,
operation: {
doc: await this.createVariantIndexItem(
variant,
variantsInChannel,
ctx,
languageCode,
),
doc_as_upsert: true,
},
},
);
if (operations.length >= this.options.reindexBulkOperationSizeLimit) {
// Because we can have a huge amount of variant for 1 product, we also chunk update operations
await this.executeBulkOperationsByChunks(
this.options.reindexBulkOperationSizeLimit,
operations,
index,
);
operations = [];
}
}
} else {
operations.push(
{
index: VARIANT_INDEX_NAME,
operation: {
update: {
_id: ElasticsearchIndexerController.getId(
-product.id,
ctx.channelId,
languageCode,
),
},
},
},
{
index: VARIANT_INDEX_NAME,
operation: {
doc: await this.createSyntheticProductIndexItem(product, ctx, languageCode),
doc_as_upsert: true,
},
},
);
}
if (operations.length >= this.options.reindexBulkOperationSizeLimit) {
// Because we can have a huge amount of variant for 1 product, we also chunk update operations
await this.executeBulkOperationsByChunks(
this.options.reindexBulkOperationSizeLimit,
operations,
index,
);
operations = [];
}
}
}
// Because we can have a huge amount of variant for 1 product, we also chunk update operations
await this.executeBulkOperationsByChunks(
this.options.reindexBulkOperationSizeLimit,
operations,
index,
);
return;
}
private async updateProductsOperations(ctx: MutableRequestContext, productIds: ID[]): Promise<void> {
Logger.debug(`Updating ${productIds.length} Products`, loggerCtx);
for (const productId of productIds) {
await this.deleteProductOperations(ctx, productId);
await this.updateProductsOperationsOnly(ctx, productId);
}
return;
}
/**
* Takes the default relations, and combines them with any extra relations specified in the
* `hydrateProductRelations` and `hydrateProductVariantRelations`. This method also ensures
* that the relation values are unique and that paths are fully expanded.
*
* This means that if a `hydrateProductRelations` value of `['assets.asset']` is specified,
* this method will also add `['assets']` to the relations array, otherwise TypeORM would
* throw an error trying to join a 2nd-level deep relation without the first level also
* being joined.
*/
private getReindexRelations<T extends Product | ProductVariant>(
defaultRelations: Array<EntityRelationPaths<T>>,
hydratedRelations: Array<EntityRelationPaths<T>>,
): Array<EntityRelationPaths<T>> {
const uniqueRelations = unique([...defaultRelations, ...hydratedRelations]);
for (const relation of hydratedRelations) {
let path = relation.split('.');
if (path[0] === 'customFields') {
if (path.length > 2) {
throw new InternalServerError(
[
'hydrateProductRelations / hydrateProductVariantRelations does not currently support nested custom field relations',
`Received: "${relation}"`,
].join('\n'),
);
}
path = [path.join('.')];
}
const pathToPart: string[] = [];
for (const part of path) {
pathToPart.push(part);
const joinedPath = pathToPart.join('.') as EntityRelationPaths<T>;
if (!uniqueRelations.includes(joinedPath)) {
uniqueRelations.push(joinedPath);
}
}
}
return uniqueRelations;
}
private async deleteProductOperations(
ctx: RequestContext,
productId: ID,
index: string = VARIANT_INDEX_NAME,
): Promise<void> {
const channels = await this.requestContextCache.get(ctx, 'elastic-index-all-channels', () =>
this.connection.rawConnection
.getRepository(Channel)
.createQueryBuilder('channel')
.select('channel.id')
.getMany(),
);
const product = await this.connection
.getRepository(ctx, Product)
.createQueryBuilder('product')
.select([
'product.id',
'productVariant.id',
'productTranslations.languageCode',
'productVariantTranslations.languageCode',
])
.leftJoin('product.translations', 'productTranslations')
.leftJoin('product.variants', 'productVariant')
.leftJoin('productVariant.translations', 'productVariantTranslations')
.leftJoin('product.channels', 'channel')
.where('product.id = :productId', { productId })
.andWhere('channel.id = :channelId', { channelId: ctx.channelId })
.getOne();
if (!product) return;
Logger.debug(`Deleting 1 Product (id: ${productId})`, loggerCtx);
let operations: BulkVariantOperation[] = [];
const languageVariants: LanguageCode[] = [];
languageVariants.push(...product.translations.map(t => t.languageCode));
for (const variant of product.variants)
languageVariants.push(...variant.translations.map(t => t.languageCode));
const uniqueLanguageVariants = unique(languageVariants);
for (const { id: channelId } of channels) {
for (const languageCode of uniqueLanguageVariants) {
operations.push({
index: VARIANT_INDEX_NAME,
operation: {
delete: {
_id: ElasticsearchIndexerController.getId(-product.id, channelId, languageCode),
},
},
});
if (operations.length >= this.options.reindexBulkOperationSizeLimit) {
// Because we can have a huge amount of variant for 1 product, we also chunk update operations
await this.executeBulkOperationsByChunks(
this.options.reindexBulkOperationSizeLimit,
operations,
index,
);
operations = [];
}
}
}
// Because we can have a huge amount of variant for 1 product, we also chunk update operations
await this.executeBulkOperationsByChunks(
this.options.reindexBulkOperationSizeLimit,
operations,
index,
);
await this.deleteVariantsInternalOperations(
product.variants,
channels.map(c => c.id),
uniqueLanguageVariants,
index,
);
return;
}
private async deleteVariantsInternalOperations(
variants: ProductVariant[],
channelIds: ID[],
languageVariants: LanguageCode[],
index = VARIANT_INDEX_NAME,
): Promise<void> {
Logger.debug(`Deleting ${variants.length} ProductVariants`, loggerCtx);
let operations: BulkVariantOperation[] = [];
for (const variant of variants) {
for (const channelId of channelIds) {
for (const languageCode of languageVariants) {
operations.push({
index: VARIANT_INDEX_NAME,
operation: {
delete: {
_id: ElasticsearchIndexerController.getId(
variant.id,
channelId,
languageCode,
),
},
},
});
if (operations.length >= this.options.reindexBulkOperationSizeLimit) {
// Because we can have a huge amount of variant for 1 product, we also chunk update operations
await this.executeBulkOperationsByChunks(
this.options.reindexBulkOperationSizeLimit,
operations,
index,
);
operations = [];
}
}
}
}
// Because we can have a huge amount of variant for 1 product, we also chunk update operations
await this.executeBulkOperationsByChunks(
this.options.reindexBulkOperationSizeLimit,
operations,
index,
);
return;
}
private async getProductIdsByVariantIds(variantIds: ID[]): Promise<ID[]> {
const variants = await this.connection.getRepository(ProductVariant).find({
where: { id: In(variantIds) },
relations: ['product'],
loadEagerRelations: false,
});
return unique(variants.map(v => v.product.id));
}
private async executeBulkOperations(operations: BulkVariantOperation[], indexName = VARIANT_INDEX_NAME) {
const variantOperations: Array<BulkOperation | BulkOperationDoc<VariantIndexItem>> = [];
for (const operation of operations) {
variantOperations.push(operation.operation);
}
return Promise.all([this.runBulkOperationsOnIndex(indexName, variantOperations)]);
}
private async runBulkOperationsOnIndex(
indexName: string,
operations: Array<BulkOperation | BulkOperationDoc<VariantIndexItem | ProductIndexItem>>,
) {
if (operations.length === 0) {
return;
}
try {
const fullIndexName = this.options.indexPrefix + indexName;
const { body }: { body: BulkResponseBody } = await this.client.bulk({
refresh: true,
index: fullIndexName,
body: operations,
});
if (body.errors) {
Logger.error(
`Some errors occurred running bulk operations on ${fullIndexName}! Set logger to "debug" to print all errors.`,
loggerCtx,
);
body.items.forEach(item => {
if (item.index) {
Logger.debug(JSON.stringify(item.index.error, null, 2), loggerCtx);
}
if (item.update) {
Logger.debug(JSON.stringify(item.update.error, null, 2), loggerCtx);
}
if (item.delete) {
Logger.debug(JSON.stringify(item.delete.error, null, 2), loggerCtx);
}
});
} else {
Logger.debug(
`Executed ${body.items.length} bulk operations on index [${fullIndexName}]`,
loggerCtx,
);
}
return body;
} catch (e: any) {
Logger.error(`Error when attempting to run bulk operations [${JSON.stringify(e)}]`, loggerCtx);
Logger.error('Error details: ' + JSON.stringify(e.body?.error, null, 2), loggerCtx);
}
}
private async createVariantIndexItem(
v: ProductVariant,
variants: ProductVariant[],
ctx: RequestContext,
languageCode: LanguageCode,
): Promise<VariantIndexItem> {
try {
const productAsset = v.product.featuredAsset;
const variantAsset = v.featuredAsset;
const productTranslation = this.getTranslation(v.product, languageCode);
const variantTranslation = this.getTranslation(v, languageCode);
const collectionTranslations = v.collections.map(c => this.getTranslation(c, languageCode));
const productCollectionTranslations = variants.reduce(
(translations, variant) => [
...translations,
...variant.collections.map(c => this.getTranslation(c, languageCode)),
],
[] as Array<Translation<Collection>>,
);
const prices = variants.map(variant => variant.price);
const pricesWithTax = variants.map(variant => variant.priceWithTax);
const item: VariantIndexItem = {
channelId: ctx.channelId,
languageCode,
productVariantId: v.id,
sku: v.sku,
slug: productTranslation.slug,
productId: v.product.id,
productName: productTranslation.name,
productAssetId: productAsset ? productAsset.id : undefined,
productPreview: productAsset ? productAsset.preview : '',
productPreviewFocalPoint: productAsset ? productAsset.focalPoint || undefined : undefined,
productVariantName: variantTranslation.name,
productVariantAssetId: variantAsset ? variantAsset.id : undefined,
productVariantPreview: variantAsset ? variantAsset.preview : '',
productVariantPreviewFocalPoint: variantAsset
? variantAsset.focalPoint || undefined
: undefined,
price: v.price,
priceWithTax: v.priceWithTax,
currencyCode: v.currencyCode,
description: productTranslation.description,
facetIds: this.getFacetIds([v]),
channelIds: v.channels.map(c => c.id),
facetValueIds: this.getFacetValueIds([v]),
collectionIds: v.collections.map(c => c.id.toString()),
collectionSlugs: collectionTranslations.map(c => c.slug),
enabled: v.enabled && v.product.enabled,
productEnabled: variants.some(variant => variant.enabled) && v.product.enabled,
productPriceMin: Math.min(...prices),
productPriceMax: Math.max(...prices),
productPriceWithTaxMin: Math.min(...pricesWithTax),
productPriceWithTaxMax: Math.max(...pricesWithTax),
productFacetIds: this.getFacetIds(variants),
productFacetValueIds: this.getFacetValueIds(variants),
productCollectionIds: unique(
variants.reduce(
(ids, variant) => [...ids, ...variant.collections.map(c => c.id)],
[] as ID[],
),
),
productCollectionSlugs: unique(productCollectionTranslations.map(c => c.slug)),
productChannelIds: v.product.channels.map(c => c.id),
inStock: 0 < (await this.productVariantService.getSaleableStockLevel(ctx, v)),
productInStock: await this.getProductInStockValue(ctx, variants),
};
const variantCustomMappings = Object.entries(this.options.customProductVariantMappings);
for (const [name, def] of variantCustomMappings) {
item[`variant-${name}`] = await def.valueFn(v, languageCode, this.injector, ctx);
}
const productCustomMappings = Object.entries(this.options.customProductMappings);
for (const [name, def] of productCustomMappings) {
item[`product-${name}`] = await def.valueFn(v.product, variants, languageCode, this.injector, ctx);
}
return item;
} catch (err: any) {
Logger.error(err.toString());
throw Error('Error while reindexing!');
}
}
private async getProductInStockValue(ctx: RequestContext, variants: ProductVariant[]): Promise<boolean> {
return this.requestContextCache.get(
ctx,
`elastic-index-product-in-stock-${variants.map(v => v.id).join(',')}`,
async () => {
const stockLevels = await Promise.all(
variants.map(variant => this.productVariantService.getSaleableStockLevel(ctx, variant)),
);
return stockLevels.some(stockLevel => 0 < stockLevel);
},
);
}
/**
* If a Product has no variants, we create a synthetic variant for the purposes
* of making that product visible via the search query.
*/
private async createSyntheticProductIndexItem(
product: Product,
ctx: RequestContext,
languageCode: LanguageCode,
): Promise<VariantIndexItem> {
const productTranslation = this.getTranslation(product, languageCode);
const productAsset = product.featuredAsset;
const item: VariantIndexItem = {
channelId: ctx.channelId,
languageCode,
productVariantId: 0,
sku: '',
slug: productTranslation.slug,
productId: product.id,
productName: productTranslation.name,
productAssetId: productAsset ? productAsset.id : undefined,
productPreview: productAsset ? productAsset.preview : '',
productPreviewFocalPoint: productAsset ? productAsset.focalPoint || undefined : undefined,
productVariantName: productTranslation.name,
productVariantAssetId: undefined,
productVariantPreview: '',
productVariantPreviewFocalPoint: undefined,
price: 0,
priceWithTax: 0,
currencyCode: ctx.currencyCode,
description: productTranslation.description,
facetIds: product.facetValues?.map(fv => fv.facet.id.toString()) ?? [],
channelIds: [ctx.channelId],
facetValueIds: product.facetValues?.map(fv => fv.id.toString()) ?? [],
collectionIds: [],
collectionSlugs: [],
enabled: false,
productEnabled: false,
productPriceMin: 0,
productPriceMax: 0,
productPriceWithTaxMin: 0,
productPriceWithTaxMax: 0,
productFacetIds: product.facetValues?.map(fv => fv.facet.id.toString()) ?? [],
productFacetValueIds: product.facetValues?.map(fv => fv.id.toString()) ?? [],
productCollectionIds: [],
productCollectionSlugs: [],
productChannelIds: product.channels.map(c => c.id),
inStock: false,
productInStock: false,
};
const productCustomMappings = Object.entries(this.options.customProductMappings);
for (const [name, def] of productCustomMappings) {
item[`product-${name}`] = await def.valueFn(product, [], languageCode, this.injector, ctx);
}
return item;
}
private getTranslation<T extends Translatable>(
translatable: T,
languageCode: LanguageCode,
): Translation<T> {
return (translatable.translations.find(t => t.languageCode === languageCode) ||
translatable.translations.find(t => t.languageCode === this.configService.defaultLanguageCode) ||
translatable.translations[0]) as unknown as Translation<T>;
}
private getFacetIds(variants: ProductVariant[]): string[] {
const facetIds = (fv: FacetValue) => fv.facet.id.toString();
const variantFacetIds = variants.reduce(
(ids, v) => [...ids, ...v.facetValues.map(facetIds)],
[] as string[],
);
const productFacetIds = variants[0].product.facetValues.map(facetIds);
return unique([...variantFacetIds, ...productFacetIds]);
}
private getFacetValueIds(variants: ProductVariant[]): string[] {
const facetValueIds = (fv: FacetValue) => fv.id.toString();
const variantFacetValueIds = variants.reduce(
(ids, v) => [...ids, ...v.facetValues.map(facetValueIds)],
[] as string[],
);
const productFacetValueIds = variants[0].product.facetValues.map(facetValueIds);
return unique([...variantFacetValueIds, ...productFacetValueIds]);
}
private static getId(entityId: ID, channelId: ID, languageCode: LanguageCode): string {
return `${channelId.toString()}_${entityId.toString()}_${languageCode}`;
}
}
|
import { Client } from '@elastic/elasticsearch';
import { DeepRequired, ID, Logger } from '@vendure/core';
import { loggerCtx, VARIANT_INDEX_NAME } from '../constants';
import { ElasticsearchOptions } from '../options';
import { VariantIndexItem } from '../types';
export async function createIndices(
client: Client,
prefix: string,
indexSettings: object,
indexMappingProperties: object,
mapAlias = true,
aliasPostfix = '',
) {
const textWithKeyword = {
type: 'text',
fields: {
keyword: {
type: 'keyword',
ignore_above: 256,
},
},
};
const keyword = { type: 'keyword' };
const variantMappings: { [prop in keyof VariantIndexItem]: any } = {
sku: textWithKeyword,
slug: textWithKeyword,
productId: keyword,
channelId: keyword,
languageCode: keyword,
productName: textWithKeyword,
productVariantId: keyword,
productVariantName: textWithKeyword,
currencyCode: keyword,
description: textWithKeyword,
facetIds: keyword,
facetValueIds: keyword,
collectionIds: keyword,
collectionSlugs: keyword,
channelIds: keyword,
enabled: { type: 'boolean' },
productEnabled: { type: 'boolean' },
productAssetId: keyword,
productPreview: textWithKeyword,
productPreviewFocalPoint: { type: 'object' },
productVariantAssetId: keyword,
productVariantPreview: textWithKeyword,
productVariantPreviewFocalPoint: { type: 'object' },
productChannelIds: keyword,
productCollectionIds: keyword,
productCollectionSlugs: keyword,
productFacetIds: keyword,
productFacetValueIds: keyword,
productPriceMax: { type: 'long' },
productPriceMin: { type: 'long' },
productPriceWithTaxMax: { type: 'long' },
productPriceWithTaxMin: { type: 'long' },
price: { type: 'long' },
priceWithTax: { type: 'long' },
inStock: { type: 'boolean' },
productInStock: { type: 'boolean' },
...indexMappingProperties,
};
const unixtimestampPostfix = new Date().getTime();
const createIndex = async (mappings: { [prop in keyof any]: any }, index: string, alias: string) => {
if (mapAlias) {
await client.indices.create({
index,
body: {
mappings: {
properties: mappings,
},
settings: indexSettings,
},
});
await client.indices.putAlias({
index,
name: alias,
});
Logger.verbose(`Created index "${index}"`, loggerCtx);
} else {
await client.indices.create({
index: alias,
body: {
mappings: {
properties: mappings,
},
settings: indexSettings,
},
});
Logger.verbose(`Created index "${alias}"`, loggerCtx);
}
};
try {
const index = prefix + VARIANT_INDEX_NAME + `${unixtimestampPostfix}`;
const alias = prefix + VARIANT_INDEX_NAME + aliasPostfix;
await createIndex(variantMappings, index, alias);
} catch (e: any) {
Logger.error(JSON.stringify(e, null, 2), loggerCtx);
}
}
export async function deleteIndices(client: Client, prefix: string) {
try {
const index = await getIndexNameByAlias(client, prefix + VARIANT_INDEX_NAME);
await client.indices.delete({ index });
Logger.verbose(`Deleted index "${index}"`, loggerCtx);
} catch (e: any) {
Logger.error(e, loggerCtx);
}
}
export async function deleteByChannel(client: Client, prefix: string, channelId: ID) {
try {
const index = prefix + VARIANT_INDEX_NAME;
await client.deleteByQuery({
index,
body: {
query: {
match: { channelId },
},
},
});
Logger.verbose(`Deleted index "${index} for channel "${channelId}"`, loggerCtx);
} catch (e: any) {
Logger.error(e, loggerCtx);
}
}
export function getClient(
options: Required<ElasticsearchOptions> | DeepRequired<ElasticsearchOptions>,
): Client {
const { host, port } = options;
const node = options.clientOptions?.node ?? `${host}:${port}`;
return new Client({
node,
// `any` cast is there due to a strange error "Property '[Symbol.iterator]' is missing in type... URLSearchParams"
// which looks like possibly a TS/definitions bug.
...(options.clientOptions as any),
});
}
export async function getIndexNameByAlias(client: Client, aliasName: string) {
const aliasExist = await client.indices.existsAlias({ name: aliasName });
if (aliasExist.body) {
const alias = await client.indices.getAlias({
name: aliasName,
});
return Object.keys(alias.body)[0];
} else {
return aliasName;
}
}
|
export * from './src/handler/default-email-handlers';
export * from './src/sender/nodemailer-email-sender';
export * from './src/handler/event-handler';
export * from './src/event-listener';
export * from './src/generator/handlebars-mjml-generator';
export * from './src/generator/noop-email-generator';
export * from './src/plugin';
export * from './src/template-loader/template-loader';
export * from './src/template-loader/file-based-template-loader';
export * from './src/types';
export * from './src/email-send-event';
export * from './src/generator/email-generator';
export * from './src/sender/email-sender';
|
import { Logger } from '@vendure/core';
import { Readable, Stream } from 'stream';
import { format, Url } from 'url';
import { loggerCtx } from './constants';
import { EmailAttachment, SerializedAttachment } from './types';
export async function serializeAttachments(attachments: EmailAttachment[]): Promise<SerializedAttachment[]> {
const promises = attachments.map(async a => {
const stringPath = (path: string | Url) => (typeof path === 'string' ? path : format(path));
const content = a.content instanceof Stream ? await streamToBuffer(a.content) : a.content;
return {
filename: null,
cid: null,
encoding: null,
contentType: null,
contentTransferEncoding: null,
contentDisposition: null,
headers: null,
...a,
path: a.path ? stringPath(a.path) : null,
content: JSON.stringify(content),
};
});
return Promise.all(promises);
}
export function deserializeAttachments(serializedAttachments: SerializedAttachment[]): EmailAttachment[] {
return serializedAttachments.map(a => {
const content = parseContent(a.content);
if (content instanceof Buffer && 50 * 1024 <= content.length) {
Logger.warn(
`Email has a large 'content' attachment (${Math.round(
content.length / 1024,
)}k). Consider using the 'path' instead for improved performance.`,
loggerCtx,
);
}
return {
filename: nullToUndefined(a.filename),
cid: nullToUndefined(a.cid),
encoding: nullToUndefined(a.encoding),
contentType: nullToUndefined(a.contentType),
contentTransferEncoding: nullToUndefined(a.contentTransferEncoding),
contentDisposition: nullToUndefined(a.contentDisposition),
headers: nullToUndefined(a.headers),
path: nullToUndefined(a.path),
content,
};
});
}
function parseContent(content: string | null): string | Buffer | undefined {
try {
const parsedContent = content && JSON.parse(content);
if (typeof parsedContent === 'string') {
return parsedContent;
} else if (parsedContent.hasOwnProperty('data')) {
return Buffer.from(parsedContent.data);
}
} catch (e: any) {
// empty
}
}
function streamToBuffer(stream: Readable): Promise<Buffer> {
const chunks: Buffer[] = [];
return new Promise((resolve, reject) => {
stream.on('data', chunk => {
chunks.push(Buffer.from(chunk));
});
stream.on('error', err => reject(err));
stream.on('end', () => {
resolve(Buffer.concat(chunks));
});
});
}
function nullToUndefined<T>(input: T | null): T | undefined {
return input == null ? undefined : input;
}
|
import { Injector, RequestContext } from '@vendure/core';
import { EmailPluginDevModeOptions, EmailPluginOptions, EmailTransportOptions } from './types';
export function isDevModeOptions(
input: EmailPluginOptions | EmailPluginDevModeOptions,
): input is EmailPluginDevModeOptions {
return (input as EmailPluginDevModeOptions).devMode === true;
}
export async function resolveTransportSettings(
options: EmailPluginOptions,
injector: Injector,
ctx?: RequestContext
): Promise<EmailTransportOptions> {
if (typeof options.transport === 'function') {
return options.transport(injector, ctx);
} else {
return options.transport;
}
}
|
export const EMAIL_PLUGIN_OPTIONS = Symbol('EMAIL_PLUGIN_OPTIONS');
export const loggerCtx = 'EmailPlugin';
|
import { LanguageCode } from '@vendure/common/lib/generated-types';
import { Channel, RequestContext } from '@vendure/core';
import { Request, Router } from 'express';
import fs from 'fs-extra';
import path from 'path';
import { EmailEventHandler } from './handler/event-handler';
import { EmailPluginDevModeOptions, EventWithContext } from './types';
/**
* An email inbox application that serves the contents of the dev mode `outputPath` directory.
*/
export class DevMailbox {
private handleMockEventFn: (
handler: EmailEventHandler<string, any>,
event: EventWithContext,
) => void | undefined;
serve(options: EmailPluginDevModeOptions): Router {
const { outputPath, handlers } = options;
const server = Router();
server.get('/', (req, res) => {
res.sendFile(path.join(__dirname, '../../dev-mailbox.html'));
});
server.get('/list', async (req, res) => {
const list = await fs.readdir(outputPath);
const contents = await this.getEmailList(outputPath);
res.send(contents);
});
server.get('/types', async (req, res) => {
res.send(handlers.map(h => h.type));
});
server.get('/generate/:type/:languageCode', async (req, res) => {
const { type, languageCode } = req.params;
if (this.handleMockEventFn) {
const handler = handlers.find(h => h.type === type);
if (!handler || !handler.mockEvent) {
res.statusCode = 404;
res.send({ success: false, error: `No mock event registered for type "${type}"` });
return;
}
try {
this.handleMockEventFn(handler, {
...handler.mockEvent,
ctx: this.createRequestContext(languageCode as LanguageCode, req),
} as EventWithContext);
res.send({ success: true });
} catch (e: any) {
res.statusCode = 500;
res.send({ success: false, error: e.message });
}
return;
} else {
res.send({ success: false, error: 'Mock email generation not set up.' });
}
});
server.get('/item/:id', async (req, res) => {
const fileName = req.params.id;
const content = await this.getEmail(outputPath, fileName);
res.send(content);
});
server.get('/placeholder-image', async (req, res) => {
const img = Buffer.from(
// eslint-disable-next-line max-len
'/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAMCAgMCAgMDAwMEAwMEBQgFBQQEBQoHBwYIDAoMDAsKCwsNDhIQDQ4RDgsLEBYQERMUFRUVDA8XGBYUGBIUFRT/2wBDAQMEBAUEBQkFBQkUDQsNFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBT/wAARCADgAO4DASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD7VooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACszXNeg0SENJ88rfdjB5NafTrXlPiHUW1PVZpScqDtX2AoGX7jxxqM0m5GWFf7qj/ABqL/hMtU/57/wDjorDooGbn/CZap/z3/wDHRR/wmWqf89//AB0Vh0UAbn/CZap/z3/8dFWLPx1fwSfvgs6Z5BGD+GK5uigD1vSdWg1i1E0J/wB5e6mrtea+DdQNlrCIWxHN8hHbPavSqBBRRRQIKKKKACiiigAooooAKKKKACiiigAooooAKKKKACqepatbaTD5lxIE9F6k/hU17dpY2ss8n3I1ya8p1TVJtWu3nlPU8LnhR6UDOquPiEqswhttwzwWNQ/8LDm/59U/M1x9FAzq7rx9PcW8ka26IXUruyeM965UnJyetJRQAUUUUDCiiigAooooAcjmNwykhgcgiutX4hTKoBtkYgdcmuQooEdh/wALDm/59U/M1Ys/iDG8gFzB5a/3k5rh6KAPYbG/g1GES28gkQ+nb61PXleg61Lo14rg5iY4dM8EV6lFIJY0cdGAIoEOooooEFFFFABRRRQAUUUUAFFFFABRRRQBgeOJDHoLY/idVP615tXo3jz/AJAP/bVf615zQUgooooGFFFLQAlWLXT7m8YCGF5M91HH510/hvwd9oVLq9BCdVi9R712sFvFaxhIo1jUdlFArnnkPgfUpFyypGfRm/wptx4J1KFcrGsvGflYf1r0nIHU0ZoFc8duLWa1bbNE8Z/2lIqGvYbqxgvoyk8SyL7iuD8SeE30sG4t8yW+eR3SgZzVFFFAwooooAK9W8NSGbQrN26lP6mvKa9T8K/8i/Zf7n9TQJmrRRRQSFFFFABRRRQAUUUUAFFFFABRRRQBzvjz/kA/9tV/rXnNejePP+QD/wBtV/rXnNBSCiiigYV0Xg7RRqV4ZpQfJh5+prna9P8ACNn9k0SDpuk+c0CNnp7CuQ8Q+NPs8jW9jy68NIen4VpeMNUOnaWVQ4kmOwEdRXmpJPJ5NAkW7jV7y6YmW5kf6tT7XXL6zYGK5kUD+HPFUKKCj0Lw74wTUWFvdYjnPRv4WrpJIxLGyMMqwwa8bVjGwYHBByK9U8O6kdU0mGZuHxtbnuOM0Es4DxNo/wDZGpMig+U/zITWRXonjqz8/SRMFy0Tde+K87oGFFFFAwr1Pwr/AMi/Zf7n9TXllep+Ff8AkX7L/c/qaBM1aKKKCQooooAKKKKACiiigAooooAKKKKAOd8ef8gH/tqv9a85r0bx5/yAf+2q/wBa85oKQUUUUDCvXtL/AOQdb/7gryGvU/C94LzRbdgclRsb6igTOf8AiJnfaemDXGV6R400ttQ0vzI8mSE7to7jvXnFACUUUUDCu++H27+zp8/d8zj8q4NVLsFUZJOAK9R8M6a2l6TFFJ/rG+ZvbPOKBMb4r/5AN1/u15dXo3jm8Fvo/lZw0rYH0HWvOaAQUUUUDCvU/Cv/ACL9l/uf1NeWV6n4V/5F+y/3P6mgTNWiiigkKKKKACiiigAooooAKKKKACiiigDnfHn/ACAf+2q/1rzmvRvHn/IB/wC2q/1rzmgpBRRRQMK6XwXrQ0+8NvKwEM3dj0Nc1SgkHI4NAHs/DDB5FcVr3ghy0lxYndk7jD/hS+GfGQAW2v2wBwsx/ka7KORJlDIwdT0KnNBOx5BcWNxasVmheNh2YU+1026vGCwwPIf9kV69tHpRgelAXOS8N+DvsrLc3oDSD7sfYe9dazBVJJwB1qOe4jtoy8rrGo7sa4bxN4u+3BrazYrD0aTpu/8ArUBuZ/irWjq2oELxDF8qjPU9zWJRRQUFFFFABXqfhX/kX7L/AHP6mvLK9T8K/wDIv2X+5/U0CZq0UUUEhRRRQAUUUUAFFFFABRRRQAUUUUAYHjiMyaC2P4XVj+tebV7BqFmmoWcsD9HGK8o1Cxl026kgmXDKcZ7H3FBSK1FFFAwooooAKuWerXmnsDBcPHjoucj8jVOigDpY/HmoR7dyxyY67h1ps3jrUZFYL5cZPQqOn51zlFAizdajc3rEzzvJnsTx+VVqKKBhRRRQAUUUUAFeq+GY2i0GzVhhgnT8TXnWh6TJq9/HCo+TOXbsBXqsMSwQpGowqjAoEx9FFFBIUUUUAFFFFABRRRQAUUUUAFFFFABVHVtFttYhCTplh91x1FXqKAOIuPh5Lu/cXSbf+mgP9Ki/4V5d/wDP1D+R/wAK7yigdzg/+FeXf/P1D+R/wo/4V5d/8/UP5H/Cu8ooC5wf/CvLv/n6h/I/4Uf8K8u/+fqH8j/hXeUUBc4P/hXl3/z9Q/kf8KP+FeXf/P1D+R/wrvKKAucH/wAK8u/+fqH8j/hR/wAK8u/+fqH8j/hXeUUBc4P/AIV5d/8AP1D+R/wo/wCFeXf/AD9Q/kf8K7yigLnB/wDCvLv/AJ+ofyP+FWLX4ekMDc3KkZ6Rg12lFAXKmm6VbaVD5dvGEB6nuat0UUCCiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKAP/9k=',
'base64',
);
res.writeHead(200, {
'Content-Type': 'image/png',
'Content-Length': img.length,
});
res.end(img);
});
return server;
}
handleMockEvent(handler: (handler: EmailEventHandler<string, any>, event: EventWithContext) => void) {
this.handleMockEventFn = handler;
}
private async getEmailList(outputPath: string) {
const list = await fs.readdir(outputPath);
const contents: Array<{
fileName: string;
date: string;
subject: string;
recipient: string;
}> = [];
for (const fileName of list.filter(name => name.endsWith('.json'))) {
const json = await fs.readFile(path.join(outputPath, fileName), 'utf-8');
const content = JSON.parse(json);
contents.push({
fileName,
date: content.date,
subject: content.subject,
recipient: content.recipient,
});
}
contents.sort((a, b) => {
return a.fileName < b.fileName ? 1 : -1;
});
return contents;
}
private async getEmail(outputPath: string, fileName: string) {
const safeSuffix = path.normalize(fileName).replace(/^(\.\.(\/|\\|$))+/, '');
const safeFilePath = path.join(outputPath, safeSuffix);
const json = await fs.readFile(safeFilePath, 'utf-8');
const content = JSON.parse(json);
return content;
}
private createRequestContext(languageCode: LanguageCode, req: Request): RequestContext {
return new RequestContext({
languageCode,
req,
apiType: 'admin',
session: {} as any,
isAuthorized: false,
authorizedAsOwnerOnly: true,
channel: new Channel(),
});
}
}
|
import { Inject, Injectable } from '@nestjs/common';
import { ModuleRef } from '@nestjs/core';
import { EventBus, Injector, Logger, RequestContext } from '@vendure/core';
import fs from 'fs-extra';
import { deserializeAttachments } from './attachment-utils';
import { isDevModeOptions, resolveTransportSettings } from './common';
import { EMAIL_PLUGIN_OPTIONS, loggerCtx } from './constants';
import { EmailSendEvent } from './email-send-event';
import { EmailGenerator } from './generator/email-generator';
import { HandlebarsMjmlGenerator } from './generator/handlebars-mjml-generator';
import { EmailSender } from './sender/email-sender';
import { NodemailerEmailSender } from './sender/nodemailer-email-sender';
import {
EmailDetails,
EmailTransportOptions,
InitializedEmailPluginOptions,
IntermediateEmailDetails,
} from './types';
/**
* This class combines the template loading, generation, and email sending - the actual "work" of
* the EmailPlugin. It is arranged this way primarily to accommodate easier testing, so that the
* tests can be run without needing all the JobQueue stuff which would require a full e2e test.
*/
@Injectable()
export class EmailProcessor {
protected emailSender: EmailSender;
protected generator: EmailGenerator;
constructor(
@Inject(EMAIL_PLUGIN_OPTIONS) protected options: InitializedEmailPluginOptions,
private moduleRef: ModuleRef,
private eventBus: EventBus,
) {}
async init() {
this.emailSender = this.options.emailSender ? this.options.emailSender : new NodemailerEmailSender();
this.generator = this.options.emailGenerator
? this.options.emailGenerator
: new HandlebarsMjmlGenerator();
if (this.generator.onInit) {
await this.generator.onInit.call(this.generator, this.options);
}
const transport = await this.getTransportSettings();
if (transport.type === 'file') {
// ensure the configured directory exists before
// we attempt to write files to it
const emailPath = transport.outputPath;
await fs.ensureDir(emailPath);
}
}
async process(data: IntermediateEmailDetails) {
const ctx = RequestContext.deserialize(data.ctx);
let emailDetails: EmailDetails = {} as any;
try {
const bodySource = await this.options.templateLoader.loadTemplate(
new Injector(this.moduleRef),
ctx,
{
templateName: data.templateFile,
type: data.type,
templateVars: data.templateVars,
},
);
const generated = this.generator.generate(data.from, data.subject, bodySource, data.templateVars);
emailDetails = {
...generated,
recipient: data.recipient,
attachments: deserializeAttachments(data.attachments),
cc: data.cc,
bcc: data.bcc,
replyTo: data.replyTo,
};
const transportSettings = await this.getTransportSettings(ctx);
await this.emailSender.send(emailDetails, transportSettings);
await this.eventBus.publish(new EmailSendEvent(ctx, emailDetails, true));
return true;
} catch (err: unknown) {
if (err instanceof Error) {
Logger.error(err.message, loggerCtx, err.stack);
} else {
Logger.error(String(err), loggerCtx);
}
await this.eventBus.publish(new EmailSendEvent(ctx, emailDetails, false, err as Error));
throw err;
}
}
async getTransportSettings(ctx?: RequestContext): Promise<EmailTransportOptions> {
const transport = await resolveTransportSettings(this.options, new Injector(this.moduleRef), ctx);
if (isDevModeOptions(this.options)) {
if (transport && transport.type !== 'file') {
Logger.warn(
`The EmailPlugin is running in dev mode. The configured '${transport.type}' transport will be replaced by the 'file' transport.`,
loggerCtx,
);
}
return {
type: 'file',
raw: false,
outputPath: this.options.outputPath,
};
} else {
return transport;
}
}
}
|
import { RequestContext, VendureEvent } from '@vendure/core';
import { EmailDetails } from './types';
/**
* @description
* This event is fired when an email sending attempt has been made. If the sending was successful,
* the `success` property will be `true`, and if not, the `error` property will contain the error
* which occurred.
*
* @docsCategory core plugins/EmailPlugin
* @since 2.2.0
*/
export class EmailSendEvent extends VendureEvent {
constructor(
public readonly ctx: RequestContext,
public readonly details: EmailDetails,
public readonly success: boolean,
public readonly error?: Error,
) {
super();
}
}
|
import { Type } from '@vendure/common/lib/shared-types';
import { EmailEventHandler } from './handler/event-handler';
import { EventWithContext } from './types';
/**
* @description
* An EmailEventListener is used to listen for events and set up a {@link EmailEventHandler} which
* defines how an email will be generated from this event.
*
* @docsCategory core plugins/EmailPlugin
*/
export class EmailEventListener<T extends string> {
public type: T;
constructor(type: T) {
this.type = type;
}
/**
* @description
* Defines the event to listen for.
*/
on<Event extends EventWithContext>(event: Type<Event>): EmailEventHandler<T, Event> {
return new EmailEventHandler<T, Event>(this, event);
}
}
|
/* eslint-disable @typescript-eslint/no-non-null-assertion */
import { Test, TestingModule } from '@nestjs/testing';
import { TypeOrmModule } from '@nestjs/typeorm';
import { DEFAULT_CHANNEL_CODE } from '@vendure/common/lib/shared-constants';
import {
DefaultLogger,
EventBus,
Injector,
LanguageCode,
Logger,
LogLevel,
Order,
OrderStateTransitionEvent,
PluginCommonModule,
RequestContext,
VendureEvent,
} from '@vendure/core';
import { ensureConfigLoaded } from '@vendure/core/dist/config/config-helpers';
import { TestingLogger } from '@vendure/testing';
import { createReadStream, readFileSync } from 'fs';
import path from 'path';
import { Readable } from 'stream';
import { afterEach, beforeEach, describe, expect, it, Mock, vi } from 'vitest';
import { orderConfirmationHandler } from './handler/default-email-handlers';
import { EmailProcessor } from './email-processor';
import { EmailSender } from './sender/email-sender';
import { EmailEventHandler } from './handler/event-handler';
import { EmailEventListener } from './event-listener';
import { EmailPlugin } from './plugin';
import { EmailDetails, EmailPluginOptions, EmailTransportOptions } from './types';
describe('EmailPlugin', () => {
let eventBus: EventBus;
let onSend: Mock;
let module: TestingModule;
const testingLogger = new TestingLogger((...args) => vi.fn(...args));
async function initPluginWithHandlers(
handlers: Array<EmailEventHandler<string, any>>,
options?: Partial<EmailPluginOptions>,
) {
await ensureConfigLoaded();
onSend = vi.fn();
module = await Test.createTestingModule({
imports: [
TypeOrmModule.forRoot({
type: 'sqljs',
retryAttempts: 0,
}),
PluginCommonModule,
EmailPlugin.init({
templatePath: path.join(__dirname, '../test-templates'),
transport: {
type: 'testing',
onSend,
},
handlers,
...options,
}),
],
providers: [MockService],
}).compile();
Logger.useLogger(testingLogger);
module.useLogger(new Logger());
const plugin = module.get(EmailPlugin);
eventBus = module.get(EventBus);
await plugin.onApplicationBootstrap();
return module;
}
afterEach(async () => {
if (module) {
await module.close();
}
});
it('setting from, recipient, subject', async () => {
const ctx = RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any);
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello')
.setTemplateVars(event => ({ subjectVar: 'foo' }));
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].subject).toBe('Hello');
expect(onSend.mock.calls[0][0].recipient).toBe('test@test.com');
expect(onSend.mock.calls[0][0].from).toBe('"test from" <noreply@test.com>');
});
describe('event filtering', () => {
const ctx = RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any);
it('single filter', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.filter(event => event.shouldSend === true)
.setRecipient(() => 'test@test.com')
.setFrom('"test from" <noreply@test.com>')
.setSubject('test subject');
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, false));
await pause();
expect(onSend).not.toHaveBeenCalled();
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend).toHaveBeenCalledTimes(1);
});
it('multiple filters', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.filter(event => event.shouldSend === true)
.filter(event => !!event.ctx.activeUserId)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('test subject');
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend).not.toHaveBeenCalled();
const ctxWithUser = RequestContext.deserialize({ ...ctx, _session: { user: { id: 42 } } } as any);
eventBus.publish(new MockEvent(ctxWithUser, true));
await pause();
expect(onSend).toHaveBeenCalledTimes(1);
});
it('with .loadData() after .filter()', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.filter(event => event.shouldSend === true)
.loadData(context => Promise.resolve('loaded data'))
.setRecipient(() => 'test@test.com')
.setFrom('"test from" <noreply@test.com>')
.setSubject('test subject');
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, false));
await pause();
expect(onSend).not.toHaveBeenCalled();
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend).toHaveBeenCalledTimes(1);
});
});
describe('templateVars', () => {
const ctx = RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any);
it('interpolates subject', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}')
.setTemplateVars(event => ({ subjectVar: 'foo' }));
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].subject).toBe('Hello foo');
});
it('interpolates body', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello')
.setTemplateVars(event => ({ testVar: 'this is the test var' }));
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].body).toContain('this is the test var');
});
/**
* Intended to test the ability for Handlebars to interpolate
* getters on the Order entity prototype.
* See https://github.com/vendure-ecommerce/vendure/issues/259
*/
it('interpolates body with property from entity', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello')
.setTemplateVars(event => ({ order: new Order({ subTotal: 123 }) }));
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].body).toContain('Total: 123');
});
it('interpolates globalTemplateVars', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ globalVar }}');
await initPluginWithHandlers([handler], {
globalTemplateVars: { globalVar: 'baz' },
});
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].subject).toBe('Hello baz');
});
it('interpolates from', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from {{ globalVar }}" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello');
await initPluginWithHandlers([handler], {
globalTemplateVars: { globalVar: 'baz' },
});
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].from).toBe('"test from baz" <noreply@test.com>');
});
// Test fix for https://github.com/vendure-ecommerce/vendure/issues/363
it('does not escape HTML chars when interpolating "from"', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('{{ globalFrom }}')
.setRecipient(() => 'Test <test@test.com>')
.setSubject('Hello');
await initPluginWithHandlers([handler], {
globalTemplateVars: { globalFrom: 'Test <test@test.com>' },
});
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].from).toBe('Test <test@test.com>');
});
it('globalTemplateVars available in setTemplateVars method', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ testVar }}')
.setTemplateVars((event, globals) => ({ testVar: (globals.globalVar as string) + ' quux' }));
await initPluginWithHandlers([handler], {
globalTemplateVars: { globalVar: 'baz' },
});
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].subject).toBe('Hello baz quux');
});
it('setTemplateVars overrides globals', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ name }}')
.setTemplateVars((event, globals) => ({ name: 'quux' }));
await initPluginWithHandlers([handler], { globalTemplateVars: { name: 'baz' } });
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].subject).toBe('Hello quux');
});
});
describe('handlebars helpers', () => {
const ctx = RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any);
it('formateDate', async () => {
const handler = new EmailEventListener('test-helpers')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello')
.setTemplateVars(event => ({ myDate: new Date('2020-01-01T10:00:00.000Z'), myPrice: 0 }));
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].body).toContain('Date: Wed Jan 01 2020 10:00:00');
});
it('formatMoney', async () => {
const handler = new EmailEventListener('test-helpers')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello')
.setTemplateVars(event => ({ myDate: new Date(), myPrice: 123 }));
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].body).toContain('Price: 1.23');
expect(onSend.mock.calls[0][0].body).toContain('Price: €1.23');
expect(onSend.mock.calls[0][0].body).toContain('Price: £1.23');
});
});
describe('multiple configs', () => {
const ctx = RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any);
it('additional LanguageCode', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setSubject('Hello, {{ name }}!')
.setRecipient(() => 'test@test.com')
.setTemplateVars(() => ({ name: 'Test' }))
.addTemplate({
channelCode: 'default',
languageCode: LanguageCode.de,
templateFile: 'body.de.hbs',
subject: 'Servus, {{ name }}!',
});
await initPluginWithHandlers([handler]);
const ctxTa = RequestContext.deserialize({ ...ctx, _languageCode: LanguageCode.ta } as any);
eventBus.publish(new MockEvent(ctxTa, true));
await pause();
expect(onSend.mock.calls[0][0].subject).toBe('Hello, Test!');
expect(onSend.mock.calls[0][0].body).toContain('Default body.');
const ctxDe = RequestContext.deserialize({ ...ctx, _languageCode: LanguageCode.de } as any);
eventBus.publish(new MockEvent(ctxDe, true));
await pause();
expect(onSend.mock.calls[1][0].subject).toBe('Servus, Test!');
expect(onSend.mock.calls[1][0].body).toContain('German body.');
});
it('set LanguageCode', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setSubject('Hello, {{ name }}!')
.setRecipient(() => 'test@test.com')
.setLanguageCode(() => LanguageCode.de)
.setTemplateVars(() => ({ name: 'Test' }))
.addTemplate({
channelCode: 'default',
languageCode: LanguageCode.de,
templateFile: 'body.de.hbs',
subject: 'Servus, {{ name }}!',
});
const ctxEn = RequestContext.deserialize({ ...ctx, _languageCode: LanguageCode.en } as any);
eventBus.publish(new MockEvent(ctxEn, true));
await pause();
expect(onSend.mock.calls[1][0].subject).toBe('Servus, Test!');
expect(onSend.mock.calls[1][0].body).toContain('German body.');
});
});
describe('loadData', () => {
it('loads async data', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.loadData(async ({ injector }) => {
const service = injector.get(MockService);
return service.someAsyncMethod();
})
.setFrom('"test from" <noreply@test.com>')
.setSubject('Hello, {{ testData }}!')
.setRecipient(() => 'test@test.com')
.setTemplateVars(event => ({ testData: event.data }));
await initPluginWithHandlers([handler]);
eventBus.publish(
new MockEvent(
RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any),
true,
),
);
await pause();
expect(onSend.mock.calls[0][0].subject).toBe('Hello, loaded data!');
});
it('works when loadData is called after other setup', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setSubject('Hello, {{ testData }}!')
.setRecipient(() => 'test@test.com')
.loadData(async ({ injector }) => {
const service = injector.get(MockService);
return service.someAsyncMethod();
})
.setTemplateVars(event => ({ testData: event.data }));
await initPluginWithHandlers([handler]);
eventBus.publish(
new MockEvent(
RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any),
true,
),
);
await pause();
expect(onSend.mock.calls[0][0].subject).toBe('Hello, loaded data!');
expect(onSend.mock.calls[0][0].from).toBe('"test from" <noreply@test.com>');
expect(onSend.mock.calls[0][0].recipient).toBe('test@test.com');
});
it('only executes for filtered events', async () => {
let callCount = 0;
const handler = new EmailEventListener('test')
.on(MockEvent)
.filter(event => event.shouldSend === true)
.loadData(async ({ injector }) => {
callCount++;
});
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(RequestContext.empty(), false));
eventBus.publish(new MockEvent(RequestContext.empty(), true));
await pause();
expect(callCount).toBe(1);
});
});
describe('attachments', () => {
const ctx = RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any);
const TEST_IMAGE_PATH = path.join(__dirname, '../test-fixtures/test.jpg');
it('attachments are empty by default', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}');
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].attachments).toEqual([]);
});
it('sync attachment', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}')
.setAttachments(() => [
{
path: TEST_IMAGE_PATH,
},
]);
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].attachments).toEqual([{ path: TEST_IMAGE_PATH }]);
});
it('async attachment', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}')
.setAttachments(async () => [
{
path: TEST_IMAGE_PATH,
},
]);
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].attachments).toEqual([{ path: TEST_IMAGE_PATH }]);
});
it('attachment content as a string buffer', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}')
.setAttachments(() => [
{
content: Buffer.from('hello'),
},
]);
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
const attachment = onSend.mock.calls[0][0].attachments[0].content;
expect(Buffer.compare(attachment, Buffer.from('hello'))).toBe(0); // 0 = buffers are equal
});
it('attachment content as an image buffer', async () => {
const imageFileBuffer = readFileSync(TEST_IMAGE_PATH);
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}')
.setAttachments(() => [
{
content: imageFileBuffer,
},
]);
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
const attachment = onSend.mock.calls[0][0].attachments[0].content;
expect(Buffer.compare(attachment, imageFileBuffer)).toBe(0); // 0 = buffers are equal
});
it('attachment content as a string', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}')
.setAttachments(() => [
{
content: 'hello',
},
]);
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
const attachment = onSend.mock.calls[0][0].attachments[0].content;
expect(attachment).toBe('hello');
});
it('attachment content as a string stream', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}')
.setAttachments(() => [
{
content: Readable.from(['hello']),
},
]);
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
const attachment = onSend.mock.calls[0][0].attachments[0].content;
expect(Buffer.compare(attachment, Buffer.from('hello'))).toBe(0); // 0 = buffers are equal
});
it('attachment content as an image stream', async () => {
const imageFileBuffer = readFileSync(TEST_IMAGE_PATH);
const imageFileStream = createReadStream(TEST_IMAGE_PATH);
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}')
.setAttachments(() => [
{
content: imageFileStream,
},
]);
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
const attachment = onSend.mock.calls[0][0].attachments[0].content;
expect(Buffer.compare(attachment, imageFileBuffer)).toBe(0); // 0 = buffers are equal
});
it('raises a warning for large content attachments', async () => {
testingLogger.warnSpy.mockClear();
const largeBuffer = Buffer.from(Array.from({ length: 65535, 0: 0 }));
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}')
.setAttachments(() => [
{
content: largeBuffer,
},
]);
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(testingLogger.warnSpy.mock.calls[0][0]).toContain(
"Email has a large 'content' attachment (64k). Consider using the 'path' instead for improved performance.",
);
});
});
describe('orderConfirmationHandler', () => {
beforeEach(async () => {
await initPluginWithHandlers([orderConfirmationHandler], {
templatePath: path.join(__dirname, '../templates'),
});
});
const ctx = RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any);
const order = {
code: 'ABCDE',
customer: {
emailAddress: 'test@test.com',
},
lines: [],
} as any;
it('filters events with wrong order state', async () => {
eventBus.publish(new OrderStateTransitionEvent('AddingItems', 'ArrangingPayment', ctx, order));
await pause();
expect(onSend).not.toHaveBeenCalled();
eventBus.publish(new OrderStateTransitionEvent('AddingItems', 'Cancelled', ctx, order));
await pause();
expect(onSend).not.toHaveBeenCalled();
eventBus.publish(new OrderStateTransitionEvent('AddingItems', 'PaymentAuthorized', ctx, order));
await pause();
expect(onSend).not.toHaveBeenCalled();
eventBus.publish(new OrderStateTransitionEvent('ArrangingPayment', 'PaymentSettled', ctx, order));
await pause();
expect(onSend).toHaveBeenCalledTimes(1);
});
it('sets the Order Customer emailAddress as recipient', async () => {
eventBus.publish(new OrderStateTransitionEvent('ArrangingPayment', 'PaymentSettled', ctx, order));
await pause();
expect(onSend.mock.calls[0][0].recipient).toBe(order.customer!.emailAddress);
});
it('sets the subject', async () => {
eventBus.publish(new OrderStateTransitionEvent('ArrangingPayment', 'PaymentSettled', ctx, order));
await pause();
expect(onSend.mock.calls[0][0].subject).toBe(`Order confirmation for #${order.code as string}`);
});
});
describe('error handling', () => {
it('Logs an error if the template file is not found', async () => {
const ctx = RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any);
testingLogger.errorSpy.mockClear();
const handler = new EmailEventListener('no-template')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}');
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(testingLogger.errorSpy.mock.calls[0][0]).toContain('ENOENT: no such file or directory');
});
it('Logs a Handlebars error if the template is invalid', async () => {
const ctx = RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any);
testingLogger.errorSpy.mockClear();
const handler = new EmailEventListener('bad-template')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}');
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(testingLogger.errorSpy.mock.calls[0][0]).toContain('Parse error on line 3:');
});
it('Logs an error if the loadData method throws', async () => {
const ctx = RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any);
testingLogger.errorSpy.mockClear();
const handler = new EmailEventListener('bad-template')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}')
.loadData(context => {
throw new Error('something went horribly wrong!');
});
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(testingLogger.errorSpy.mock.calls[0][0]).toContain('something went horribly wrong!');
});
});
describe('custom sender', () => {
it('should allow a custom sender to be utilized', async () => {
const ctx = RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any);
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello')
.setTemplateVars(event => ({ subjectVar: 'foo' }));
const fakeSender = new FakeCustomSender();
const send = vi.fn();
fakeSender.send = send;
await initPluginWithHandlers([handler], {
emailSender: fakeSender,
});
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(send.mock.calls[0][0].subject).toBe('Hello');
expect(send.mock.calls[0][0].recipient).toBe('test@test.com');
expect(send.mock.calls[0][0].from).toBe('"test from" <noreply@test.com>');
expect(onSend).toHaveBeenCalledTimes(0);
});
});
describe('optional address fields', () => {
const ctx = RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any);
it('cc', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}')
.setOptionalAddressFields(() => ({ cc: 'foo@bar.com' }));
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].cc).toBe('foo@bar.com');
});
it('bcc', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}')
.setOptionalAddressFields(() => ({ bcc: 'foo@bar.com' }));
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].bcc).toBe('foo@bar.com');
});
it('replyTo', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello {{ subjectVar }}')
.setOptionalAddressFields(() => ({ replyTo: 'foo@bar.com' }));
await initPluginWithHandlers([handler]);
eventBus.publish(new MockEvent(ctx, true));
await pause();
expect(onSend.mock.calls[0][0].replyTo).toBe('foo@bar.com');
});
});
describe('Dynamic transport settings', () => {
let injectorArg: Injector | undefined;
let ctxArg: RequestContext | undefined;
it('Initializes with async transport settings', async () => {
const handler = new EmailEventListener('test')
.on(MockEvent)
.setFrom('"test from" <noreply@test.com>')
.setRecipient(() => 'test@test.com')
.setSubject('Hello')
.setTemplateVars(event => ({ subjectVar: 'foo' }));
module = await initPluginWithHandlers([handler], {
transport: async (injector, ctx) => {
injectorArg = injector;
ctxArg = ctx;
return {
type: 'testing',
onSend: () => {},
};
},
});
const ctx = RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any);
module!.get(EventBus).publish(new MockEvent(ctx, true));
await pause();
expect(module).toBeDefined();
expect(typeof module.get(EmailPlugin).options.transport).toBe('function');
});
it('Passes injector and context to transport function', async () => {
const ctx = RequestContext.deserialize({
_channel: { code: DEFAULT_CHANNEL_CODE },
_languageCode: LanguageCode.en,
} as any);
module!.get(EventBus).publish(new MockEvent(ctx, true));
await pause();
expect(injectorArg?.constructor.name).toBe('Injector');
expect(ctxArg?.constructor.name).toBe('RequestContext');
});
it('Resolves async transport settings', async () => {
const transport = await module!.get(EmailProcessor).getTransportSettings();
expect(transport.type).toBe('testing');
});
});
});
class FakeCustomSender implements EmailSender {
send: (email: EmailDetails<'unserialized'>, options: EmailTransportOptions) => void;
}
const pause = () => new Promise(resolve => setTimeout(resolve, 100));
class MockEvent extends VendureEvent {
constructor(public ctx: RequestContext, public shouldSend: boolean) {
super();
}
}
class MockService {
someAsyncMethod() {
return Promise.resolve('loaded data');
}
}
|
import {
Inject,
MiddlewareConsumer,
NestModule,
OnApplicationBootstrap,
OnApplicationShutdown,
} from '@nestjs/common';
import { ModuleRef } from '@nestjs/core';
import {
EventBus,
Injector,
JobQueue,
JobQueueService,
Logger,
PluginCommonModule,
ProcessContext,
registerPluginStartupMessage,
Type,
VendurePlugin,
} from '@vendure/core';
import { isDevModeOptions, resolveTransportSettings } from './common';
import { EMAIL_PLUGIN_OPTIONS, loggerCtx } from './constants';
import { DevMailbox } from './dev-mailbox';
import { EmailProcessor } from './email-processor';
import { EmailEventHandler, EmailEventHandlerWithAsyncData } from './handler/event-handler';
import { FileBasedTemplateLoader } from './template-loader/file-based-template-loader';
import {
EmailPluginDevModeOptions,
EmailPluginOptions,
EventWithContext,
InitializedEmailPluginOptions,
IntermediateEmailDetails,
} from './types';
/**
* @description
* The EmailPlugin creates and sends transactional emails based on Vendure events. By default, it uses an [MJML](https://mjml.io/)-based
* email generator to generate the email body and [Nodemailer](https://nodemailer.com/about/) to send the emails.
*
* ## High-level description
* Vendure has an internal events system (see {@link EventBus}) that allows plugins to subscribe to events. The EmailPlugin is configured with {@link EmailEventHandler}s
* that listen for a specific event and when it is published, the handler defines which template to use to generate the resulting email.
*
* The plugin comes with a set of default handler for the following events:
* - Order confirmation
* - New customer email address verification
* - Password reset request
* - Email address change request
*
* You can also create your own handler and register them with the plugin - see the {@link EmailEventHandler} docs for more details.
*
* ## Installation
*
* `yarn add \@vendure/email-plugin`
*
* or
*
* `npm install \@vendure/email-plugin`
*
* @example
* ```ts
* import { defaultEmailHandlers, EmailPlugin } from '\@vendure/email-plugin';
*
* const config: VendureConfig = {
* // Add an instance of the plugin to the plugins array
* plugins: [
* EmailPlugin.init({
* handler: defaultEmailHandlers,
* templatePath: path.join(__dirname, 'static/email/templates'),
* transport: {
* type: 'smtp',
* host: 'smtp.example.com',
* port: 587,
* auth: {
* user: 'username',
* pass: 'password',
* }
* },
* }),
* ],
* };
* ```
*
* ## Email templates
*
* In the example above, the plugin has been configured to look in `<app-root>/static/email/templates`
* for the email template files. If you used `\@vendure/create` to create your application, the templates will have
* been copied to that location during setup.
*
* If you are installing the EmailPlugin separately, then you'll need to copy the templates manually from
* `node_modules/\@vendure/email-plugin/templates` to a location of your choice, and then point the `templatePath` config
* property at that directory.
*
* * ### Dynamic Email Templates
* Instead of passing a static value to `templatePath`, use `templateLoader` to define a template path.
* ```ts
* EmailPlugin.init({
* ...,
* templateLoader: new FileBasedTemplateLoader(my/order-confirmation/templates)
* })
* ```
* ## Customizing templates
*
* Emails are generated from templates which use [MJML](https://mjml.io/) syntax. MJML is an open-source HTML-like markup
* language which makes the task of creating responsive email markup simple. By default, the templates are installed to
* `<project root>/vendure/email/templates` and can be freely edited.
*
* Dynamic data such as the recipient's name or order items are specified using [Handlebars syntax](https://handlebarsjs.com/):
*
* ```html
* <p>Dear {{ order.customer.firstName }} {{ order.customer.lastName }},</p>
*
* <p>Thank you for your order!</p>
*
* <mj-table cellpadding="6px">
* {{#each order.lines }}
* <tr class="order-row">
* <td>{{ quantity }} x {{ productVariant.name }}</td>
* <td>{{ productVariant.quantity }}</td>
* <td>{{ formatMoney totalPrice }}</td>
* </tr>
* {{/each}}
* </mj-table>
* ```
*
* ### Handlebars helpers
*
* The following helper functions are available for use in email templates:
*
* * `formatMoney`: Formats an amount of money (which are always stored as integers in Vendure) as a decimal, e.g. `123` => `1.23`
* * `formatDate`: Formats a Date value with the [dateformat](https://www.npmjs.com/package/dateformat) package.
*
* ## Extending the default email handler
*
* The `defaultEmailHandlers` array defines the default handler such as for handling new account registration, order confirmation, password reset
* etc. These defaults can be extended by adding custom templates for languages other than the default, or even completely new types of emails
* which respond to any of the available [VendureEvents](/reference/typescript-api/events/).
*
* A good way to learn how to create your own email handler is to take a look at the
* [source code of the default handler](https://github.com/vendure-ecommerce/vendure/blob/master/packages/email-plugin/src/handler/default-email-handlers.ts).
* New handler are defined in exactly the same way.
*
* It is also possible to modify the default handler:
*
* ```ts
* // Rather than importing `defaultEmailHandlers`, you can
* // import the handler individually
* import {
* orderConfirmationHandler,
* emailVerificationHandler,
* passwordResetHandler,
* emailAddressChangeHandler,
* } from '\@vendure/email-plugin';
* import { CustomerService } from '\@vendure/core';
*
* // This allows you to then customize each handler to your needs.
* // For example, let's set a new subject line to the order confirmation:
* const myOrderConfirmationHandler = orderConfirmationHandler
* .setSubject(`We received your order!`);
*
* // Another example: loading additional data and setting new
* // template variables.
* const myPasswordResetHandler = passwordResetHandler
* .loadData(async ({ event, injector }) => {
* const customerService = injector.get(CustomerService);
* const customer = await customerService.findOneByUserId(event.ctx, event.user.id);
* return { customer };
* })
* .setTemplateVars(event => ({
* passwordResetToken: event.user.getNativeAuthenticationMethod().passwordResetToken,
* customer: event.data.customer,
* }));
*
* // Then you pass the handler to the EmailPlugin init method
* // individually
* EmailPlugin.init({
* handler: [
* myOrderConfirmationHandler,
* myPasswordResetHandler,
* emailVerificationHandler,
* emailAddressChangeHandler,
* ],
* // ...
* }),
* ```
*
* For all available methods of extending a handler, see the {@link EmailEventHandler} documentation.
*
* ## Dynamic SMTP settings
*
* Instead of defining static transport settings, you can also provide a function that dynamically resolves
* channel aware transport settings.
*
* @example
* ```ts
* import { defaultEmailHandlers, EmailPlugin } from '\@vendure/email-plugin';
* import { MyTransportService } from './transport.services.ts';
* const config: VendureConfig = {
* plugins: [
* EmailPlugin.init({
* handler: defaultEmailHandlers,
* templatePath: path.join(__dirname, 'static/email/templates'),
* transport: (injector, ctx) => {
* if (ctx) {
* return injector.get(MyTransportService).getSettings(ctx);
* } else {
* return {
* type: 'smtp',
* host: 'smtp.example.com',
* // ... etc.
* }
* }
* }
* }),
* ],
* };
* ```
*
* ## Dev mode
*
* For development, the `transport` option can be replaced by `devMode: true`. Doing so configures Vendure to use the
* file transport (See {@link FileTransportOptions}) and outputs emails as rendered HTML files in the directory specified by the
* `outputPath` property.
*
* ```ts
* EmailPlugin.init({
* devMode: true,
* route: 'mailbox',
* handler: defaultEmailHandlers,
* templatePath: path.join(__dirname, 'vendure/email/templates'),
* outputPath: path.join(__dirname, 'test-emails'),
* })
* ```
*
* ### Dev mailbox
*
* In dev mode, a webmail-like interface available at the `/mailbox` path, e.g.
* http://localhost:3000/mailbox. This is a simple way to view the output of all emails generated by the EmailPlugin while in dev mode.
*
* ## Troubleshooting SMTP Connections
*
* If you are having trouble sending email over and SMTP connection, set the `logging` and `debug` options to `true`. This will
* send detailed information from the SMTP transporter to the configured logger (defaults to console). For maximum detail combine
* this with a detail log level in the configured VendureLogger:
*
* ```ts
* const config: VendureConfig = {
* logger: new DefaultLogger({ level: LogLevel.Debug })
* // ...
* plugins: [
* EmailPlugin.init({
* // ...
* transport: {
* type: 'smtp',
* host: 'smtp.example.com',
* port: 587,
* auth: {
* user: 'username',
* pass: 'password',
* },
* logging: true,
* debug: true,
* },
* }),
* ],
* };
* ```
*
* @docsCategory core plugins/EmailPlugin
*/
@VendurePlugin({
imports: [PluginCommonModule],
providers: [{ provide: EMAIL_PLUGIN_OPTIONS, useFactory: () => EmailPlugin.options }, EmailProcessor],
compatibility: '^2.0.0',
})
export class EmailPlugin implements OnApplicationBootstrap, OnApplicationShutdown, NestModule {
private static options: InitializedEmailPluginOptions;
private devMailbox: DevMailbox | undefined;
private jobQueue: JobQueue<IntermediateEmailDetails> | undefined;
private testingProcessor: EmailProcessor | undefined;
/** @internal */
constructor(
private eventBus: EventBus,
private moduleRef: ModuleRef,
private emailProcessor: EmailProcessor,
private jobQueueService: JobQueueService,
private processContext: ProcessContext,
@Inject(EMAIL_PLUGIN_OPTIONS) private options: InitializedEmailPluginOptions,
) {}
/**
* Set the plugin options.
*/
static init(options: EmailPluginOptions | EmailPluginDevModeOptions): Type<EmailPlugin> {
if (options.templateLoader) {
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
Logger.info(`Using custom template loader '${options.templateLoader.constructor.name}'`);
} else if (!options.templateLoader && options.templatePath) {
// TODO: this else-if can be removed when deprecated templatePath is removed,
// because we will either have a custom template loader, or the default loader with a default path
options.templateLoader = new FileBasedTemplateLoader(options.templatePath);
} else {
throw new Error('You must either supply a templatePath or provide a custom templateLoader');
}
this.options = options as InitializedEmailPluginOptions;
return EmailPlugin;
}
/** @internal */
async onApplicationBootstrap(): Promise<void> {
await this.initInjectableStrategies();
await this.setupEventSubscribers();
const transport = await resolveTransportSettings(this.options, new Injector(this.moduleRef));
if (!isDevModeOptions(this.options) && transport.type === 'testing') {
// When running tests, we don't want to go through the JobQueue system,
// so we just call the email sending logic directly.
this.testingProcessor = new EmailProcessor(this.options, this.moduleRef, this.eventBus);
await this.testingProcessor.init();
} else {
await this.emailProcessor.init();
this.jobQueue = await this.jobQueueService.createQueue({
name: 'send-email',
process: job => {
return this.emailProcessor.process(job.data);
},
});
}
}
async onApplicationShutdown() {
await this.destroyInjectableStrategies();
}
configure(consumer: MiddlewareConsumer) {
if (isDevModeOptions(this.options) && this.processContext.isServer) {
Logger.info('Creating dev mailbox middleware', loggerCtx);
this.devMailbox = new DevMailbox();
consumer.apply(this.devMailbox.serve(this.options)).forRoutes(this.options.route);
this.devMailbox.handleMockEvent((handler, event) => this.handleEvent(handler, event));
registerPluginStartupMessage('Dev mailbox', this.options.route);
}
}
private async initInjectableStrategies() {
const injector = new Injector(this.moduleRef);
if (typeof this.options.emailGenerator?.init === 'function') {
await this.options.emailGenerator.init(injector);
}
if (typeof this.options.emailSender?.init === 'function') {
await this.options.emailSender.init(injector);
}
}
private async destroyInjectableStrategies() {
if (typeof this.options.emailGenerator?.destroy === 'function') {
await this.options.emailGenerator.destroy();
}
if (typeof this.options.emailSender?.destroy === 'function') {
await this.options.emailSender.destroy();
}
}
private async setupEventSubscribers() {
for (const handler of EmailPlugin.options.handlers) {
this.eventBus.ofType(handler.event).subscribe(event => {
return this.handleEvent(handler, event);
});
}
}
private async handleEvent(
handler: EmailEventHandler | EmailEventHandlerWithAsyncData<any>,
event: EventWithContext,
) {
Logger.debug(`Handling event "${handler.type}"`, loggerCtx);
const { type } = handler;
try {
const injector = new Injector(this.moduleRef);
const result = await handler.handle(
event as any,
EmailPlugin.options.globalTemplateVars,
injector,
);
if (!result) {
return;
}
if (this.jobQueue) {
await this.jobQueue.add(result, { retries: 5 });
} else if (this.testingProcessor) {
await this.testingProcessor.process(result);
}
} catch (e: any) {
Logger.error(e.message, loggerCtx, e.stack);
}
}
}
|
import { LanguageCode } from '@vendure/common/lib/generated-types';
import { Omit } from '@vendure/common/lib/omit';
import { Injector, RequestContext, SerializedRequestContext, VendureEvent } from '@vendure/core';
import { Attachment } from 'nodemailer/lib/mailer';
import SESTransport from 'nodemailer/lib/ses-transport';
import SMTPTransport from 'nodemailer/lib/smtp-transport';
import { EmailEventHandler } from './handler/event-handler';
import { EmailGenerator } from './generator/email-generator';
import { EmailSender } from './sender/email-sender';
import { TemplateLoader } from './template-loader/template-loader';
/**
* @description
* A VendureEvent which also includes a `ctx` property containing the current
* {@link RequestContext}, which is used to determine the channel and language
* to use when generating the email.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage Email Plugin Types
*/
export type EventWithContext = VendureEvent & { ctx: RequestContext };
/**
* @description
* A VendureEvent with a {@link RequestContext} and a `data` property which contains the
* value resolved from the {@link EmailEventHandler}`.loadData()` callback.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage Email Plugin Types
*/
export type EventWithAsyncData<Event extends EventWithContext, R> = Event & { data: R };
/**
* @description
* Configuration for the EmailPlugin.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage EmailPluginOptions
* */
export interface EmailPluginOptions {
/**
* @description
* The path to the location of the email templates. In a default Vendure installation,
* the templates are installed to `<project root>/vendure/email/templates`.
*
* @deprecated Use `templateLoader` to define a template path: `templateLoader: new FileBasedTemplateLoader('../your-path/templates')`
*/
templatePath?: string;
/**
* @description
* An optional TemplateLoader which can be used to load templates from a custom location or async service.
* The default uses the FileBasedTemplateLoader which loads templates from `<project root>/vendure/email/templates`
*
* @since 2.0.0
*/
templateLoader?: TemplateLoader;
/**
* @description
* Configures how the emails are sent.
*/
transport:
| EmailTransportOptions
| ((
injector?: Injector,
ctx?: RequestContext,
) => EmailTransportOptions | Promise<EmailTransportOptions>);
/**
* @description
* An array of {@link EmailEventHandler}s which define which Vendure events will trigger
* emails, and how those emails are generated.
*/
handlers: Array<EmailEventHandler<string, any>>;
/**
* @description
* An object containing variables which are made available to all templates. For example,
* the storefront URL could be defined here and then used in the "email address verification"
* email.
*/
globalTemplateVars?: { [key: string]: any };
/**
* @description
* An optional allowed EmailSender, used to allow custom implementations of the send functionality
* while still utilizing the existing emailPlugin functionality.
*
* @default NodemailerEmailSender
*/
emailSender?: EmailSender;
/**
* @description
* An optional allowed EmailGenerator, used to allow custom email generation functionality to
* better match with custom email sending functionality.
*
* @default HandlebarsMjmlGenerator
*/
emailGenerator?: EmailGenerator;
}
/**
* EmailPLuginOptions type after initialization, where templateLoader is no longer optional
*/
export type InitializedEmailPluginOptions = EmailPluginOptions & { templateLoader: TemplateLoader };
/**
* @description
* Configuration for running the EmailPlugin in development mode.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage EmailPluginOptions
*/
export interface EmailPluginDevModeOptions extends Omit<EmailPluginOptions, 'transport'> {
devMode: true;
/**
* @description
* The path to which html email files will be saved rather than being sent.
*/
outputPath: string;
/**
* @description
* The route to the dev mailbox server.
*/
route: string;
}
/**
* @description
* A union of all the possible transport options for sending emails.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage Transport Options
*/
export type EmailTransportOptions =
| SMTPTransportOptions
| SendmailTransportOptions
| FileTransportOptions
| NoopTransportOptions
| SESTransportOptions
| TestingTransportOptions;
/**
* @description
* The SMTP transport options of [Nodemailer](https://nodemailer.com/smtp/)
*
* @docsCategory core plugins/EmailPlugin
* @docsPage Transport Options
*/
export interface SMTPTransportOptions extends SMTPTransport.Options {
type: 'smtp';
/**
* @description
* If true, uses the configured {@link VendureLogger} to log messages from Nodemailer as it interacts with
* the SMTP server.
*
* @default false
*/
logging?: boolean;
}
/**
* @description
* The SES transport options of [Nodemailer](https://nodemailer.com/transports/ses//)
*
* See [Nodemailers's SES docs](https://nodemailer.com/transports/ses/) for more details
*
* @example
* ```ts
* import { SES, SendRawEmailCommand } from '\@aws-sdk/client-ses'
*
* const ses = new SES({
* apiVersion: '2010-12-01',
* region: 'eu-central-1',
* credentials: {
* accessKeyId: process.env.SES_ACCESS_KEY || '',
* secretAccessKey: process.env.SES_SECRET_KEY || '',
* },
* })
*
* const config: VendureConfig = {
* // Add an instance of the plugin to the plugins array
* plugins: [
* EmailPlugin.init({
* handler: defaultEmailHandlers,
* templatePath: path.join(__dirname, 'static/email/templates'),
* transport: {
* type: 'ses',
* SES: { ses, aws: { SendRawEmailCommand } },
* sendingRate: 10, // optional messages per second sending rate
* },
* }),
* ],
* };
* ```
* @docsCategory core plugins/EmailPlugin
* @docsPage Transport Options
*/
export interface SESTransportOptions extends SESTransport.Options {
type: 'ses';
}
/**
* @description
* Uses the local Sendmail program to send the email.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage Transport Options
*/
export interface SendmailTransportOptions {
type: 'sendmail';
/** path to the sendmail command (defaults to ‘sendmail’) */
path?: string;
/** either ‘windows’ or ‘unix’ (default). Forces all newlines in the output to either use Windows syntax <CR><LF> or Unix syntax <LF> */
newline?: string;
}
/**
* @description
* Outputs the email as an HTML file for development purposes.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage Transport Options
*/
export interface FileTransportOptions {
type: 'file';
/** The directory in which the emails will be saved */
outputPath: string;
/** When set to true, a raw text file will be output rather than an HTML file */
raw?: boolean;
}
/**
* @description
* Does nothing with the generated email. Intended for use in testing where we don't care about the email transport,
* or when using a custom {@link EmailSender} which does not require transport options.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage Transport Options
*/
export interface NoopTransportOptions {
type: 'none';
}
/**
* @description
* The final, generated email details to be sent.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage Email Plugin Types
*/
export interface EmailDetails<Type extends 'serialized' | 'unserialized' = 'unserialized'> {
from: string;
recipient: string;
subject: string;
body: string;
attachments: Array<Type extends 'serialized' ? SerializedAttachment : Attachment>;
cc?: string;
bcc?: string;
replyTo?: string;
}
/**
* @description
* Forwards the raw GeneratedEmailContext object to a provided callback, for use in testing.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage Transport Options
*/
export interface TestingTransportOptions {
type: 'testing';
/**
* @description
* Callback to be invoked when an email would be sent.
*/
onSend: (details: EmailDetails) => void;
}
/**
* @description
* A function used to load async data for use by an {@link EmailEventHandler}.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage Email Plugin Types
*/
export type LoadDataFn<Event extends EventWithContext, R> = (context: {
event: Event;
injector: Injector;
}) => Promise<R>;
export type OptionalToNullable<O> = {
[K in keyof O]-?: undefined extends O[K] ? NonNullable<O[K]> | null : O[K];
};
/**
* @description
* An object defining a file attachment for an email. Based on the object described
* [here in the Nodemailer docs](https://nodemailer.com/message/attachments/), but
* only uses the `path` property to define a filesystem path or a URL pointing to
* the attachment file.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage Email Plugin Types
*/
export type EmailAttachment = Omit<Attachment, 'raw'> & { path?: string };
export type SerializedAttachment = OptionalToNullable<
Omit<EmailAttachment, 'content'> & { content: string | null }
>;
export type IntermediateEmailDetails = {
ctx: SerializedRequestContext;
type: string;
from: string;
recipient: string;
templateVars: any;
subject: string;
templateFile: string;
attachments: SerializedAttachment[];
cc?: string;
bcc?: string;
replyTo?: string;
};
/**
* @description
* Configures the {@link EmailEventHandler} to handle a particular channel & languageCode
* combination.
*
* @deprecated Use a custom {@link TemplateLoader} instead.
*/
export interface EmailTemplateConfig {
/**
* @description
* Specifies the channel to which this configuration will apply. If set to `'default'`, it will be applied to all
* channels.
*/
channelCode: string | 'default';
/**
* @description
* Specifies the languageCode to which this configuration will apply. If set to `'default'`, it will be applied to all
* languages.
*/
languageCode: LanguageCode | 'default';
/**
* @description
* Defines the file name of the Handlebars template file to be used to when generating this email.
*/
templateFile: string;
/**
* @description
* A string defining the email subject line. Handlebars variables defined in the `templateVars` object may
* be used inside the subject.
*/
subject: string;
}
export interface LoadTemplateInput {
type: string;
templateName: string;
templateVars: any;
}
export interface Partial {
name: string;
content: string;
}
/**
* @description
* A function used to define template variables available to email templates.
* See {@link EmailEventHandler}.setTemplateVars().
*
* @docsCategory core plugins/EmailPlugin
* @docsPage Email Plugin Types
*/
export type SetTemplateVarsFn<Event> = (
event: Event,
globals: { [key: string]: any },
) => { [key: string]: any };
/**
* @description
* A function used to define attachments to be sent with the email.
* See https://nodemailer.com/message/attachments/ for more information about
* how attachments work in Nodemailer.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage Email Plugin Types
*/
export type SetAttachmentsFn<Event> = (event: Event) => EmailAttachment[] | Promise<EmailAttachment[]>;
/**
* @description
* Optional address-related fields for sending the email.
*
* @since 1.1.0
* @docsCategory core plugins/EmailPlugin
* @docsPage Email Plugin Types
*/
export interface OptionalAddressFields {
/**
* @description
* Comma separated list of recipients email addresses that will appear on the _Cc:_ field
*/
cc?: string;
/**
* @description
* Comma separated list of recipients email addresses that will appear on the _Bcc:_ field
*/
bcc?: string;
/**
* @description
* An email address that will appear on the _Reply-To:_ field
*/
replyTo?: string;
}
/**
* @description
* A function used to set the {@link OptionalAddressFields}.
*
* @since 1.1.0
* @docsCategory core plugins/EmailPlugin
* @docsPage Email Plugin Types
*/
export type SetOptionalAddressFieldsFn<Event> = (
event: Event,
) => OptionalAddressFields | Promise<OptionalAddressFields>;
|
import { InjectableStrategy, VendureEvent } from '@vendure/core';
import { EmailDetails, EmailPluginOptions } from '../types';
/**
* @description
* An EmailGenerator generates the subject and body details of an email.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage EmailGenerator
* @docsWeight 0
*/
export interface EmailGenerator<T extends string = any, E extends VendureEvent = any>
extends InjectableStrategy {
/**
* @description
* Any necessary setup can be performed here.
*/
onInit?(options: EmailPluginOptions): void | Promise<void>;
/**
* @description
* Given a subject and body from an email template, this method generates the final
* interpolated email text.
*/
generate(
from: string,
subject: string,
body: string,
templateVars: { [key: string]: any },
): Pick<EmailDetails, 'from' | 'subject' | 'body'>;
}
|
import dateFormat from 'dateformat';
import Handlebars from 'handlebars';
import mjml2html from 'mjml';
import { InitializedEmailPluginOptions } from '../types';
import { EmailGenerator } from './email-generator';
/**
* @description
* Uses Handlebars (https://handlebarsjs.com/) to output MJML (https://mjml.io) which is then
* compiled down to responsive email HTML.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage EmailGenerator
*/
export class HandlebarsMjmlGenerator implements EmailGenerator {
async onInit(options: InitializedEmailPluginOptions) {
if (options.templateLoader.loadPartials) {
const partials = await options.templateLoader.loadPartials();
partials.forEach(({ name, content }) => Handlebars.registerPartial(name, content));
}
this.registerHelpers();
}
generate(from: string, subject: string, template: string, templateVars: any) {
const compiledFrom = Handlebars.compile(from, { noEscape: true });
const compiledSubject = Handlebars.compile(subject);
const compiledTemplate = Handlebars.compile(template);
// We enable prototype properties here, aware of the security implications
// described here: https://handlebarsjs.com/api-reference/runtime-options.html#options-to-control-prototype-access
// This is needed because some Vendure entities use getters on the entity
// prototype (e.g. Order.total) which may need to be interpolated.
const templateOptions: RuntimeOptions = { allowProtoPropertiesByDefault: true };
const fromResult = compiledFrom(templateVars, { allowProtoPropertiesByDefault: true });
const subjectResult = compiledSubject(templateVars, { allowProtoPropertiesByDefault: true });
const mjml = compiledTemplate(templateVars, { allowProtoPropertiesByDefault: true });
const body = mjml2html(mjml).html;
return { from: fromResult, subject: subjectResult, body };
}
private registerHelpers() {
Handlebars.registerHelper('formatDate', (date: Date | undefined, format: string | object) => {
if (!date) {
return date;
}
if (typeof format !== 'string') {
format = 'default';
}
return dateFormat(date, format);
});
Handlebars.registerHelper(
'formatMoney',
(amount?: number, currencyCode?: string, locale?: string) => {
if (amount == null) {
return amount;
}
// Last parameter is a generic "options" object which is not used here.
// If it's supplied, it means the helper function did not receive the additional, optional parameters.
// See https://handlebarsjs.com/api-reference/helpers.html#the-options-parameter
if (!currencyCode || typeof currencyCode === 'object') {
return (amount / 100).toFixed(2);
}
// Same reasoning for `locale` as for `currencyCode` here.
return new Intl.NumberFormat(typeof locale === 'object' ? undefined : locale, {
style: 'currency',
currency: currencyCode,
}).format(amount / 100);
},
);
}
}
|
import { EmailGenerator } from './email-generator';
/**
* Simply passes through the subject and template content without modification.
*/
export class NoopEmailGenerator implements EmailGenerator {
generate(from: string, subject: string, body: string, templateVars: any) {
return { from, subject, body };
}
}
|
/* eslint-disable @typescript-eslint/no-non-null-assertion */
import {
AccountRegistrationEvent,
ConfigService,
EntityHydrator,
IdentifierChangeRequestEvent,
Injector,
NativeAuthenticationMethod,
Order,
OrderStateTransitionEvent,
PasswordResetEvent,
RequestContext,
ShippingLine,
} from '@vendure/core';
import { Request } from 'express';
import { EmailEventListener } from '../event-listener';
import { EmailEventHandler } from './event-handler';
import {
mockAccountRegistrationEvent,
mockEmailAddressChangeEvent,
mockOrderStateTransitionEvent,
mockPasswordResetEvent,
} from './mock-events';
export const orderConfirmationHandler = new EmailEventListener('order-confirmation')
.on(OrderStateTransitionEvent)
.filter(
event =>
event.toState === 'PaymentSettled' && event.fromState !== 'Modifying' && !!event.order.customer,
)
.loadData(async ({ event, injector }) => {
transformOrderLineAssetUrls(event.ctx, event.order, injector);
const shippingLines = await hydrateShippingLines(event.ctx, event.order, injector);
return { shippingLines };
})
.setRecipient(event => event.order.customer!.emailAddress)
.setFrom('{{ fromAddress }}')
.setSubject('Order confirmation for #{{ order.code }}')
.setTemplateVars(event => ({ order: event.order, shippingLines: event.data.shippingLines }))
.setMockEvent(mockOrderStateTransitionEvent);
export const emailVerificationHandler = new EmailEventListener('email-verification')
.on(AccountRegistrationEvent)
.filter(event => !!event.user.getNativeAuthenticationMethod().identifier)
.filter(event => {
const nativeAuthMethod = event.user.authenticationMethods.find(
m => m instanceof NativeAuthenticationMethod,
) as NativeAuthenticationMethod | undefined;
return (nativeAuthMethod && !!nativeAuthMethod.identifier) || false;
})
.setRecipient(event => event.user.identifier)
.setFrom('{{ fromAddress }}')
.setSubject('Please verify your email address')
.setTemplateVars(event => ({
verificationToken: event.user.getNativeAuthenticationMethod().verificationToken,
}))
.setMockEvent(mockAccountRegistrationEvent);
export const passwordResetHandler = new EmailEventListener('password-reset')
.on(PasswordResetEvent)
.setRecipient(event => event.user.identifier)
.setFrom('{{ fromAddress }}')
.setSubject('Forgotten password reset')
.setTemplateVars(event => ({
passwordResetToken: event.user.getNativeAuthenticationMethod().passwordResetToken,
}))
.setMockEvent(mockPasswordResetEvent);
export const emailAddressChangeHandler = new EmailEventListener('email-address-change')
.on(IdentifierChangeRequestEvent)
.setRecipient(event => event.user.getNativeAuthenticationMethod().pendingIdentifier!)
.setFrom('{{ fromAddress }}')
.setSubject('Please verify your change of email address')
.setTemplateVars(event => ({
identifierChangeToken: event.user.getNativeAuthenticationMethod().identifierChangeToken,
}))
.setMockEvent(mockEmailAddressChangeEvent);
export const defaultEmailHandlers: Array<EmailEventHandler<any, any>> = [
orderConfirmationHandler,
emailVerificationHandler,
passwordResetHandler,
emailAddressChangeHandler,
];
/**
* @description
* Applies the configured `AssetStorageStrategy.toAbsoluteUrl()` function to each of the
* OrderLine's `featuredAsset.preview` properties, so that they can be correctly displayed
* in the email template.
* This is required since that step usually happens at the API in middleware, which is not
* applicable in this context. So we need to do it manually.
*
* **Note: Mutates the Order object**
*
* @docsCategory core plugins/EmailPlugin
* @docsPage Email utils
*/
export function transformOrderLineAssetUrls(ctx: RequestContext, order: Order, injector: Injector): Order {
const { assetStorageStrategy } = injector.get(ConfigService).assetOptions;
if (assetStorageStrategy.toAbsoluteUrl) {
const toAbsoluteUrl = assetStorageStrategy.toAbsoluteUrl.bind(assetStorageStrategy);
for (const line of order.lines) {
if (line.featuredAsset) {
line.featuredAsset.preview = toAbsoluteUrl(ctx.req as Request, line.featuredAsset.preview);
}
}
}
return order;
}
/**
* @description
* Ensures that the ShippingLines are hydrated so that we can use the
* `shippingMethod.name` property in the email template.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage Email utils
*/
export async function hydrateShippingLines(
ctx: RequestContext,
order: Order,
injector: Injector,
): Promise<ShippingLine[]> {
const shippingLines: ShippingLine[] = [];
const entityHydrator = injector.get(EntityHydrator);
for (const line of order.shippingLines || []) {
await entityHydrator.hydrate(ctx, line, {
relations: ['shippingMethod'],
});
if (line.shippingMethod) {
shippingLines.push(line);
}
}
return shippingLines;
}
|
import { LanguageCode } from '@vendure/common/lib/generated-types';
import { Type } from '@vendure/common/lib/shared-types';
import { Injector, Logger } from '@vendure/core';
import { serializeAttachments } from '../attachment-utils';
import { loggerCtx } from '../constants';
import { EmailEventListener } from '../event-listener';
import {
EmailAttachment,
EmailTemplateConfig,
EventWithAsyncData,
EventWithContext,
IntermediateEmailDetails,
LoadDataFn,
SetAttachmentsFn,
SetOptionalAddressFieldsFn,
SetTemplateVarsFn,
} from '../types';
/**
* @description
* The EmailEventHandler defines how the EmailPlugin will respond to a given event.
*
* A handler is created by creating a new {@link EmailEventListener} and calling the `.on()` method
* to specify which event to respond to.
*
* @example
* ```ts
* const confirmationHandler = new EmailEventListener('order-confirmation')
* .on(OrderStateTransitionEvent)
* .filter(event => event.toState === 'PaymentSettled')
* .setRecipient(event => event.order.customer.emailAddress)
* .setSubject(`Order confirmation for #{{ order.code }}`)
* .setTemplateVars(event => ({ order: event.order }));
* ```
*
* This example creates a handler which listens for the `OrderStateTransitionEvent` and if the Order has
* transitioned to the `'PaymentSettled'` state, it will generate and send an email.
*
* The string argument passed into the `EmailEventListener` constructor is used to identify the handler, and
* also to locate the directory of the email template files. So in the example above, there should be a directory
* `<app root>/static/email/templates/order-confirmation` which contains a Handlebars template named `body.hbs`.
*
* ## Handling other languages
*
* By default, the handler will respond to all events on all channels and use the same subject ("Order confirmation for #12345" above)
* and body template. Where the server is intended to support multiple languages, the `.addTemplate()` method may be used
* to define the subject and body template for specific language and channel combinations.
*
* The language is determined by looking at the `languageCode` property of the event's `ctx` ({@link RequestContext}) object.
*
* @example
* ```ts
* const extendedConfirmationHandler = confirmationHandler
* .addTemplate({
* channelCode: 'default',
* languageCode: LanguageCode.de,
* templateFile: 'body.de.hbs',
* subject: 'Bestellbestätigung für #{{ order.code }}',
* })
* ```
*
* ## Defining a custom handler
*
* Let's say you have a plugin which defines a new event type, `QuoteRequestedEvent`. In your plugin you have defined a mutation
* which is executed when the customer requests a quote in your storefront, and in your resolver, you use the {@link EventBus} to publish a
* new `QuoteRequestedEvent`.
*
* You now want to email the customer with their quote. Here are the steps you would take to set this up:
*
* ### 1. Create a new handler
*
* ```ts
* import { EmailEventListener } from `\@vendure/email-plugin`;
* import { QuoteRequestedEvent } from `./events`;
*
* const quoteRequestedHandler = new EmailEventListener('quote-requested')
* .on(QuoteRequestedEvent)
* .setRecipient(event => event.customer.emailAddress)
* .setSubject(`Here's the quote you requested`)
* .setTemplateVars(event => ({ details: event.details }));
* ```
*
* ### 2. Create the email template
*
* Next you need to make sure there is a template defined at `<app root>/static/email/templates/quote-requested/body.hbs`. The template
* would look something like this:
*
* ```handlebars
* {{> header title="Here's the quote you requested" }}
*
* <mj-section background-color="#fafafa">
* <mj-column>
* <mj-text color="#525252">
* Thank you for your interest in our products! Here's the details
* of the quote you recently requested:
* </mj-text>
*
* <--! your custom email layout goes here -->
* </mj-column>
* </mj-section>
*
*
* {{> footer }}
* ```
*
* You can find pre-made templates on the [MJML website](https://mjml.io/templates/).
*
* ### 3. Register the handler
*
* Finally, you need to register the handler with the EmailPlugin:
*
* ```ts {hl_lines=[8]}
* import { defaultEmailHandlers, EmailPlugin } from '\@vendure/email-plugin';
* import { quoteRequestedHandler } from './plugins/quote-plugin';
*
* const config: VendureConfig = {
* // Add an instance of the plugin to the plugins array
* plugins: [
* EmailPlugin.init({
* handler: [...defaultEmailHandlers, quoteRequestedHandler],
* templatePath: path.join(__dirname, 'vendure/email/templates'),
* // ... etc
* }),
* ],
* };
* ```
*
* @docsCategory core plugins/EmailPlugin
*/
export class EmailEventHandler<T extends string = string, Event extends EventWithContext = EventWithContext> {
private setRecipientFn: (event: Event) => string;
private setLanguageCodeFn: (event: Event) => LanguageCode | undefined;
private setTemplateVarsFn: SetTemplateVarsFn<Event>;
private setAttachmentsFn?: SetAttachmentsFn<Event>;
private setOptionalAddressFieldsFn?: SetOptionalAddressFieldsFn<Event>;
private filterFns: Array<(event: Event) => boolean> = [];
private configurations: EmailTemplateConfig[] = [];
private defaultSubject: string;
private from: string;
private optionalAddressFields: {
cc?: string;
bcc?: string;
};
private _mockEvent: Omit<Event, 'ctx' | 'data'> | undefined;
constructor(public listener: EmailEventListener<T>, public event: Type<Event>) {}
/** @internal */
get type(): T {
return this.listener.type;
}
/** @internal */
get mockEvent(): Omit<Event, 'ctx' | 'data'> | undefined {
return this._mockEvent;
}
/**
* @description
* Defines a predicate function which is used to determine whether the event will trigger an email.
* Multiple filter functions may be defined.
*/
filter(filterFn: (event: Event) => boolean): EmailEventHandler<T, Event> {
this.filterFns.push(filterFn);
return this;
}
/**
* @description
* A function which defines how the recipient email address should be extracted from the incoming event.
*
* The recipient can be a plain email address: `'foobar@example.com'`
* Or with a formatted name (includes unicode support): `'Ноде Майлер <foobar@example.com>'`
* Or a comma-separated list of addresses: `'foobar@example.com, "Ноде Майлер" <bar@example.com>'`
*/
setRecipient(setRecipientFn: (event: Event) => string): EmailEventHandler<T, Event> {
this.setRecipientFn = setRecipientFn;
return this;
}
/**
* @description
* A function which allows to override the language of the email. If not defined, the language from the context will be used.
*
* @since 1.8.0
*/
setLanguageCode(
setLanguageCodeFn: (event: Event) => LanguageCode | undefined,
): EmailEventHandler<T, Event> {
this.setLanguageCodeFn = setLanguageCodeFn;
return this;
}
/**
* @description
* A function which returns an object hash of variables which will be made available to the Handlebars template
* and subject line for interpolation.
*/
setTemplateVars(templateVarsFn: SetTemplateVarsFn<Event>): EmailEventHandler<T, Event> {
this.setTemplateVarsFn = templateVarsFn;
return this;
}
/**
* @description
* Sets the default subject of the email. The subject string may use Handlebars variables defined by the
* setTemplateVars() method.
*/
setSubject(defaultSubject: string): EmailEventHandler<T, Event> {
this.defaultSubject = defaultSubject;
return this;
}
/**
* @description
* Sets the default from field of the email. The from string may use Handlebars variables defined by the
* setTemplateVars() method.
*/
setFrom(from: string): EmailEventHandler<T, Event> {
this.from = from;
return this;
}
/**
* @description
* A function which allows {@link OptionalAddressFields} to be specified such as "cc" and "bcc".
*
* @since 1.1.0
*/
setOptionalAddressFields(optionalAddressFieldsFn: SetOptionalAddressFieldsFn<Event>) {
this.setOptionalAddressFieldsFn = optionalAddressFieldsFn;
return this;
}
/**
* @description
* Defines one or more files to be attached to the email. An attachment can be specified
* as either a `path` (to a file or URL) or as `content` which can be a string, Buffer or Stream.
*
* **Note:** When using the `content` to pass a Buffer or Stream, the raw data will get serialized
* into the job queue. For this reason the total size of all attachments passed as `content` should kept to
* **less than ~50k**. If the attachments are greater than that limit, a warning will be logged and
* errors may result if using the DefaultJobQueuePlugin with certain DBs such as MySQL/MariaDB.
*
* @example
* ```ts
* const testAttachmentHandler = new EmailEventListener('activate-voucher')
* .on(ActivateVoucherEvent)
* // ... omitted some steps for brevity
* .setAttachments(async (event) => {
* const { imageUrl, voucherCode } = await getVoucherDataForUser(event.user.id);
* return [
* {
* filename: `voucher-${voucherCode}.jpg`,
* path: imageUrl,
* },
* ];
* });
* ```
*/
setAttachments(setAttachmentsFn: SetAttachmentsFn<Event>) {
this.setAttachmentsFn = setAttachmentsFn;
return this;
}
/**
* @description
* Add configuration for another template other than the default `"body.hbs"`. Use this method to define specific
* templates for channels or languageCodes other than the default.
*
* @deprecated Define a custom TemplateLoader on plugin initalization to define templates based on the RequestContext.
* E.g. `EmailPlugin.init({ templateLoader: new CustomTemplateLoader() })`
*/
addTemplate(config: EmailTemplateConfig): EmailEventHandler<T, Event> {
this.configurations.push(config);
return this;
}
/**
* @description
* Allows data to be loaded asynchronously which can then be used as template variables.
* The `loadDataFn` has access to the event, the TypeORM `Connection` object, and an
* `inject()` function which can be used to inject any of the providers exported
* by the {@link PluginCommonModule}. The return value of the `loadDataFn` will be
* added to the `event` as the `data` property.
*
* @example
* ```ts
* new EmailEventListener('order-confirmation')
* .on(OrderStateTransitionEvent)
* .filter(event => event.toState === 'PaymentSettled' && !!event.order.customer)
* .loadData(({ event, injector }) => {
* const orderService = injector.get(OrderService);
* return orderService.getOrderPayments(event.order.id);
* })
* .setTemplateVars(event => ({
* order: event.order,
* payments: event.data,
* }));
* ```
*/
loadData<R>(
loadDataFn: LoadDataFn<Event, R>,
): EmailEventHandlerWithAsyncData<R, T, Event, EventWithAsyncData<Event, R>> {
const asyncHandler = new EmailEventHandlerWithAsyncData(loadDataFn, this.listener, this.event);
asyncHandler.setRecipientFn = this.setRecipientFn;
asyncHandler.setTemplateVarsFn = this.setTemplateVarsFn;
asyncHandler.setAttachmentsFn = this.setAttachmentsFn;
asyncHandler.setOptionalAddressFieldsFn = this.setOptionalAddressFieldsFn;
asyncHandler.filterFns = this.filterFns;
asyncHandler.configurations = this.configurations;
asyncHandler.defaultSubject = this.defaultSubject;
asyncHandler.from = this.from;
asyncHandler._mockEvent = this._mockEvent as any;
return asyncHandler;
}
/**
* @description
* Used internally by the EmailPlugin to handle incoming events.
*
* @internal
*/
async handle(
event: Event,
globals: { [key: string]: any } = {},
injector: Injector,
): Promise<IntermediateEmailDetails | undefined> {
for (const filterFn of this.filterFns) {
if (!filterFn(event)) {
return;
}
}
if (this instanceof EmailEventHandlerWithAsyncData) {
try {
(event as EventWithAsyncData<Event, any>).data = await this._loadDataFn({
event,
injector,
});
} catch (err: unknown) {
if (err instanceof Error) {
Logger.error(err.message, loggerCtx, err.stack);
} else {
Logger.error(String(err), loggerCtx);
}
return;
}
}
if (!this.setRecipientFn) {
throw new Error(
`No setRecipientFn has been defined. ` +
`Remember to call ".setRecipient()" when setting up the EmailEventHandler for ${this.type}`,
);
}
if (this.from === undefined) {
throw new Error(
`No from field has been defined. ` +
`Remember to call ".setFrom()" when setting up the EmailEventHandler for ${this.type}`,
);
}
const { ctx } = event;
const languageCode = this.setLanguageCodeFn?.(event) || ctx.languageCode;
const configuration = this.getBestConfiguration(ctx.channel.code, languageCode);
const subject = configuration ? configuration.subject : this.defaultSubject;
if (subject == null) {
throw new Error(
`No subject field has been defined. ` +
`Remember to call ".setSubject()" when setting up the EmailEventHandler for ${this.type}`,
);
}
const recipient = this.setRecipientFn(event);
const templateVars = this.setTemplateVarsFn ? this.setTemplateVarsFn(event, globals) : {};
let attachmentsArray: EmailAttachment[] = [];
try {
attachmentsArray = (await this.setAttachmentsFn?.(event)) ?? [];
} catch (e: any) {
Logger.error(e, loggerCtx, e.stack);
}
const attachments = await serializeAttachments(attachmentsArray);
const optionalAddressFields = (await this.setOptionalAddressFieldsFn?.(event)) ?? {};
return {
ctx: event.ctx.serialize(),
type: this.type,
recipient,
from: this.from,
templateVars: { ...globals, ...templateVars },
subject,
templateFile: configuration ? configuration.templateFile : 'body.hbs',
attachments,
...optionalAddressFields,
};
}
/**
* @description
* Optionally define a mock Event which is used by the dev mode mailbox app for generating mock emails
* from this handler, which is useful when developing the email templates.
*/
setMockEvent(event: Omit<Event, 'ctx' | 'data'>): EmailEventHandler<T, Event> {
this._mockEvent = event;
return this;
}
private getBestConfiguration(
channelCode: string,
languageCode: LanguageCode,
): EmailTemplateConfig | undefined {
if (this.configurations.length === 0) {
return;
}
const exactMatch = this.configurations.find(c => {
return (
(c.channelCode === channelCode || c.channelCode === 'default') &&
c.languageCode === languageCode
);
});
if (exactMatch) {
return exactMatch;
}
const channelMatch = this.configurations.find(
c => c.channelCode === channelCode && c.languageCode === 'default',
);
if (channelMatch) {
return channelMatch;
}
return;
}
}
/**
* @description
* Identical to the {@link EmailEventHandler} but with a `data` property added to the `event` based on the result
* of the `.loadData()` function.
*
* @docsCategory core plugins/EmailPlugin
*/
export class EmailEventHandlerWithAsyncData<
Data,
T extends string = string,
InputEvent extends EventWithContext = EventWithContext,
Event extends EventWithAsyncData<InputEvent, Data> = EventWithAsyncData<InputEvent, Data>,
> extends EmailEventHandler<T, Event> {
constructor(
public _loadDataFn: LoadDataFn<InputEvent, Data>,
listener: EmailEventListener<T>,
event: Type<InputEvent>,
) {
super(listener, event as any);
}
}
|
import { AdjustmentType } from '@vendure/common/lib/generated-shop-types';
import {
AccountRegistrationEvent,
CurrencyCode,
Customer,
IdentifierChangeRequestEvent,
NativeAuthenticationMethod,
Order,
OrderLine,
OrderStateTransitionEvent,
PasswordResetEvent,
ProductVariant,
ShippingLine,
User,
} from '@vendure/core';
export const mockOrderStateTransitionEvent = new OrderStateTransitionEvent(
'ArrangingPayment',
'PaymentSettled',
{} as any,
new Order({
id: '6',
currencyCode: CurrencyCode.USD,
createdAt: '2018-10-31T11:18:29.261Z',
updatedAt: '2018-10-31T15:24:17.000Z',
orderPlacedAt: '2018-10-31T13:54:17.000Z',
code: 'T3EPGJKTVZPBD6Z9',
state: 'ArrangingPayment',
active: true,
customer: new Customer({
id: '3',
firstName: 'Test',
lastName: 'Customer',
emailAddress: 'test@test.com',
}),
lines: [
new OrderLine({
id: '5',
featuredAsset: {
preview: '/mailbox/placeholder-image',
},
productVariant: new ProductVariant({
id: '2',
name: 'Curvy Monitor 24 inch',
sku: 'C24F390',
}),
quantity: 1,
listPrice: 14374,
listPriceIncludesTax: true,
adjustments: [
{
adjustmentSource: 'Promotion:1',
type: AdjustmentType.PROMOTION,
amount: -1000 as any,
description: '$10 off computer equipment',
},
],
taxLines: [],
}),
new OrderLine({
id: '6',
featuredAsset: {
preview: '/mailbox/placeholder-image',
},
productVariant: new ProductVariant({
id: '4',
name: 'Hard Drive 1TB',
sku: 'IHD455T1',
}),
quantity: 1,
listPrice: 3799,
listPriceIncludesTax: true,
adjustments: [],
taxLines: [],
}),
],
subTotal: 15144,
subTotalWithTax: 18173,
shipping: 1000,
shippingLines: [
new ShippingLine({
listPrice: 1000,
listPriceIncludesTax: true,
taxLines: [{ taxRate: 20, description: 'shipping tax' }],
shippingMethod: {
code: 'express-flat-rate',
name: 'Express Shipping',
description: 'Express Shipping',
id: '2',
},
}),
],
surcharges: [],
shippingAddress: {
fullName: 'Test Customer',
company: '',
streetLine1: '6000 Pagac Land',
streetLine2: '',
city: 'Port Kirsten',
province: 'Avon',
postalCode: 'ZU32 9CP',
country: 'Cabo Verde',
phoneNumber: '',
},
payments: [],
}),
);
export const mockAccountRegistrationEvent = new AccountRegistrationEvent(
{} as any,
new User({
verified: false,
authenticationMethods: [
new NativeAuthenticationMethod({
identifier: 'test@test.com',
verificationToken: 'MjAxOC0xMS0xM1QxNToxNToxNC42ODda_US2U6UK1WZC7NDAX',
}),
],
identifier: 'test@test.com',
}),
);
export const mockPasswordResetEvent = new PasswordResetEvent(
{} as any,
new User({
identifier: 'test@test.com',
authenticationMethods: [
new NativeAuthenticationMethod({
passwordResetToken: 'MjAxOS0wNC0xNVQxMzozMDozOC43MjFa_MA2FR6HRZBW7JWD6',
}),
],
}),
);
export const mockEmailAddressChangeEvent = new IdentifierChangeRequestEvent(
{} as any,
new User({
identifier: 'old-address@test.com',
authenticationMethods: [
new NativeAuthenticationMethod({
pendingIdentifier: 'new-address@test.com',
identifierChangeToken: 'MjAxOS0wNC0xNVQxMzozMDozOC43MjFa_MA2FR6HRZBW7JWD6',
}),
],
}),
);
|
import { InjectableStrategy } from '@vendure/core';
import { EmailDetails, EmailTransportOptions } from '../types';
/**
* @description
* An EmailSender is responsible for sending the email, e.g. via an SMTP connection
* or using some other mail-sending API. By default, the EmailPlugin uses the
* {@link NodemailerEmailSender}, but it is also possible to supply a custom implementation:
*
* @example
* ```ts
* const sgMail = require('\@sendgrid/mail');
*
* sgMail.setApiKey(process.env.SENDGRID_API_KEY);
*
* class SendgridEmailSender implements EmailSender {
* async send(email: EmailDetails) {
* await sgMail.send({
* to: email.recipient,
* from: email.from,
* subject: email.subject,
* html: email.body,
* });
* }
* }
*
* const config: VendureConfig = {
* logger: new DefaultLogger({ level: LogLevel.Debug })
* // ...
* plugins: [
* EmailPlugin.init({
* // ... template, handler config omitted
* transport: { type: 'none' },
* emailSender: new SendgridEmailSender(),
* }),
* ],
* };
* ```
*
* @docsCategory core plugins/EmailPlugin
* @docsPage EmailSender
* @docsWeight 0
*/
export interface EmailSender extends InjectableStrategy {
send: (email: EmailDetails, options: EmailTransportOptions) => void | Promise<void>;
}
|
import { normalizeString } from '@vendure/common/lib/normalize-string';
import { assertNever } from '@vendure/common/lib/shared-utils';
import { Logger } from '@vendure/core';
import fs from 'fs-extra';
import { createTransport } from 'nodemailer';
import { default as Mail } from 'nodemailer/lib/mailer';
import { LoggerLevel } from 'nodemailer/lib/shared';
import path from 'path';
import { Stream } from 'stream';
import { format } from 'util';
import { loggerCtx } from '../constants';
import {
EmailDetails,
EmailTransportOptions,
SendmailTransportOptions,
SESTransportOptions,
SMTPTransportOptions,
} from '../types';
import { EmailSender } from './email-sender';
export type StreamTransportInfo = {
envelope: {
from: string;
to: string[];
};
messageId: string;
message: Stream;
};
/**
* @description
* Uses the configured transport to send the generated email.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage EmailSender
*/
export class NodemailerEmailSender implements EmailSender {
private _smtpTransport: Mail | undefined;
private _sendMailTransport: Mail | undefined;
private _sesTransport: Mail | undefined;
async send(email: EmailDetails, options: EmailTransportOptions) {
switch (options.type) {
case 'none':
return;
break;
case 'file':
const fileName = normalizeString(
`${new Date().toISOString()} ${email.recipient} ${email.subject}`,
'_',
);
const filePath = path.join(options.outputPath, fileName);
if (options.raw) {
await this.sendFileRaw(email, filePath);
} else {
await this.sendFileJson(email, filePath);
}
break;
case 'sendmail':
await this.sendMail(email, this.getSendMailTransport(options));
break;
case 'ses':
await this.sendMail(email, this.getSesTransport(options));
break;
case 'smtp':
await this.sendMail(email, this.getSmtpTransport(options));
break;
case 'testing':
options.onSend(email);
break;
default:
return assertNever(options);
}
}
private getSmtpTransport(options: SMTPTransportOptions) {
if (!this._smtpTransport) {
(options as any).logger = options.logging ? this.createLogger() : false;
this._smtpTransport = createTransport(options);
}
return this._smtpTransport;
}
private getSesTransport(options: SESTransportOptions) {
if (!this._sesTransport) {
this._sesTransport = createTransport(options);
}
return this._sesTransport;
}
private getSendMailTransport(options: SendmailTransportOptions) {
if (!this._sendMailTransport) {
this._sendMailTransport = createTransport({ sendmail: true, ...options });
}
return this._sendMailTransport;
}
private async sendMail(email: EmailDetails, transporter: Mail): Promise<any> {
return transporter.sendMail({
from: email.from,
to: email.recipient,
subject: email.subject,
html: email.body,
attachments: email.attachments,
cc: email.cc,
bcc: email.bcc,
replyTo: email.replyTo,
});
}
private async sendFileJson(email: EmailDetails, pathWithoutExt: string) {
const output = {
date: new Date().toLocaleString(),
from: email.from,
recipient: email.recipient,
subject: email.subject,
body: email.body,
cc: email.cc,
bcc: email.bcc,
replyTo: email.replyTo,
};
await fs.writeFile(pathWithoutExt + '.json', JSON.stringify(output, null, 2));
}
private async sendFileRaw(email: EmailDetails, pathWithoutExt: string) {
const transporter = createTransport({
streamTransport: true,
buffer: true,
});
const result = await this.sendMail(email, transporter);
await this.writeStreamToFile(pathWithoutExt + '.txt', result);
}
private async writeStreamToFile(filePath: string, info: StreamTransportInfo): Promise<string> {
const writeStream = fs.createWriteStream(filePath);
return new Promise<string>((resolve, reject) => {
writeStream.on('open', () => {
info.message.pipe(writeStream);
writeStream.on('close', resolve);
writeStream.on('error', reject);
});
});
}
/**
* Adapts the VendureLogger to work with the bunyan-compatible logger format
* used by Nodemailer.
*/
private createLogger() {
function formatError(args: [object, string, ...string[]]) {
const [ctx, message, ...params] = args;
return format(message, ...params);
}
return {
level(level: LoggerLevel) {
/* noop */
},
trace(...params: any) {
Logger.debug(formatError(params), loggerCtx);
},
debug(...params: any) {
Logger.verbose(formatError(params), loggerCtx);
},
info(...params: any) {
Logger.info(formatError(params), loggerCtx);
},
warn(...params: any) {
Logger.warn(formatError(params), loggerCtx);
},
error(...params: any) {
Logger.error(formatError(params), loggerCtx);
},
fatal(...params: any) {
Logger.error(formatError(params), loggerCtx);
},
};
}
}
|
import { Injector, RequestContext } from '@vendure/core';
import fs from 'fs/promises';
import path from 'path';
import { LoadTemplateInput, Partial } from '../types';
import { TemplateLoader } from './template-loader';
/**
* @description
* Loads email templates from the local file system. This is the default
* loader used by the EmailPlugin.
*
* @docsCategory core plugins/EmailPlugin
* @docsPage TemplateLoader
*/
export class FileBasedTemplateLoader implements TemplateLoader {
constructor(private templatePath: string) {}
async loadTemplate(
_injector: Injector,
_ctx: RequestContext,
{ type, templateName }: LoadTemplateInput,
): Promise<string> {
const templatePath = path.join(this.templatePath, type, templateName);
return fs.readFile(templatePath, 'utf-8');
}
async loadPartials(): Promise<Partial[]> {
const partialsPath = path.join(this.templatePath, 'partials');
const partialsFiles = await fs.readdir(partialsPath);
return Promise.all(
partialsFiles.map(async file => {
return {
name: path.basename(file, '.hbs'),
content: await fs.readFile(path.join(partialsPath, file), 'utf-8'),
};
}),
);
}
}
|
import { Injector, RequestContext } from '@vendure/core';
import { LoadTemplateInput, Partial } from '../types';
/**
* @description
* Loads email templates based on the given request context, type and template name
* and return the template as a string.
*
* @example
* ```ts
* import { EmailPlugin, TemplateLoader } from '\@vendure/email-plugin';
*
* class MyTemplateLoader implements TemplateLoader {
* loadTemplate(injector, ctx, { type, templateName }){
* return myCustomTemplateFunction(ctx);
* }
* }
*
* // In vendure-config.ts:
* ...
* EmailPlugin.init({
* templateLoader: new MyTemplateLoader()
* ...
* })
* ```
*
* @docsCategory core plugins/EmailPlugin
* @docsPage TemplateLoader
* @docsWeight 0
*/
export interface TemplateLoader {
/**
* @description
* Load template and return it's content as a string
*/
loadTemplate(injector: Injector, ctx: RequestContext, input: LoadTemplateInput): Promise<string>;
/**
* @description
* Load partials and return their contents.
* This method is only called during initialization, i.e. during server startup.
*/
loadPartials?(): Promise<Partial[]>;
}
|
export * from './src/harden.plugin';
export * from './src/types';
export * from './src/middleware/query-complexity-plugin';
|
export const loggerCtx = 'HardenPlugin';
export const HARDEN_PLUGIN_OPTIONS = Symbol('HARDEN_PLUGIN_OPTIONS');
|
import { Logger, VendurePlugin } from '@vendure/core';
import { HARDEN_PLUGIN_OPTIONS, loggerCtx } from './constants';
import { HideValidationErrorsPlugin } from './middleware/hide-validation-errors-plugin';
import { QueryComplexityPlugin } from './middleware/query-complexity-plugin';
import { HardenPluginOptions } from './types';
/**
* @description
* The HardenPlugin hardens the Shop and Admin GraphQL APIs against attacks and abuse.
*
* - It analyzes the complexity on incoming graphql queries and rejects queries that are too complex and
* could be used to overload the resources of the server.
* - It disables dev-mode API features such as introspection and the GraphQL playground app.
* - It removes field name suggestions to prevent trial-and-error schema sniffing.
*
* It is a recommended plugin for all production configurations.
*
* ## Installation
*
* `yarn add \@vendure/harden-plugin`
*
* or
*
* `npm install \@vendure/harden-plugin`
*
* Then add the `HardenPlugin`, calling the `.init()` method with {@link HardenPluginOptions}:
*
* @example
* ```ts
* import { HardenPlugin } from '\@vendure/harden-plugin';
*
* const config: VendureConfig = {
* // Add an instance of the plugin to the plugins array
* plugins: [
* HardenPlugin.init({
* maxQueryComplexity: 650,
* apiMode: process.env.APP_ENV === 'dev' ? 'dev' : 'prod',
* }),
* ],
* };
* ```
*
* ## Setting the max query complexity
*
* The `maxQueryComplexity` option determines how complex a query can be. The complexity of a query relates to how many, and how
* deeply-nested are the fields being selected, and is intended to roughly correspond to the amount of server resources that would
* be required to resolve that query.
*
* The goal of this setting is to prevent attacks in which a malicious actor crafts a very complex query in order to overwhelm your
* server resources. Here's an example of a request which would likely overwhelm a Vendure server:
*
* ```GraphQL
* query EvilQuery {
* products {
* items {
* collections {
* productVariants {
* items {
* product {
* collections {
* productVariants {
* items {
* product {
* variants {
* name
* }
* }
* }
* }
* }
* }
* }
* }
* }
* }
* }
* }
* ```
*
* This evil query has a complexity score of 2,443,203 - much greater than the default of 1,000!
*
* The complexity score is calculated by the [graphql-query-complexity library](https://www.npmjs.com/package/graphql-query-complexity),
* and by default uses the {@link defaultVendureComplexityEstimator}, which is tuned specifically to the Vendure Shop API.
*
* :::caution
* Note: By default, if the "take" argument is omitted from a list query (e.g. the `products` or `collections` query), a default factor of 1000 is applied.
* :::
*
* The optimal max complexity score will vary depending on:
*
* - The requirements of your storefront and other clients using the Shop API
* - The resources available to your server
*
* You should aim to set the maximum as low as possible while still being able to service all the requests required.
* This will take some manual tuning.
* While tuning the max, you can turn on the `logComplexityScore` to get a detailed breakdown of the complexity of each query, as well as how
* that total score is derived from its child fields:
*
* @example
* ```ts
* import { HardenPlugin } from '\@vendure/harden-plugin';
*
* const config: VendureConfig = {
* // A detailed summary is logged at the "debug" level
* logger: new DefaultLogger({ level: LogLevel.Debug }),
* plugins: [
* HardenPlugin.init({
* maxQueryComplexity: 650,
* logComplexityScore: true,
* }),
* ],
* };
* ```
*
* With logging configured as above, the following query:
*
* ```GraphQL
* query ProductList {
* products(options: { take: 5 }) {
* items {
* id
* name
* featuredAsset {
* preview
* }
* }
* }
* }
* ```
* will log the following breakdown:
*
* ```sh
* debug 16/12/22, 14:12 - [HardenPlugin] Calculating complexity of [ProductList]
* debug 16/12/22, 14:12 - [HardenPlugin] Product.id: ID! childComplexity: 0, score: 1
* debug 16/12/22, 14:12 - [HardenPlugin] Product.name: String! childComplexity: 0, score: 1
* debug 16/12/22, 14:12 - [HardenPlugin] Asset.preview: String! childComplexity: 0, score: 1
* debug 16/12/22, 14:12 - [HardenPlugin] Product.featuredAsset: Asset childComplexity: 1, score: 2
* debug 16/12/22, 14:12 - [HardenPlugin] ProductList.items: [Product!]! childComplexity: 4, score: 20
* debug 16/12/22, 14:12 - [HardenPlugin] Query.products: ProductList! childComplexity: 20, score: 35
* verbose 16/12/22, 14:12 - [HardenPlugin] Query complexity [ProductList]: 35
* ```
*
* @docsCategory core plugins/HardenPlugin
*/
@VendurePlugin({
providers: [
{
provide: HARDEN_PLUGIN_OPTIONS,
useFactory: () => HardenPlugin.options,
},
],
configuration: config => {
if (HardenPlugin.options.hideFieldSuggestions !== false) {
Logger.verbose('Configuring HideValidationErrorsPlugin', loggerCtx);
config.apiOptions.apolloServerPlugins.push(new HideValidationErrorsPlugin());
}
config.apiOptions.apolloServerPlugins.push(new QueryComplexityPlugin(HardenPlugin.options));
if (HardenPlugin.options.apiMode !== 'dev') {
config.apiOptions.adminApiDebug = false;
config.apiOptions.shopApiDebug = false;
config.apiOptions.introspection = false;
}
return config;
},
compatibility: '^2.0.0',
})
export class HardenPlugin {
static options: HardenPluginOptions;
static init(options: HardenPluginOptions) {
this.options = options;
return HardenPlugin;
}
}
|
import { ComplexityEstimator } from 'graphql-query-complexity';
/**
* @description
* Options that can be passed to the `.init()` static method of the HardenPlugin.
*
* @docsCategory core plugins/HardenPlugin
*/
export interface HardenPluginOptions {
/**
* @description
* Defines the maximum permitted complexity score of a query. The complexity score is based
* on the number of fields being selected as well as other factors like whether there are nested
* lists.
*
* A query which exceeds the maximum score will result in an error.
*
* @default 1000
*/
maxQueryComplexity?: number;
/**
* @description
* An array of custom estimator functions for calculating the complexity of a query. By default,
* the plugin will use the {@link defaultVendureComplexityEstimator} which is specifically
* tuned to accurately estimate Vendure queries.
*/
queryComplexityEstimators?: ComplexityEstimator[];
/**
* @description
* When set to `true`, the complexity score of each query will be logged at the Verbose
* log level, and a breakdown of the calculation for each field will be logged at the Debug level.
*
* This is very useful for tuning your complexity scores.
*
* @default false
*/
logComplexityScore?: boolean;
/**
* @description
* This object allows you to tune the complexity weight of specific fields. For example,
* if you have a custom `stockLocations` field defined on the `ProductVariant` type, and
* you know that it is a particularly expensive operation to execute, you can increase
* its complexity like this:
*
* @example
* ```ts
* HardenPlugin.init({
* maxQueryComplexity: 650,
* customComplexityFactors: {
* 'ProductVariant.stockLocations': 10
* }
* }),
* ```
*/
customComplexityFactors?: {
[path: string]: number;
};
/**
* @description
* Graphql-js will make suggestions about the names of fields if an invalid field name is provided.
* This would allow an attacker to find out the available fields by brute force even if introspection
* is disabled.
*
* Setting this option to `true` will prevent these suggestion error messages from being returned,
* instead replacing the message with a generic "Invalid request" message.
*
* @default true
*/
hideFieldSuggestions?: boolean;
/**
* @description
* When set to `'prod'`, the plugin will disable dev-mode features of the GraphQL APIs:
*
* - introspection
* - GraphQL playground
*
* @default 'prod'
*/
apiMode?: 'dev' | 'prod';
}
|
import { ApolloServerPlugin, GraphQLRequestListener } from '@apollo/server';
import { GraphQLError } from 'graphql/error/index';
/**
* @description
* Hides graphql-js suggestions when invalid field names are given.
* Based on ideas discussed in https://github.com/apollographql/apollo-server/issues/3919
*/
export class HideValidationErrorsPlugin implements ApolloServerPlugin {
async requestDidStart(): Promise<GraphQLRequestListener<any>> {
return {
willSendResponse: async requestContext => {
const { errors } = requestContext;
if (errors) {
(requestContext.response as any).errors = errors.map(err => {
if (err.message.includes('Did you mean')) {
return new GraphQLError('Invalid request');
} else {
return err;
}
});
}
},
};
}
}
|
import { ApolloServerPlugin, GraphQLRequestListener, GraphQLRequestContext } from '@apollo/server';
import { InternalServerError, Logger } from '@vendure/core';
import {
getNamedType,
getNullableType,
GraphQLSchema,
isListType,
isObjectType,
separateOperations,
} from 'graphql';
import { ComplexityEstimatorArgs, getComplexity, simpleEstimator } from 'graphql-query-complexity';
import { loggerCtx } from '../constants';
import { HardenPluginOptions } from '../types';
/**
* @description
* Implements query complexity analysis on Shop API requests.
*/
export class QueryComplexityPlugin implements ApolloServerPlugin {
constructor(private options: HardenPluginOptions) {}
async requestDidStart({ schema }: GraphQLRequestContext<any>): Promise<GraphQLRequestListener<any>> {
const maxQueryComplexity = this.options.maxQueryComplexity ?? 1000;
return {
didResolveOperation: async ({ request, document }) => {
if (isAdminApi(schema)) {
// We don't want to apply the cost analysis on the
// Admin API, since any expensive operations would require
// an authenticated session.
return;
}
const query = request.operationName
? separateOperations(document)[request.operationName]
: document;
if (this.options.logComplexityScore === true) {
Logger.debug(
`Calculating complexity of "${request.operationName ?? 'anonymous'}"`,
loggerCtx,
);
}
const complexity = getComplexity({
schema,
query,
variables: request.variables,
estimators: this.options.queryComplexityEstimators ?? [
defaultVendureComplexityEstimator(
this.options.customComplexityFactors ?? {},
this.options.logComplexityScore ?? false,
),
simpleEstimator({ defaultComplexity: 1 }),
],
});
if (this.options.logComplexityScore === true) {
Logger.verbose(
`Query complexity "${request.operationName ?? 'anonymous'}": ${complexity}`,
loggerCtx,
);
}
if (complexity >= maxQueryComplexity) {
Logger.error(
`Query complexity of "${
request.operationName ?? 'anonymous'
}" is ${complexity}, which exceeds the maximum of ${maxQueryComplexity}`,
loggerCtx,
);
throw new InternalServerError('Query is too complex');
}
},
};
}
}
function isAdminApi(schema: GraphQLSchema): boolean {
const queryType = schema.getQueryType();
if (queryType) {
return !!queryType.getFields().administrators;
}
return false;
}
/**
* @description
* A complexity estimator which takes into account List and PaginatedList types and can
* be further configured by providing a customComplexityFactors object.
*
* When selecting PaginatedList types, the "take" argument is used to estimate a complexity
* factor. If the "take" argument is omitted, a default factor of 1000 is applied.
*
* @docsCategory core plugins/HardenPlugin
*/
export function defaultVendureComplexityEstimator(
customComplexityFactors: { [path: string]: number },
logFieldScores: boolean,
) {
return (options: ComplexityEstimatorArgs): number | void => {
const { type, args, childComplexity, field } = options;
const namedType = getNamedType(field.type);
const path = `${type.name}.${field.name}`;
let result = childComplexity + 1;
const customFactor = customComplexityFactors[path];
if (customFactor != null) {
result = Math.max(childComplexity, 1) * customFactor;
} else {
if (isObjectType(namedType)) {
const isPaginatedList = !!namedType.getInterfaces().find(i => i.name === 'PaginatedList');
if (isPaginatedList) {
const take = args.options?.take ?? 1000;
result = childComplexity + Math.round(Math.log(childComplexity) * take);
}
}
if (isListType(getNullableType(field.type))) {
result = childComplexity * 5;
}
}
if (logFieldScores) {
Logger.debug(
`${path}: ${field.type.toString()}\tchildComplexity: ${childComplexity}, score: ${result}`,
loggerCtx,
);
}
return result;
};
}
|
import { DefaultLogger, LogLevel, mergeConfig } from '@vendure/core';
import { createTestEnvironment } from '@vendure/testing';
import { RedisConnection } from 'bullmq';
import path from 'path';
import { initialData } from '../../../e2e-common/e2e-initial-data';
import { testConfig, TEST_SETUP_TIMEOUT_MS } from '../../../e2e-common/test-config';
import { awaitRunningJobs } from '../../core/e2e/utils/await-running-jobs';
import { BullMQJobQueuePlugin } from '../src/bullmq/plugin';
// eslint-disable-next-line @typescript-eslint/no-var-requires
const Redis = require('ioredis');
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { redisHost, redisPort } = require('./constants');
jest.setTimeout(10 * 3000);
// TODO: How to solve issues with Jest open handles after test suite finishes?
// See https://github.com/luin/ioredis/issues/1088
describe('BullMQJobQueuePlugin', () => {
const redisConnection: any = new Redis({
host: redisHost,
port: redisPort,
});
const { server, adminClient, shopClient } = createTestEnvironment(
mergeConfig(testConfig(), {
apiOptions: {
port: 4050,
},
logger: new DefaultLogger({ level: LogLevel.Info }),
plugins: [
BullMQJobQueuePlugin.init({
connection: redisConnection,
workerOptions: {
prefix: 'e2e',
},
queueOptions: {
prefix: 'e2e',
},
}),
],
}),
);
beforeAll(async () => {
await server.init({
initialData,
productsCsvPath: path.join(__dirname, 'fixtures/e2e-products-minimal.csv'),
customerCount: 1,
});
await adminClient.asSuperAdmin();
}, TEST_SETUP_TIMEOUT_MS);
afterAll(async () => {
await awaitRunningJobs(adminClient);
await server.destroy();
// redis.quit() creates a thread to close the connection.
// We wait until all threads have been run once to ensure the connection closes.
// See https://stackoverflow.com/a/54560610/772859
await new Promise(resolve => setTimeout(resolve, 100));
});
it('works', () => {
expect(1).toBe(1);
});
});
|
/**
* This is a placeholder. Please import from one of the sub-packages, e.g `@vendure/job-queue-plugin/package/bullmq`
*/
export const placeholder = 'Vendure Job Queue Plugin';
|
import { JobListOptions, JobState } from '@vendure/common/lib/generated-types';
import { notNullOrUndefined } from '@vendure/common/lib/shared-utils';
import {
ID,
Injector,
InspectableJobQueueStrategy,
InternalServerError,
Job,
JobData,
Logger,
PaginatedList,
} from '@vendure/core';
import Bull, {
ConnectionOptions,
JobType,
Processor,
Queue,
Worker,
WorkerOptions,
Job as BullJob,
} from 'bullmq';
import { EventEmitter } from 'events';
import { Cluster, Redis, RedisOptions } from 'ioredis';
import { Subject } from 'rxjs';
import { filter, takeUntil } from 'rxjs/operators';
import { ALL_JOB_TYPES, BULLMQ_PLUGIN_OPTIONS, loggerCtx } from './constants';
import { RedisHealthIndicator } from './redis-health-indicator';
import { getJobsByType } from './scripts/get-jobs-by-type';
import { BullMQPluginOptions, CustomScriptDefinition } from './types';
const QUEUE_NAME = 'vendure-job-queue';
const DEFAULT_CONCURRENCY = 3;
/**
* @description
* This JobQueueStrategy uses [BullMQ](https://docs.bullmq.io/) to implement a push-based job queue
* on top of Redis. It should not be used alone, but as part of the {@link BullMQJobQueuePlugin}.
*
* @docsCategory core plugins/JobQueuePlugin
*/
export class BullMQJobQueueStrategy implements InspectableJobQueueStrategy {
private redisConnection: Redis | Cluster;
private connectionOptions: ConnectionOptions;
private queue: Queue;
private worker: Worker;
private workerProcessor: Processor;
private options: BullMQPluginOptions;
private queueNameProcessFnMap = new Map<string, (job: Job) => Promise<any>>();
private cancellationSub: Redis;
private cancelRunningJob$ = new Subject<string>();
private readonly CANCEL_JOB_CHANNEL = 'cancel-job';
private readonly CANCELLED_JOB_LIST_NAME = 'vendure:cancelled-jobs';
async init(injector: Injector): Promise<void> {
const options = injector.get<BullMQPluginOptions>(BULLMQ_PLUGIN_OPTIONS);
this.options = {
...options,
workerOptions: {
removeOnComplete: options.workerOptions?.removeOnComplete ?? {
age: 60 * 60 * 24 * 30,
count: 5000,
},
removeOnFail: options.workerOptions?.removeOnFail ?? {
age: 60 * 60 * 24 * 30,
count: 5000,
},
},
};
this.connectionOptions =
options.connection ??
({
host: 'localhost',
port: 6379,
maxRetriesPerRequest: null,
} as RedisOptions);
this.redisConnection =
this.connectionOptions instanceof EventEmitter
? this.connectionOptions
: new Redis(this.connectionOptions);
this.defineCustomLuaScripts();
const redisHealthIndicator = injector.get(RedisHealthIndicator);
Logger.info('Checking Redis connection...', loggerCtx);
const health = await redisHealthIndicator.isHealthy('redis');
if (health.redis.status === 'down') {
Logger.error('Could not connect to Redis', loggerCtx);
} else {
Logger.info('Connected to Redis ✔', loggerCtx);
}
this.queue = new Queue(QUEUE_NAME, {
...options.queueOptions,
connection: this.redisConnection,
})
.on('error', (e: any) =>
Logger.error(`BullMQ Queue error: ${JSON.stringify(e.message)}`, loggerCtx, e.stack),
)
.on('resumed', () => Logger.verbose('BullMQ Queue resumed', loggerCtx))
.on('paused', () => Logger.verbose('BullMQ Queue paused', loggerCtx));
if (await this.queue.isPaused()) {
await this.queue.resume();
}
this.workerProcessor = async bullJob => {
const queueName = bullJob.name;
Logger.debug(
`Job ${bullJob.id ?? ''} [${queueName}] starting (attempt ${bullJob.attemptsMade + 1} of ${
bullJob.opts.attempts ?? 1
})`,
);
const processFn = this.queueNameProcessFnMap.get(queueName);
if (processFn) {
const job = await this.createVendureJob(bullJob);
const completed$ = new Subject<void>();
try {
// eslint-disable-next-line
job.on('progress', _job => bullJob.updateProgress(_job.progress));
this.cancelRunningJob$
.pipe(
filter(jobId => jobId === job.id),
takeUntil(completed$),
)
.subscribe(() => {
Logger.info(`Setting job ${job.id ?? ''} as cancelled`, loggerCtx);
job.cancel();
});
const result = await processFn(job);
await bullJob.updateProgress(100);
return result;
} catch (e: any) {
throw e;
} finally {
if (job.id) {
await this.redisConnection.srem(this.CANCELLED_JOB_LIST_NAME, job.id?.toString());
}
completed$.next();
completed$.complete();
}
}
throw new InternalServerError(`No processor defined for the queue "${queueName}"`);
};
// Subscription-mode Redis connection for the cancellation messages
this.cancellationSub = new Redis(this.connectionOptions as RedisOptions);
}
async destroy() {
await Promise.all([this.queue.close(), this.worker?.close()]);
}
async add<Data extends JobData<Data> = object>(job: Job<Data>): Promise<Job<Data>> {
const retries = this.options.setRetries?.(job.queueName, job) ?? job.retries ?? 0;
const backoff = this.options.setBackoff?.(job.queueName, job) ?? {
delay: 1000,
type: 'exponential',
};
const bullJob = await this.queue.add(job.queueName, job.data, {
attempts: retries + 1,
backoff,
});
return this.createVendureJob(bullJob);
}
async cancelJob(jobId: string): Promise<Job | undefined> {
const bullJob = await this.queue.getJob(jobId);
if (bullJob) {
if (await bullJob.isActive()) {
await this.setActiveJobAsCancelled(jobId);
return this.createVendureJob(bullJob);
} else {
try {
const job = await this.createVendureJob(bullJob);
await bullJob.remove();
return job;
} catch (e: any) {
const message = `Error when cancelling job: ${JSON.stringify(e.message)}`;
Logger.error(message, loggerCtx);
throw new InternalServerError(message);
}
}
}
}
async findMany(options?: JobListOptions): Promise<PaginatedList<Job>> {
const skip = options?.skip ?? 0;
const take = options?.take ?? 10;
let jobTypes: JobType[] = ALL_JOB_TYPES;
const stateFilter = options?.filter?.state;
if (stateFilter?.eq) {
switch (stateFilter.eq) {
case 'PENDING':
jobTypes = ['wait'];
break;
case 'RUNNING':
jobTypes = ['active'];
break;
case 'COMPLETED':
jobTypes = ['completed'];
break;
case 'RETRYING':
jobTypes = ['repeat'];
break;
case 'FAILED':
jobTypes = ['failed'];
break;
case 'CANCELLED':
jobTypes = ['failed'];
break;
}
}
const settledFilter = options?.filter?.isSettled;
if (settledFilter?.eq != null) {
jobTypes =
settledFilter.eq === true
? ['completed', 'failed']
: ['wait', 'waiting-children', 'active', 'repeat', 'delayed', 'paused'];
}
let items: Bull.Job[] = [];
let totalItems = 0;
try {
const [total, jobIds] = await this.callCustomScript(getJobsByType, [
skip,
take,
options?.filter?.queueName?.eq ?? '',
...jobTypes,
]);
items = (
await Promise.all(
jobIds.map(id => {
return BullJob.fromId(this.queue, id);
}),
)
).filter(notNullOrUndefined);
totalItems = total;
} catch (e: any) {
throw new InternalServerError(e.message);
}
return {
items: await Promise.all(items.map(bullJob => this.createVendureJob(bullJob))),
totalItems,
};
}
async findManyById(ids: ID[]): Promise<Job[]> {
const bullJobs = await Promise.all(ids.map(id => this.queue.getJob(id.toString())));
return Promise.all(bullJobs.filter(notNullOrUndefined).map(j => this.createVendureJob(j)));
}
async findOne(id: ID): Promise<Job | undefined> {
const bullJob = await this.queue.getJob(id.toString());
if (bullJob) {
return this.createVendureJob(bullJob);
}
}
// TODO V2: actually make it use the olderThan parameter
async removeSettledJobs(queueNames?: string[], olderThan?: Date): Promise<number> {
try {
const jobCounts = await this.queue.getJobCounts('completed', 'failed');
await this.queue.clean(100, 0, 'completed');
await this.queue.clean(100, 0, 'failed');
return Object.values(jobCounts).reduce((sum, num) => sum + num, 0);
} catch (e: any) {
Logger.error(e.message, loggerCtx, e.stack);
return 0;
}
}
// eslint-disable-next-line @typescript-eslint/require-await
async start<Data extends JobData<Data> = object>(
queueName: string,
process: (job: Job<Data>) => Promise<any>,
): Promise<void> {
this.queueNameProcessFnMap.set(queueName, process);
if (!this.worker) {
const options: WorkerOptions = {
concurrency: DEFAULT_CONCURRENCY,
...this.options.workerOptions,
connection: this.redisConnection,
};
this.worker = new Worker(QUEUE_NAME, this.workerProcessor, options)
.on('error', e => Logger.error(`BullMQ Worker error: ${e.message}`, loggerCtx, e.stack))
.on('closing', e => Logger.verbose(`BullMQ Worker closing: ${e}`, loggerCtx))
.on('closed', () => Logger.verbose('BullMQ Worker closed', loggerCtx))
.on('failed', (job: Bull.Job | undefined, error) => {
Logger.warn(
`Job ${job?.id ?? '(unknown id)'} [${job?.name ?? 'unknown name'}] failed (attempt ${
job?.attemptsMade ?? 'unknown'
} of ${job?.opts.attempts ?? 1})`,
loggerCtx,
);
})
.on('stalled', (jobId: string) => {
Logger.warn(`BullMQ Worker: job ${jobId} stalled`, loggerCtx);
})
.on('completed', (job: Bull.Job) => {
Logger.debug(`Job ${job?.id ?? 'unknown id'} [${job.name}] completed`, loggerCtx);
});
await this.cancellationSub.subscribe(this.CANCEL_JOB_CHANNEL);
this.cancellationSub.on('message', this.subscribeToCancellationEvents);
}
}
private subscribeToCancellationEvents = (channel: string, jobId: string) => {
if (channel === this.CANCEL_JOB_CHANNEL && jobId) {
this.cancelRunningJob$.next(jobId);
}
};
private stopped = false;
async stop<Data extends JobData<Data> = object>(
queueName: string,
process: (job: Job<Data>) => Promise<any>,
): Promise<void> {
if (!this.stopped) {
this.stopped = true;
try {
Logger.info(`Closing worker`, loggerCtx);
let timer: NodeJS.Timeout;
const checkActive = async () => {
const activeCount = await this.queue.getActiveCount();
if (0 < activeCount) {
const activeJobs = await this.queue.getActive();
Logger.info(
`Waiting on ${activeCount} active ${
activeCount > 1 ? 'jobs' : 'job'
} (${activeJobs.map(j => j.id).join(', ')})...`,
loggerCtx,
);
timer = setTimeout(checkActive, 2000);
}
};
timer = setTimeout(checkActive, 2000);
await this.worker.close();
Logger.info(`Worker closed`, loggerCtx);
await this.queue.close();
clearTimeout(timer);
Logger.info(`Queue closed`, loggerCtx);
this.cancellationSub.off('message', this.subscribeToCancellationEvents);
} catch (e: any) {
Logger.error(e, loggerCtx, e.stack);
}
}
}
private async setActiveJobAsCancelled(jobId: string) {
// Not yet possible natively in BullMQ, see
// https://github.com/taskforcesh/bullmq/issues/632
// So we have our own custom method of marking a job as cancelled.
await this.redisConnection.publish(this.CANCEL_JOB_CHANNEL, jobId);
await this.redisConnection.sadd(this.CANCELLED_JOB_LIST_NAME, jobId.toString());
}
private async createVendureJob(bullJob: Bull.Job): Promise<Job> {
const jobJson = bullJob.toJSON();
return new Job({
queueName: bullJob.name,
id: bullJob.id,
state: await this.getState(bullJob),
data: bullJob.data,
attempts: bullJob.attemptsMade,
createdAt: new Date(jobJson.timestamp),
startedAt: jobJson.processedOn ? new Date(jobJson.processedOn) : undefined,
settledAt: jobJson.finishedOn ? new Date(jobJson.finishedOn) : undefined,
error: jobJson.failedReason,
progress: +jobJson.progress,
result: jobJson.returnvalue,
retries: bullJob.opts.attempts ? bullJob.opts.attempts - 1 : 0,
});
}
private async getState(bullJob: Bull.Job): Promise<JobState> {
const jobId = bullJob.id?.toString();
if ((await bullJob.isWaiting()) || (await bullJob.isWaitingChildren())) {
return JobState.PENDING;
}
if (await bullJob.isActive()) {
const isCancelled =
jobId && (await this.redisConnection.sismember(this.CANCELLED_JOB_LIST_NAME, jobId));
if (isCancelled) {
return JobState.CANCELLED;
} else {
return JobState.RUNNING;
}
}
if (await bullJob.isDelayed()) {
return JobState.RETRYING;
}
if (await bullJob.isFailed()) {
return JobState.FAILED;
}
if (await bullJob.isCompleted()) {
return JobState.COMPLETED;
}
throw new InternalServerError('Could not determine job state');
// TODO: how to handle "cancelled" state? Currently when we cancel a job, we simply remove all record of it.
}
private callCustomScript<T, Args extends any[]>(
scriptDef: CustomScriptDefinition<T, Args>,
args: Args,
): Promise<T> {
return new Promise<T>((resolve, reject) => {
(this.redisConnection as any)[scriptDef.name](
`bull:${this.queue.name}:`,
...args,
(err: any, result: any) => {
if (err) {
reject(err);
} else {
resolve(result);
}
},
);
});
}
private defineCustomLuaScripts() {
const redis = this.redisConnection;
redis.defineCommand(getJobsByType.name, {
numberOfKeys: getJobsByType.numberOfKeys,
lua: getJobsByType.script,
});
}
}
|
import { JobType } from 'bullmq';
export const loggerCtx = 'BullMQJobQueuePlugin';
export const BULLMQ_PLUGIN_OPTIONS = Symbol('BULLMQ_PLUGIN_OPTIONS');
export const ALL_JOB_TYPES: JobType[] = [
'completed',
'failed',
'delayed',
'repeat',
'waiting-children',
'active',
'wait',
'paused',
];
|
import { Logger } from '@vendure/core';
// ensure that the bullmq package is installed
try {
// eslint-disable-next-line @typescript-eslint/no-var-requires
require('bullmq');
} catch (e: any) {
// eslint-disable-next-line no-console
console.error('The BullMQJobQueuePlugin depends on the "bullmq" package being installed.');
process.exit(1);
}
export * from './plugin';
export * from './types';
|
import { PluginCommonModule, VendurePlugin } from '@vendure/core';
import { BullMQJobQueueStrategy } from './bullmq-job-queue-strategy';
import { BULLMQ_PLUGIN_OPTIONS } from './constants';
import { RedisHealthCheckStrategy } from './redis-health-check-strategy';
import { RedisHealthIndicator } from './redis-health-indicator';
import { RedisJobBufferStorageStrategy } from './redis-job-buffer-storage-strategy';
import { BullMQPluginOptions } from './types';
/**
* @description
* This plugin is a drop-in replacement of the DefaultJobQueuePlugin, which implements a push-based
* job queue strategy built on top of the popular [BullMQ](https://github.com/taskforcesh/bullmq) library.
*
* ## Advantages over the DefaultJobQueuePlugin
*
* The advantage of this approach is that jobs are stored in Redis rather than in the database. For more complex
* applications with many job queues and/or multiple worker instances, this can massively reduce the load on the
* DB server. The reason for this is that the DefaultJobQueuePlugin uses polling to check for new jobs. By default
* it will poll every 200ms. A typical Vendure instance uses at least 3 queues (handling emails, collections, search index),
* so even with a single worker instance this results in 15 queries per second to the DB constantly. Adding more
* custom queues and multiple worker instances can easily result in 50 or 100 queries per second. At this point
* performance may be impacted.
*
* Using this plugin, no polling is needed, as BullMQ will _push_ jobs to the worker(s) as and when they are added
* to the queue. This results in significantly more scalable performance characteristics, as well as lower latency
* in processing jobs.
*
* ## Installation
*
* `yarn add \@vendure/job-queue-plugin bullmq`
*
* or
*
* `npm install \@vendure/job-queue-plugin bullmq`
*
* **Note:** The v1.x version of this plugin is designed to work with bullmq v1.x, etc.
*
* @example
* ```ts
* import { BullMQJobQueuePlugin } from '\@vendure/job-queue-plugin/package/bullmq';
*
* const config: VendureConfig = {
* // Add an instance of the plugin to the plugins array
* plugins: [
* // DefaultJobQueuePlugin should be removed from the plugins array
* BullMQJobQueuePlugin.init({
* connection: {
* port: 6379
* }
* }),
* ],
* };
* ```
*
* ### Running Redis locally
*
* To develop with this plugin, you'll need an instance of Redis to connect to. Here's a docker-compose config
* that will set up [Redis](https://redis.io/) as well as [Redis Commander](https://github.com/joeferner/redis-commander),
* which is a web-based UI for interacting with Redis:
*
* ```YAML
* version: "3"
* services:
* redis:
* image: bitnami/redis:6.2
* hostname: redis
* container_name: redis
* environment:
* - ALLOW_EMPTY_PASSWORD=yes
* ports:
* - "6379:6379"
* redis-commander:
* container_name: redis-commander
* hostname: redis-commander
* image: rediscommander/redis-commander:latest
* environment:
* - REDIS_HOSTS=local:redis:6379
* ports:
* - "8085:8081"
* ```
*
* ## Concurrency
*
* The default concurrency of a single worker is 3, i.e. up to 3 jobs will be processed at the same time.
* You can change the concurrency in the `workerOptions` passed to the `init()` method:
*
* @example
* ```ts
* const config: VendureConfig = {
* plugins: [
* BullMQJobQueuePlugin.init({
* workerOptions: {
* concurrency: 10,
* },
* }),
* ],
* };
* ```
*
* ## Removing old jobs
*
* By default, BullMQ will keep completed jobs in the `completed` set and failed jobs in the `failed` set. Over time,
* these sets can grow very large. Since Vendure v2.1, the default behaviour is to remove jobs from these sets after
* 30 days or after a maximum of 5,000 completed or failed jobs.
*
* This can be configured using the `removeOnComplete` and `removeOnFail` options:
*
* @example
* ```ts
* const config: VendureConfig = {
* plugins: [
* BullMQJobQueuePlugin.init({
* workerOptions: {
* removeOnComplete: {
* count: 500,
* },
* removeOnFail: {
* age: 60 * 60 * 24 * 7, // 7 days
* count: 1000,
* },
* }
* }),
* ],
* };
* ```
*
* The `count` option specifies the maximum number of jobs to keep in the set, while the `age` option specifies the
* maximum age of a job in seconds. If both options are specified, then the jobs kept will be the ones that satisfy
* both properties.
*
* @docsCategory core plugins/JobQueuePlugin
*/
@VendurePlugin({
imports: [PluginCommonModule],
configuration: config => {
config.jobQueueOptions.jobQueueStrategy = new BullMQJobQueueStrategy();
config.jobQueueOptions.jobBufferStorageStrategy = new RedisJobBufferStorageStrategy();
config.systemOptions.healthChecks.push(new RedisHealthCheckStrategy());
return config;
},
providers: [
{ provide: BULLMQ_PLUGIN_OPTIONS, useFactory: () => BullMQJobQueuePlugin.options },
RedisHealthIndicator,
],
compatibility: '^2.0.0',
})
export class BullMQJobQueuePlugin {
static options: BullMQPluginOptions;
/**
* @description
* Configures the plugin.
*/
static init(options: BullMQPluginOptions) {
this.options = options;
return this;
}
}
|
import { HealthIndicatorFunction } from '@nestjs/terminus';
import { HealthCheckStrategy, Injector } from '@vendure/core';
import { RedisHealthIndicator } from './redis-health-indicator';
let indicator: RedisHealthIndicator;
export class RedisHealthCheckStrategy implements HealthCheckStrategy {
init(injector: Injector) {
indicator = injector.get(RedisHealthIndicator);
}
getHealthIndicator(): HealthIndicatorFunction {
return () => indicator.isHealthy('redis (job queue)');
}
}
|
import { Inject, Injectable } from '@nestjs/common';
import { HealthCheckError, HealthIndicator, HealthIndicatorResult } from '@nestjs/terminus';
import { Logger } from '@vendure/core';
import { RedisConnection } from 'bullmq';
import { timer } from 'rxjs';
import { BULLMQ_PLUGIN_OPTIONS, loggerCtx } from './constants';
import { BullMQPluginOptions } from './types';
@Injectable()
export class RedisHealthIndicator extends HealthIndicator {
private timeoutTimer: any;
constructor(@Inject(BULLMQ_PLUGIN_OPTIONS) private options: BullMQPluginOptions) {
super();
}
async isHealthy(key: string, timeoutMs = 5000): Promise<HealthIndicatorResult> {
const connection = new RedisConnection(this.options.connection);
const pingResult = await new Promise(async (resolve, reject) => {
try {
connection.on('error', err => {
Logger.error(
`Redis health check error: ${JSON.stringify(err.message)}`,
loggerCtx,
err.stack,
);
resolve(err);
});
if (this.timeoutTimer) {
clearTimeout(this.timeoutTimer);
}
const timeout = new Promise<void>(
_resolve => (this.timeoutTimer = setTimeout(_resolve, timeoutMs)),
);
const client = await Promise.race([connection.client, timeout]);
clearTimeout(this.timeoutTimer);
if (!client) {
resolve('timeout');
return;
}
void client.ping((err: any, res: any) => {
if (err) {
resolve(err);
} else {
resolve(res);
}
});
} catch (e: any) {
resolve(e);
}
});
try {
await connection.close();
// await connection.disconnect();
} catch (e: any) {
Logger.error(
`Redis health check error closing connection: ${JSON.stringify(e.message)}`,
loggerCtx,
e.stack,
);
}
const result = this.getStatus(key, pingResult === 'PONG');
if (pingResult === 'PONG') {
return result;
}
throw new HealthCheckError('Redis failed', result);
}
}
|
import { Injector, Job, JobBufferStorageStrategy, JobConfig, Logger } from '@vendure/core';
import { Cluster, Redis, RedisOptions } from 'ioredis';
import { BULLMQ_PLUGIN_OPTIONS, loggerCtx } from './constants';
import { BullMQPluginOptions } from './types';
const BUFFER_LIST_PREFIX = 'vendure-job-buffer';
export class RedisJobBufferStorageStrategy implements JobBufferStorageStrategy {
private redis: Redis | Cluster;
init(injector: Injector) {
const options = injector.get<BullMQPluginOptions>(BULLMQ_PLUGIN_OPTIONS);
if (options.connection instanceof Redis) {
this.redis = options.connection;
} else if (options.connection instanceof Cluster) {
this.redis = options.connection;
} else {
this.redis = new Redis(options.connection as RedisOptions);
}
}
async add(bufferId: string, job: Job<any>): Promise<Job<any>> {
const result = await this.redis.lpush(this.keyName(bufferId), this.toJobConfigString(job));
return job;
}
async bufferSize(bufferIds?: string[]): Promise<{ [bufferId: string]: number }> {
const ids = bufferIds?.length ? bufferIds : await this.getAllBufferIds();
const result: { [bufferId: string]: number } = {};
for (const id of bufferIds || []) {
const key = this.keyName(id);
const count = await this.redis.llen(key);
result[id] = count;
}
return result;
}
async flush(bufferIds?: string[]): Promise<{ [bufferId: string]: Job[] }> {
const ids = bufferIds?.length ? bufferIds : await this.getAllBufferIds();
const result: { [bufferId: string]: Job[] } = {};
for (const id of bufferIds || []) {
const key = this.keyName(id);
const items = await this.redis.lrange(key, 0, -1);
await this.redis.del(key);
result[id] = items.map(item => this.toJob(item));
}
return result;
}
private keyName(bufferId: string) {
return `${BUFFER_LIST_PREFIX}:${bufferId}`;
}
private toJobConfigString(job: Job<any>): string {
const jobConfig: JobConfig<any> = {
...job,
data: job.data,
id: job.id ?? undefined,
};
return JSON.stringify(jobConfig);
}
private toJob(jobConfigString: string): Job {
try {
const jobConfig: JobConfig<any> = JSON.parse(jobConfigString);
return new Job(jobConfig);
} catch (e: any) {
Logger.error(`Could not parse buffered job:\n${JSON.stringify(e.message)}`, loggerCtx, e.stack);
throw e;
}
}
private async getAllBufferIds(): Promise<string[]> {
const stream =
this.redis instanceof Redis
? this.redis.scanStream({
match: `${BUFFER_LIST_PREFIX}:*`,
})
: this.redis.nodes()[0].scanStream({
match: `${BUFFER_LIST_PREFIX}:*`,
});
const keys = await new Promise<string[]>((resolve, reject) => {
const allKeys: string[] = [];
stream.on('data', _keys => allKeys.push(..._keys));
stream.on('end', () => resolve(allKeys));
stream.on('error', err => reject(err));
});
return keys.map(key => key.replace(`${BUFFER_LIST_PREFIX}:`, ''));
}
}
|
import { Job } from '@vendure/core';
import { ConnectionOptions, WorkerOptions } from 'bullmq';
import { QueueOptions } from 'bullmq';
/**
* @description
* Configuration options for the {@link BullMQJobQueuePlugin}.
*
* @since 1.2.0
* @docsCategory core plugins/JobQueuePlugin
* @docsPage BullMQPluginOptions
* @docsWeight 0
*/
export interface BullMQPluginOptions {
/**
* @description
* Connection options which will be passed directly to BullMQ when
* creating a new Queue, Worker and Scheduler instance.
*
* If omitted, it will attempt to connect to Redis at `127.0.0.1:6379`.
*/
connection?: ConnectionOptions;
/**
* @description
* Additional options used when instantiating the BullMQ
* Queue instance.
* See the [BullMQ QueueOptions docs](https://github.com/taskforcesh/bullmq/blob/master/docs/gitbook/api/bullmq.queueoptions.md)
*/
queueOptions?: Omit<QueueOptions, 'connection'>;
/**
* @description
* Additional options used when instantiating the BullMQ
* Worker instance.
* See the [BullMQ WorkerOptions docs](https://github.com/taskforcesh/bullmq/blob/master/docs/gitbook/api/bullmq.workeroptions.md)
*/
workerOptions?: Omit<WorkerOptions, 'connection'>;
/**
* @description
* When a job is added to the JobQueue using `JobQueue.add()`, the calling
* code may specify the number of retries in case of failure. This option allows
* you to override that number and specify your own number of retries based on
* the job being added.
*
* @example
* ```ts
* setRetries: (queueName, job) => {
* if (queueName === 'send-email') {
* // Override the default number of retries
* // for the 'send-email' job because we have
* // a very unreliable email service.
* return 10;
* }
* return job.retries;
* }
* ```
*
* @since 1.3.0
*/
setRetries?: (queueName: string, job: Job) => number;
/**
* @description
* This allows you to specify the backoff settings when a failed job gets retried.
* In other words, this determines how much time should pass before attempting to
* process the failed job again. If the function returns `undefined`, the default
* value of exponential/1000ms will be used.
*
* @example
* ```ts
* setBackoff: (queueName, job) => {
* return {
* type: 'exponential', // or 'fixed'
* delay: 10000 // first retry after 10s, second retry after 20s, 40s,...
* };
* }
* ```
* @since 1.3.0
* @default 'exponential', 1000
*/
setBackoff?: (queueName: string, job: Job) => BackoffOptions | undefined;
}
/**
* @description
* Configuration for the backoff function when retrying failed jobs.
*
* @since 1.3.0
* @docsCategory core plugins/JobQueuePlugin
* @docsPage BullMQPluginOptions
* @docsWeight 1
*/
export interface BackoffOptions {
type: 'exponential' | 'fixed';
delay: number;
}
/**
* @description
* A definition for a Lua script used to define custom behavior in Redis
*/
export interface CustomScriptDefinition<T, Args extends any[]> {
name: string;
script: string;
numberOfKeys: number;
}
|
// language=Lua
import { CustomScriptDefinition } from '../types';
const script = `--[[
Get job ids per provided states and filter by name
Input:
KEYS[1] 'prefix'
ARGV[1] start
ARGV[2] end
ARGV[3] filterName
ARGV[4...] types
]]
local rcall = redis.call
local prefix = KEYS[1]
local rangeStart = tonumber(ARGV[1])
local rangeEnd = tonumber(ARGV[2])
local filterName = ARGV[3]
local results = {}
local targetSets = {}
-- Initialize an empty array to hold the sets to unionize. The "completed" and "failed" lists
-- are sorted sets
local setsToUnionize = {}
local typesInUnion = {}
-- Initialize an empty array to hold lists to include. The "active" and "wait" lists are
-- regular lists
local listsToInclude = {}
-- Iterate through ARGV starting from the first element (ARGV[1]) up to the end
for i = 4, #ARGV do
local setKey = prefix .. ARGV[i]
-- Check if the setKey is valid (e.g., it exists and is a sorted set)
local targetExists = redis.call('EXISTS', setKey)
local listType = redis.call('TYPE', setKey).ok
if targetExists == 1 and listType == 'zset' then
-- Add the valid set to the array
table.insert(setsToUnionize, setKey)
table.insert(typesInUnion, ARGV[i])
end
if targetExists == 1 and listType == 'list' then
-- Add the valid set to the array
table.insert(listsToInclude, setKey)
table.insert(typesInUnion, ARGV[i])
end
end
-- Define the destination key for the concatenated sorted set
local tempSortedSetUnionKey = prefix .. 'union:' .. table.concat(typesInUnion, ':');
if #listsToInclude == 0 and #setsToUnionize == 0 then
return {0, {}}
end
-- Check if there are valid sets to unionize
if #setsToUnionize > 0 then
-- Use ZUNIONSTORE to concatenate the valid sorted sets into the destination key
local numSets = #setsToUnionize
redis.call('ZUNIONSTORE', tempSortedSetUnionKey, numSets, unpack(setsToUnionize))
end
local originalResults = rcall("ZREVRANGE", tempSortedSetUnionKey, 0, -1)
if #listsToInclude > 0 then
for _, listKey in ipairs(listsToInclude) do
local list = rcall("LRANGE", listKey, 0, -1)
for _, jobId in ipairs(list) do
table.insert(originalResults, jobId)
end
end
end
-- Define a custom comparison function for sorting in descending order
local function compareDescending(a, b)
return tonumber(a) > tonumber(b)
end
-- Sort the table in descending order
table.sort(originalResults, compareDescending)
local filteredResults = {}
local totalResults = 0
for _, job in ipairs(originalResults) do
local jobName = rcall("HGET", prefix .. job, "name");
if filterName ~= "" and jobName == filterName then
if rangeStart <= totalResults and #filteredResults < rangeEnd then
table.insert(filteredResults, job)
end
totalResults = totalResults + 1
elseif filterName == "" then
if rangeStart <= totalResults and #filteredResults < rangeEnd then
table.insert(filteredResults, job)
end
totalResults = totalResults + 1
end
end
rcall("DEL", tempSortedSetUnionKey)
return {totalResults, filteredResults}
`;
export const getJobsByType: CustomScriptDefinition<
[totalItems: number, jobIds: string[]],
[rangeStart: number, rangeEnd: number, queueName: string | undefined, ...states: string[]]
> = {
script,
numberOfKeys: 1,
name: 'getJobsByType',
};
|
export const PUB_SUB_OPTIONS = Symbol('PUB_SUB_OPTIONS');
export const loggerCtx = 'PubSubPlugin';
|
export * from './plugin';
export * from './options';
|
export interface PubSubOptions {
/**
* @description
* Number of jobs that can be inflight at the same time.
*/
concurrency?: number;
/**
* @description
* This is the mapping of Vendure queue names to PubSub Topics and Subscriptions
* For each queue a topic and subscription is required to exist.
*/
queueNamePubSubPair?: Map<string, [string, string]>;
}
|
import { PubSub } from '@google-cloud/pubsub';
import { PluginCommonModule, Type, VendurePlugin } from '@vendure/core';
import { PUB_SUB_OPTIONS } from './constants';
import { PubSubOptions } from './options';
import { PubSubJobQueueStrategy } from './pub-sub-job-queue-strategy';
@VendurePlugin({
imports: [PluginCommonModule],
providers: [
{ provide: PUB_SUB_OPTIONS, useFactory: () => PubSubPlugin.options },
{ provide: PubSub, useFactory: () => new PubSub() },
],
configuration: config => {
config.jobQueueOptions.jobQueueStrategy = new PubSubJobQueueStrategy();
return config;
},
compatibility: '^2.0.0',
})
export class PubSubPlugin {
private static options: PubSubOptions;
static init(options: PubSubOptions): Type<PubSubPlugin> {
this.options = options;
return PubSubPlugin;
}
}
|
import { PubSub } from '@google-cloud/pubsub';
import { ModuleRef } from '@nestjs/core';
import { Test } from '@nestjs/testing';
import { Injector, Job } from '@vendure/core';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { PUB_SUB_OPTIONS } from './constants';
import { PubSubOptions } from './options';
import { PubSubJobQueueStrategy } from './pub-sub-job-queue-strategy';
describe('PubSubJobQueueStrategy', () => {
let strategy: PubSubJobQueueStrategy;
let pubsub: any;
let topic: any;
beforeEach(async () => {
topic = {
publish: vi.fn(),
};
pubsub = {
topic: vi.fn(() => {
return topic;
}),
};
const options = {
concurrency: 1,
queueNamePubSubPair: new Map([['test-queue', ['test-topic', 'test-subscription']]]),
} as PubSubOptions;
const moduleRef = await Test.createTestingModule({
providers: [
{ provide: PubSub, useValue: pubsub },
{ provide: PUB_SUB_OPTIONS, useValue: options },
],
}).compile();
strategy = new PubSubJobQueueStrategy();
strategy.init(new Injector(moduleRef.get(ModuleRef)));
});
it('cannot publish to not configured queue', async () => {
expect.assertions(2);
try {
await strategy.add(
new Job({
queueName: 'some-queue',
data: {},
}),
);
} catch (err: any) {
expect(err).toEqual(new Error('Topic name not set for queue: some-queue'));
}
expect(pubsub.topic).not.toHaveBeenCalled();
});
it('publishes new jobs to topic', async () => {
const data = {
some: 'data',
};
await strategy.add(
new Job({
queueName: 'test-queue',
data,
}),
);
expect(pubsub.topic).toHaveBeenCalledWith('test-topic');
expect(topic.publish).toHaveBeenCalledWith(Buffer.from(JSON.stringify(data)));
});
});
|