NestModule
+
+
+
+
+
+### options
+
+SentryPluginOptions`} />
+
+
+### configure
+
+ any`} />
+
+
+### init
+
+SentryPluginOptions) => `} />
+
+
+
+
+
diff --git a/docs/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.md b/docs/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.md
new file mode 100644
index 0000000000..6b46137edd
--- /dev/null
+++ b/docs/docs/reference/core-plugins/sentry-plugin/sentry-plugin-options.md
@@ -0,0 +1,48 @@
+---
+title: "SentryPluginOptions"
+isDefaultIndex: false
+generated: true
+---
+
+import MemberInfo from '@site/src/components/MemberInfo';
+import GenerationInfo from '@site/src/components/GenerationInfo';
+import MemberDescription from '@site/src/components/MemberDescription';
+
+
+## SentryPluginOptions
+
+NodeOptions
+
+
+
+
+
+### dsn
+
+
diff --git a/docs/docs/reference/core-plugins/stellate-plugin/index.md b/docs/docs/reference/core-plugins/stellate-plugin/index.md
new file mode 100644
index 0000000000..1908682c18
--- /dev/null
+++ b/docs/docs/reference/core-plugins/stellate-plugin/index.md
@@ -0,0 +1,281 @@
+---
+title: "StellatePlugin"
+isDefaultIndex: false
+generated: true
+---
+
+import MemberInfo from '@site/src/components/MemberInfo';
+import GenerationInfo from '@site/src/components/GenerationInfo';
+import MemberDescription from '@site/src/components/MemberDescription';
+
+
+## StellatePlugin
+
+OnApplicationBootstrap
+
+
+
+
+
+### options
+
+StellatePluginOptions`} />
+
+
+### init
+
+StellatePluginOptions) => `} />
+
+
+### constructor
+
+StellatePluginOptions, eventBus: EventBus, stellateService: StellateService, moduleRef: ModuleRef) => StellatePlugin`} />
+
+
+### onApplicationBootstrap
+
+ `} />
+
+
+
+
+
diff --git a/docs/docs/reference/core-plugins/stellate-plugin/purge-rule.md b/docs/docs/reference/core-plugins/stellate-plugin/purge-rule.md
new file mode 100644
index 0000000000..fd9168f88d
--- /dev/null
+++ b/docs/docs/reference/core-plugins/stellate-plugin/purge-rule.md
@@ -0,0 +1,95 @@
+---
+title: "PurgeRule"
+isDefaultIndex: false
+generated: true
+---
+
+import MemberInfo from '@site/src/components/MemberInfo';
+import GenerationInfo from '@site/src/components/GenerationInfo';
+import MemberDescription from '@site/src/components/MemberDescription';
+
+
+## PurgeRule
+
+
+
+### eventType
+
+StellateService; injector: Injector }) => `} />
+
+
+### constructor
+
+PurgeRuleConfig<Event>) => PurgeRule`} />
+
+
+
+
+
+
+
+## PurgeRuleConfig
+
+
+
+### eventType
+
+StellateService;
injector: Injector;
}) => void | Promise<void>`} />
+
+The function to invoke when the specified event is published. This function should use the
+StellateService instance to call the Stellate Purge API.
+
+
+
diff --git a/docs/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.md b/docs/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.md
new file mode 100644
index 0000000000..69be120a98
--- /dev/null
+++ b/docs/docs/reference/core-plugins/stellate-plugin/stellate-plugin-options.md
@@ -0,0 +1,69 @@
+---
+title: "StellatePluginOptions"
+isDefaultIndex: false
+generated: true
+---
+
+import MemberInfo from '@site/src/components/MemberInfo';
+import GenerationInfo from '@site/src/components/GenerationInfo';
+import MemberDescription from '@site/src/components/MemberDescription';
+
+
+## StellatePluginOptions
+
+
+
+### serviceName
+
+.stellate.sh`
+### apiToken
+
+PurgeRule[]`} />
+
+An array of PurgeRule instances which are used to define how the plugin will
+respond to Vendure events in order to trigger calls to the Stellate Purging API.
+### defaultBufferTimeMs
+
+
diff --git a/docs/docs/reference/core-plugins/stellate-plugin/stellate-service.md b/docs/docs/reference/core-plugins/stellate-plugin/stellate-service.md
new file mode 100644
index 0000000000..8481a09a59
--- /dev/null
+++ b/docs/docs/reference/core-plugins/stellate-plugin/stellate-service.md
@@ -0,0 +1,75 @@
+---
+title: "StellateService"
+isDefaultIndex: false
+generated: true
+---
+
+import MemberInfo from '@site/src/components/MemberInfo';
+import GenerationInfo from '@site/src/components/GenerationInfo';
+import MemberDescription from '@site/src/components/MemberDescription';
+
+
+## StellateService
+
+
+
+### constructor
+
+StellatePluginOptions) => StellateService`} />
+
+
+### purgeProducts
+
+Product[]) => `} />
+
+Purges the cache for the given Products.
+### purgeProductVariants
+
+ProductVariant[]) => `} />
+
+Purges the cache for the given ProductVariants.
+### purgeSearchResults
+
+ProductVariant | Product>) => `} />
+
+Purges the cache for SearchResults which contain the given Products or ProductVariants.
+### purgeAllOfType
+
+ `} />
+
+Purges the entire cache for the given type.
+### purgeCollections
+
+Collection[]) => `} />
+
+Purges the cache for the given Collections.
+### purgeSearchResponseCacheIdentifiers
+
+Collection[]) => `} />
+
+Purges the cache of SearchResults for the given Collections based on slug.
+### purge
+
+ID[], keyName: = 'id') => `} />
+
+Purges the cache for the given type and keys.
+
+
+
diff --git a/docs/docs/reference/graphql-api/admin/enums.md b/docs/docs/reference/graphql-api/admin/enums.md
index 4762c3d12f..50b44736ed 100644
--- a/docs/docs/reference/graphql-api/admin/enums.md
+++ b/docs/docs/reference/graphql-api/admin/enums.md
@@ -1,8 +1,6 @@
---
title: "Enums"
-weight: 5
-date: 2023-07-21T15:33:44.314Z
-showtoc: true
+isDefaultIndex: false
generated: true
---
diff --git a/docs/docs/reference/graphql-api/admin/input-types.md b/docs/docs/reference/graphql-api/admin/input-types.md
index 302d739c24..cf1da8e302 100644
--- a/docs/docs/reference/graphql-api/admin/input-types.md
+++ b/docs/docs/reference/graphql-api/admin/input-types.md
@@ -1,8 +1,6 @@
---
title: "Input Objects"
-weight: 4
-date: 2023-07-21T15:33:44.314Z
-showtoc: true
+isDefaultIndex: false
generated: true
---
@@ -1258,6 +1256,8 @@ import MemberDescription from '@site/src/components/MemberDescription';
perCustomerUsageLimit: Int
+usageLimit: Int
+
conditions: [ConfigurableOperationInput!]!
actions: [ConfigurableOperationInput!]!
@@ -1822,6 +1822,8 @@ import MemberDescription from '@site/src/components/MemberDescription';
languageCode: StringOperators
+facetId: IDOperators
+
name: StringOperators
code: StringOperators
@@ -1877,6 +1879,8 @@ import MemberDescription from '@site/src/components/MemberDescription';
updatedAt: SortOrder
+facetId: SortOrder
+
name: SortOrder
code: SortOrder
@@ -2860,6 +2864,8 @@ import MemberDescription from '@site/src/components/MemberDescription';
perCustomerUsageLimit: NumberOperators
+usageLimit: NumberOperators
+
name: StringOperators
description: StringOperators
@@ -2925,6 +2931,8 @@ import MemberDescription from '@site/src/components/MemberDescription';
perCustomerUsageLimit: SortOrder
+usageLimit: SortOrder
+
name: SortOrder
description: SortOrder
@@ -4469,6 +4477,8 @@ import MemberDescription from '@site/src/components/MemberDescription';
perCustomerUsageLimit: Int
+usageLimit: Int
+
conditions: [ConfigurableOperationInput!]
actions: [ConfigurableOperationInput!]
diff --git a/docs/docs/reference/graphql-api/admin/mutations.md b/docs/docs/reference/graphql-api/admin/mutations.md
index 7e427d10d8..ecad14e2e4 100644
--- a/docs/docs/reference/graphql-api/admin/mutations.md
+++ b/docs/docs/reference/graphql-api/admin/mutations.md
@@ -1,8 +1,6 @@
---
title: "Mutations"
-weight: 2
-date: 2023-07-21T15:33:44.314Z
-showtoc: true
+isDefaultIndex: false
generated: true
---
diff --git a/docs/docs/reference/graphql-api/admin/object-types.md b/docs/docs/reference/graphql-api/admin/object-types.md
index 37406a5072..55d33640c5 100644
--- a/docs/docs/reference/graphql-api/admin/object-types.md
+++ b/docs/docs/reference/graphql-api/admin/object-types.md
@@ -1,8 +1,6 @@
---
title: "Types"
-weight: 3
-date: 2023-07-21T15:33:44.314Z
-showtoc: true
+isDefaultIndex: false
generated: true
---
@@ -1126,6 +1124,11 @@ import MemberDescription from '@site/src/components/MemberDescription';
values: [FacetValue!]!
+"""
+Returns a paginated, sortable, filterable list of the Facet's values. Added in v2.1.0.
+"""
+valueList(options: FacetValueListOptions): FacetValueList!
+
translations: [FacetTranslation!]!
customFields: JSON
@@ -1200,6 +1203,8 @@ import MemberDescription from '@site/src/components/MemberDescription';
facet: Facet!
+facetId: ID!
+
name: String!
code: String!
@@ -2265,6 +2270,9 @@ import MemberDescription from '@site/src/components/MemberDescription';
"""
proratedUnitPriceWithTax: Money!
+"""
+The quantity of items purchased
+"""
quantity: Int!
"""
@@ -2982,7 +2990,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
{
currencyCode: CurrencyCode!
-price: Int!
+price: Money!
}
@@ -3026,6 +3034,8 @@ import MemberDescription from '@site/src/components/MemberDescription';
perCustomerUsageLimit: Int
+usageLimit: Int
+
name: String!
description: String!
diff --git a/docs/docs/reference/graphql-api/admin/queries.md b/docs/docs/reference/graphql-api/admin/queries.md
index 1e81e348f8..b1f27b9801 100644
--- a/docs/docs/reference/graphql-api/admin/queries.md
+++ b/docs/docs/reference/graphql-api/admin/queries.md
@@ -1,8 +1,6 @@
---
title: "Queries"
-weight: 1
-date: 2023-07-21T15:33:44.314Z
-showtoc: true
+isDefaultIndex: false
generated: true
---
diff --git a/docs/docs/reference/graphql-api/shop/enums.md b/docs/docs/reference/graphql-api/shop/enums.md
index 55bac18f47..e104ec8544 100644
--- a/docs/docs/reference/graphql-api/shop/enums.md
+++ b/docs/docs/reference/graphql-api/shop/enums.md
@@ -1,8 +1,6 @@
---
title: "Enums"
-weight: 5
-date: 2023-07-21T15:33:42.677Z
-showtoc: true
+isDefaultIndex: false
generated: true
---
diff --git a/docs/docs/reference/graphql-api/shop/input-types.md b/docs/docs/reference/graphql-api/shop/input-types.md
index 5be6f1ee6e..1cd14516c1 100644
--- a/docs/docs/reference/graphql-api/shop/input-types.md
+++ b/docs/docs/reference/graphql-api/shop/input-types.md
@@ -1,8 +1,6 @@
---
title: "Input Objects"
-weight: 4
-date: 2023-07-21T15:33:42.677Z
-showtoc: true
+isDefaultIndex: false
generated: true
---
@@ -473,6 +471,87 @@ import MemberDescription from '@site/src/components/MemberDescription';
or: [ID!]
+}
+
+
+
+## FacetValueFilterParameter
+
+
+
+
+## FacetValueListOptions
+
+input FacetValueFilterParameter
+ {
+id: IDOperators
+
+createdAt: DateOperators
+
+updatedAt: DateOperators
+
+languageCode: StringOperators
+
+facetId: IDOperators
+
+name: StringOperators
+
+code: StringOperators
+
+
+}
+
+
+
+
+## FacetValueSortParameter
+
+input FacetValueListOptions
+ {
+"""
+Skips the first n results, for use in pagination
+"""
+skip: Int
+
+"""
+Takes n results, for use in pagination
+"""
+take: Int
+
+"""
+Specifies which properties to sort the results by
+"""
+sort: FacetValueSortParameter
+
+"""
+Allows the results to be filtered
+"""
+filter: FacetValueFilterParameter
+
+"""
+Specifies whether multiple "filter" arguments should be combines with a logical AND or OR operation. Defaults to AND.
+"""
+filterOperator: LogicalOperator
+
+
+}
+
+
+
diff --git a/docs/docs/reference/graphql-api/shop/mutations.md b/docs/docs/reference/graphql-api/shop/mutations.md
index 78317d83e3..8278fb2c13 100644
--- a/docs/docs/reference/graphql-api/shop/mutations.md
+++ b/docs/docs/reference/graphql-api/shop/mutations.md
@@ -1,8 +1,6 @@
---
title: "Mutations"
-weight: 2
-date: 2023-07-21T15:33:42.677Z
-showtoc: true
+isDefaultIndex: false
generated: true
---
diff --git a/docs/docs/reference/graphql-api/shop/object-types.md b/docs/docs/reference/graphql-api/shop/object-types.md
index 73c7083d89..41bfb4ce99 100644
--- a/docs/docs/reference/graphql-api/shop/object-types.md
+++ b/docs/docs/reference/graphql-api/shop/object-types.md
@@ -1,8 +1,6 @@
---
title: "Types"
-weight: 3
-date: 2023-07-21T15:33:42.677Z
-showtoc: true
+isDefaultIndex: false
generated: true
---
@@ -795,6 +793,11 @@ import MemberDescription from '@site/src/components/MemberDescription';
input FacetValueSortParameter
+ {
+id: SortOrder
+
+createdAt: SortOrder
+
+updatedAt: SortOrder
+
+facetId: SortOrder
+
+name: SortOrder
+
+code: SortOrder
+
+
}
values: [FacetValue!]!
+"""
+Returns a paginated, sortable, filterable list of the Facet's values. Added in v2.1.0.
+"""
+valueList(options: FacetValueListOptions): FacetValueList!
+
translations: [FacetTranslation!]!
customFields: JSON
@@ -850,6 +853,8 @@ import MemberDescription from '@site/src/components/MemberDescription';
facet: Facet!
+facetId: ID!
+
name: String!
code: String!
@@ -859,6 +864,19 @@ import MemberDescription from '@site/src/components/MemberDescription';
customFields: JSON
+}
+
+
+## FacetValueList
+
+
@@ -1622,6 +1640,9 @@ import MemberDescription from '@site/src/components/MemberDescription';
"""
proratedUnitPriceWithTax: Money!
+"""
+The quantity of items purchased
+"""
quantity: Int!
"""
@@ -2288,6 +2309,8 @@ import MemberDescription from '@site/src/components/MemberDescription';
perCustomerUsageLimit: Int
+usageLimit: Int
+
name: String!
description: String!
diff --git a/docs/docs/reference/graphql-api/shop/queries.md b/docs/docs/reference/graphql-api/shop/queries.md
index c5d3d803b6..fc6d494a36 100644
--- a/docs/docs/reference/graphql-api/shop/queries.md
+++ b/docs/docs/reference/graphql-api/shop/queries.md
@@ -1,8 +1,6 @@
---
title: "Queries"
-weight: 1
-date: 2023-07-21T15:33:42.677Z
-showtoc: true
+isDefaultIndex: false
generated: true
---
diff --git a/docs/docs/reference/typescript-api/common/permission.md b/docs/docs/reference/typescript-api/common/permission.md
index 1b1aaa9024..36e0ec9366 100644
--- a/docs/docs/reference/typescript-api/common/permission.md
+++ b/docs/docs/reference/typescript-api/common/permission.md
@@ -11,7 +11,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
## Permission
-
-
-
- ;
}
+@Entity()
+export class CustomFieldOtherRelationTestEntity extends VendureEntity {
+ constructor(input: Partial) {
+ super(input);
+ }
+
+ @Column()
+ data: string;
+
+ @ManyToOne(() => TestEntity)
+ parent: Relation;
+}
+
class TestEntityCustomFields {
@OneToMany(() => CustomFieldRelationTestEntity, child => child.parent)
relation: Relation;
+
+ @OneToMany(() => CustomFieldOtherRelationTestEntity, child => child.parent)
+ otherRelation: Relation;
}
@Entity()
@@ -143,7 +159,7 @@ export class TestEntityTranslation extends VendureEntity implements Translation<
@ManyToOne(type => TestEntity, base => base.translations)
base: TestEntity;
- customFields: {};
+ customFields: never;
}
@Entity()
@@ -171,7 +187,12 @@ export class ListQueryResolver {
return this.listQueryBuilder
.build(TestEntity, args.options, {
ctx,
- relations: ['orderRelation', 'orderRelation.customer', 'customFields.relation'],
+ relations: [
+ 'orderRelation',
+ 'orderRelation.customer',
+ 'customFields.relation',
+ 'customFields.otherRelation',
+ ],
customPropertyMap: {
customerLastName: 'orderRelation.customer.lastName',
},
@@ -222,8 +243,14 @@ const apiExtensions = gql`
data: String!
}
+ type CustomFieldOtherRelationTestEntity implements Node {
+ id: ID!
+ data: String!
+ }
+
type TestEntityCustomFields {
relation: [CustomFieldRelationTestEntity!]!
+ otherRelation: [CustomFieldOtherRelationTestEntity!]!
}
type TestEntity implements Node {
@@ -272,7 +299,13 @@ const apiExtensions = gql`
@VendurePlugin({
imports: [PluginCommonModule],
- entities: [TestEntity, TestEntityPrice, TestEntityTranslation, CustomFieldRelationTestEntity],
+ entities: [
+ TestEntity,
+ TestEntityPrice,
+ TestEntityTranslation,
+ CustomFieldRelationTestEntity,
+ CustomFieldOtherRelationTestEntity,
+ ],
adminApiExtensions: {
schema: apiExtensions,
resolvers: [ListQueryResolver],
@@ -409,6 +442,12 @@ export class ListQueryPlugin implements OnApplicationBootstrap {
data: nestedContent.data,
}),
);
+ await this.connection.getRepository(CustomFieldOtherRelationTestEntity).save(
+ new CustomFieldOtherRelationTestEntity({
+ parent: testEntity,
+ data: nestedContent.data,
+ }),
+ );
}
}
}
diff --git a/packages/core/e2e/list-query-builder.e2e-spec.ts b/packages/core/e2e/list-query-builder.e2e-spec.ts
index 84b47bdf96..b4b228f7ef 100644
--- a/packages/core/e2e/list-query-builder.e2e-spec.ts
+++ b/packages/core/e2e/list-query-builder.e2e-spec.ts
@@ -1268,6 +1268,27 @@ describe('ListQueryBuilder', () => {
},
]);
});
+
+ it('should resolve multiple relations in customFields successfully', async () => {
+ const { testEntities } = await shopClient.query(GET_LIST_WITH_MULTIPLE_CUSTOM_FIELD_RELATION, {
+ options: {
+ filter: {
+ label: { eq: 'A' },
+ },
+ },
+ });
+
+ expect(testEntities.items).toEqual([
+ {
+ id: 'T_1',
+ label: 'A',
+ customFields: {
+ relation: [{ id: 'T_1', data: 'A' }],
+ otherRelation: [{ id: 'T_1', data: 'A' }],
+ },
+ },
+ ]);
+ });
});
});
@@ -1351,3 +1372,24 @@ const GET_LIST_WITH_CUSTOM_FIELD_RELATION = gql`
}
}
`;
+
+const GET_LIST_WITH_MULTIPLE_CUSTOM_FIELD_RELATION = gql`
+ query GetTestWithMultipleCustomFieldRelation($options: TestEntityListOptions) {
+ testEntities(options: $options) {
+ items {
+ id
+ label
+ customFields {
+ relation {
+ id
+ data
+ }
+ otherRelation {
+ id
+ data
+ }
+ }
+ }
+ }
+ }
+`;
diff --git a/packages/core/package.json b/packages/core/package.json
index c34ab3644a..055a4ca035 100644
--- a/packages/core/package.json
+++ b/packages/core/package.json
@@ -1,6 +1,6 @@
{
"name": "@vendure/core",
- "version": "2.1.4",
+ "version": "2.1.5",
"description": "A modern, headless ecommerce framework",
"repository": {
"type": "git",
@@ -50,7 +50,7 @@
"@nestjs/testing": "10.2.1",
"@nestjs/typeorm": "10.0.0",
"@types/fs-extra": "^9.0.1",
- "@vendure/common": "^2.1.4",
+ "@vendure/common": "^2.1.5",
"bcrypt": "^5.1.1",
"body-parser": "^1.20.2",
"chalk": "^4.1.2",
diff --git a/packages/core/src/common/error/error-result.ts b/packages/core/src/common/error/error-result.ts
index b15b1b05bb..5953c7b47a 100644
--- a/packages/core/src/common/error/error-result.ts
+++ b/packages/core/src/common/error/error-result.ts
@@ -37,6 +37,9 @@ export type JustErrorResults = Exclud
* type UpdateOrderItemsResult = Order | OrderModificationError | OrderLimitError | NegativeQuantityError;
* type T1 = ErrorResultUnion;
* // T1 = VendureEntityOrder | OrderModificationError | OrderLimitError | NegativeQuantityError;
+ * ```
+ *
+ * @docsCategory errors
*/
export type ErrorResultUnion =
| JustErrorResults
@@ -44,7 +47,26 @@ export type ErrorResultUnion(
input: T,
diff --git a/packages/core/src/config/order/default-order-process.ts b/packages/core/src/config/order/default-order-process.ts
index 2c78c91580..d1592c0d3f 100644
--- a/packages/core/src/config/order/default-order-process.ts
+++ b/packages/core/src/config/order/default-order-process.ts
@@ -413,10 +413,13 @@ export function configureDefaultOrderProcess(options: DefaultOrderProcessOptions
order.active = false;
order.orderPlacedAt = new Date();
await Promise.all(
- order.lines.map(line =>
+ order.lines.map(line => {
+ line.orderPlacedQuantity = line.quantity
connection
.getRepository(ctx, OrderLine)
- .update(line.id, { orderPlacedQuantity: line.quantity }),
+ .update(line.id, { orderPlacedQuantity: line.quantity })
+ return line
+ }
),
);
eventBus.publish(new OrderPlacedEvent(fromState, toState, ctx, order));
diff --git a/packages/core/src/entity/base/base.entity.spec.ts b/packages/core/src/entity/base/base.entity.spec.ts
new file mode 100644
index 0000000000..b386f3b3bb
--- /dev/null
+++ b/packages/core/src/entity/base/base.entity.spec.ts
@@ -0,0 +1,69 @@
+import { DeepPartial } from '@vendure/common/lib/shared-types';
+import { describe, expect, it } from 'vitest';
+
+import { Calculated } from '../../common/index';
+import { CalculatedPropertySubscriber } from '../subscribers';
+
+import { VendureEntity } from './base.entity';
+
+class ChildEntity extends VendureEntity {
+ constructor(input?: DeepPartial) {
+ super(input);
+ }
+
+ name: string;
+
+ get nameLoud(): string {
+ return this.name.toUpperCase();
+ }
+}
+
+class ChildEntityWithCalculated extends VendureEntity {
+ constructor(input?: DeepPartial) {
+ super(input);
+ }
+
+ name: string;
+
+ @Calculated()
+ get nameLoudCalculated(): string {
+ return this.name.toUpperCase();
+ }
+}
+
+describe('VendureEntity', () => {
+ it('instantiating a child entity', () => {
+ const child = new ChildEntity({
+ name: 'foo',
+ });
+
+ expect(child.name).toBe('foo');
+ expect(child.nameLoud).toBe('FOO');
+ });
+
+ it('instantiating from existing entity with getter', () => {
+ const child1 = new ChildEntity({
+ name: 'foo',
+ });
+
+ const child2 = new ChildEntity(child1);
+
+ expect(child2.name).toBe('foo');
+ expect(child2.nameLoud).toBe('FOO');
+ });
+
+ it('instantiating from existing entity with calculated getter', () => {
+ const calculatedPropertySubscriber = new CalculatedPropertySubscriber();
+ const child1 = new ChildEntityWithCalculated({
+ name: 'foo',
+ });
+
+ // This is what happens to entities after being loaded from the DB
+ calculatedPropertySubscriber.afterLoad(child1);
+
+ const child2 = new ChildEntityWithCalculated(child1);
+
+ expect(child2.name).toBe('foo');
+ expect(child2.nameLoudCalculated).toBe('FOO');
+ });
+});
diff --git a/packages/core/src/entity/base/base.entity.ts b/packages/core/src/entity/base/base.entity.ts
index de6bb47f38..dbd8abfb48 100644
--- a/packages/core/src/entity/base/base.entity.ts
+++ b/packages/core/src/entity/base/base.entity.ts
@@ -13,8 +13,14 @@ import { PrimaryGeneratedId } from '../entity-id.decorator';
export abstract class VendureEntity {
protected constructor(input?: DeepPartial) {
if (input) {
- for (const [key, value] of Object.entries(input)) {
- (this as any)[key] = value;
+ for (const [key, descriptor] of Object.entries(Object.getOwnPropertyDescriptors(input))) {
+ if (descriptor.get && !descriptor.set) {
+ // A getter has been moved to the entity instance
+ // by the CalculatedPropertySubscriber
+ // and cannot be copied over to the new instance.
+ continue;
+ }
+ (this as any)[key] = descriptor.value;
}
}
}
diff --git a/packages/core/src/event-bus/index.ts b/packages/core/src/event-bus/index.ts
index 52455a6128..f7239df7de 100644
--- a/packages/core/src/event-bus/index.ts
+++ b/packages/core/src/event-bus/index.ts
@@ -1,6 +1,7 @@
export * from './event-bus';
export * from './event-bus.module';
export * from './vendure-event';
+export * from './vendure-entity-event';
export * from './events/account-registration-event';
export * from './events/account-verified-event';
diff --git a/packages/core/src/i18n/messages/en.json b/packages/core/src/i18n/messages/en.json
index dcab06c5b0..b8fb899e27 100644
--- a/packages/core/src/i18n/messages/en.json
+++ b/packages/core/src/i18n/messages/en.json
@@ -6,7 +6,6 @@
"cannot-delete-sole-superadmin": "The sole SuperAdmin cannot be deleted",
"cannot-locate-customer-for-user": "Cannot locate a Customer for the user",
"cannot-modify-role": "The role \"{ roleCode }\" cannot be modified",
- "cannot-create-sales-for-active-order": "Cannot create a Sale for an Order which is still active",
"cannot-move-collection-into-self": "Cannot move a Collection into itself",
"cannot-transition-payment-from-to": "Cannot transition Payment from \"{ fromState }\" to \"{ toState }\"",
"cannot-transition-refund-from-to": "Cannot transition Refund from \"{ fromState }\" to \"{ toState }\"",
diff --git a/packages/core/src/service/helpers/list-query-builder/list-query-builder.ts b/packages/core/src/service/helpers/list-query-builder/list-query-builder.ts
index d060c1a68b..c44ba88e67 100644
--- a/packages/core/src/service/helpers/list-query-builder/list-query-builder.ts
+++ b/packages/core/src/service/helpers/list-query-builder/list-query-builder.ts
@@ -493,14 +493,21 @@ export class ListQueryBuilder implements OnApplicationBootstrap {
loadEagerRelations: true,
} as FindManyOptions)
.then(results =>
- results.map(r => ({ relation: relationPaths[0] as keyof T, entity: r })),
+ results.map(r => ({
+ relations: relationPaths[0].startsWith('customFields.')
+ ? relationPaths
+ : [relationPaths[0]],
+ entity: r,
+ })),
);
}),
).then(all => all.flat());
for (const entry of entitiesIdsWithRelations) {
const finalEntity = entityMap.get(entry.entity.id);
- if (finalEntity) {
- this.assignDeep(entry.relation, entry.entity, finalEntity);
+ for (const relation of entry.relations) {
+ if (finalEntity) {
+ this.assignDeep(relation, entry.entity, finalEntity);
+ }
}
}
return Array.from(entityMap.values());
diff --git a/packages/core/src/service/services/order.service.ts b/packages/core/src/service/services/order.service.ts
index 715db9857b..0604c0feda 100644
--- a/packages/core/src/service/services/order.service.ts
+++ b/packages/core/src/service/services/order.service.ts
@@ -588,8 +588,9 @@ export class OrderService {
let updatedOrderLines = [orderLine];
if (correctedQuantity === 0) {
order.lines = order.lines.filter(l => !idsAreEqual(l.id, orderLine.id));
+ const deletedOrderLine = new OrderLine(orderLine);
await this.connection.getRepository(ctx, OrderLine).remove(orderLine);
- this.eventBus.publish(new OrderLineEvent(ctx, order, orderLine, 'deleted'));
+ this.eventBus.publish(new OrderLineEvent(ctx, order, deletedOrderLine, 'deleted'));
updatedOrderLines = [];
} else {
await this.orderModifier.updateOrderLineQuantity(ctx, orderLine, correctedQuantity, order);
@@ -620,8 +621,9 @@ export class OrderService {
const orderLine = this.getOrderLineOrThrow(order, orderLineId);
order.lines = order.lines.filter(line => !idsAreEqual(line.id, orderLineId));
const updatedOrder = await this.applyPriceAdjustments(ctx, order);
+ const deletedOrderLine = new OrderLine(orderLine);
await this.connection.getRepository(ctx, OrderLine).remove(orderLine);
- this.eventBus.publish(new OrderLineEvent(ctx, order, orderLine, 'deleted'));
+ this.eventBus.publish(new OrderLineEvent(ctx, order, deletedOrderLine, 'deleted'));
return updatedOrder;
}
diff --git a/packages/core/src/service/services/stock-movement.service.ts b/packages/core/src/service/services/stock-movement.service.ts
index e38fa9503d..f642286408 100644
--- a/packages/core/src/service/services/stock-movement.service.ts
+++ b/packages/core/src/service/services/stock-movement.service.ts
@@ -137,9 +137,6 @@ export class StockMovementService {
* increased, indicating that this quantity of stock is allocated and cannot be sold.
*/
async createAllocationsForOrder(ctx: RequestContext, order: Order): Promise {
- if (order.active !== false) {
- throw new InternalServerError('error.cannot-create-allocations-for-active-order');
- }
const lines = order.lines.map(orderLine => ({
orderLineId: orderLine.id,
quantity: orderLine.quantity,
diff --git a/packages/create/package.json b/packages/create/package.json
index 255876c5c3..4890a277e9 100644
--- a/packages/create/package.json
+++ b/packages/create/package.json
@@ -1,6 +1,6 @@
{
"name": "@vendure/create",
- "version": "2.1.4",
+ "version": "2.1.5",
"license": "MIT",
"bin": {
"create": "./index.js"
@@ -28,14 +28,14 @@
"@types/fs-extra": "^9.0.1",
"@types/handlebars": "^4.1.0",
"@types/semver": "^6.2.2",
- "@vendure/core": "^2.1.4",
+ "@vendure/core": "^2.1.5",
"rimraf": "^3.0.2",
"ts-node": "^10.9.1",
"typescript": "4.9.5"
},
"dependencies": {
"@clack/prompts": "^0.7.0",
- "@vendure/common": "^2.1.4",
+ "@vendure/common": "^2.1.5",
"commander": "^11.0.0",
"cross-spawn": "^7.0.3",
"detect-port": "^1.5.1",
diff --git a/packages/dev-server/package.json b/packages/dev-server/package.json
index deeb4cdb76..55687d46f7 100644
--- a/packages/dev-server/package.json
+++ b/packages/dev-server/package.json
@@ -1,6 +1,6 @@
{
"name": "dev-server",
- "version": "2.1.4",
+ "version": "2.1.5",
"main": "index.js",
"license": "MIT",
"private": true,
@@ -15,18 +15,18 @@
},
"dependencies": {
"@nestjs/axios": "^3.0.0",
- "@vendure/admin-ui-plugin": "^2.1.4",
- "@vendure/asset-server-plugin": "^2.1.4",
- "@vendure/common": "^2.1.4",
- "@vendure/core": "^2.1.4",
- "@vendure/elasticsearch-plugin": "^2.1.4",
- "@vendure/email-plugin": "^2.1.4",
+ "@vendure/admin-ui-plugin": "^2.1.5",
+ "@vendure/asset-server-plugin": "^2.1.5",
+ "@vendure/common": "^2.1.5",
+ "@vendure/core": "^2.1.5",
+ "@vendure/elasticsearch-plugin": "^2.1.5",
+ "@vendure/email-plugin": "^2.1.5",
"typescript": "4.9.5"
},
"devDependencies": {
"@types/csv-stringify": "^3.1.0",
- "@vendure/testing": "^2.1.4",
- "@vendure/ui-devkit": "^2.1.4",
+ "@vendure/testing": "^2.1.5",
+ "@vendure/ui-devkit": "^2.1.5",
"commander": "^7.1.0",
"concurrently": "^8.2.1",
"csv-stringify": "^5.3.3",
diff --git a/packages/elasticsearch-plugin/package.json b/packages/elasticsearch-plugin/package.json
index 8c019262ca..b73e4deefc 100644
--- a/packages/elasticsearch-plugin/package.json
+++ b/packages/elasticsearch-plugin/package.json
@@ -1,6 +1,6 @@
{
"name": "@vendure/elasticsearch-plugin",
- "version": "2.1.4",
+ "version": "2.1.5",
"license": "MIT",
"main": "lib/index.js",
"types": "lib/index.d.ts",
@@ -26,8 +26,8 @@
"fast-deep-equal": "^3.1.3"
},
"devDependencies": {
- "@vendure/common": "^2.1.4",
- "@vendure/core": "^2.1.4",
+ "@vendure/common": "^2.1.5",
+ "@vendure/core": "^2.1.5",
"rimraf": "^3.0.2",
"typescript": "4.9.5"
}
diff --git a/packages/elasticsearch-plugin/src/types.ts b/packages/elasticsearch-plugin/src/types.ts
index 85a8c387e4..25d5571ee7 100644
--- a/packages/elasticsearch-plugin/src/types.ts
+++ b/packages/elasticsearch-plugin/src/types.ts
@@ -271,7 +271,7 @@ type GraphQlPermittedReturnType = PrimitiveTypeVariations;
type CustomMappingDefinition = {
graphQlType: T;
public?: boolean;
- valueFn: (...args: Args) => R;
+ valueFn: (...args: Args) => Promise | R;
};
type TypeVariationMap = {
diff --git a/packages/email-plugin/package.json b/packages/email-plugin/package.json
index 537524cac4..2d0410083c 100644
--- a/packages/email-plugin/package.json
+++ b/packages/email-plugin/package.json
@@ -1,6 +1,6 @@
{
"name": "@vendure/email-plugin",
- "version": "2.1.4",
+ "version": "2.1.5",
"license": "MIT",
"main": "lib/index.js",
"types": "lib/index.d.ts",
@@ -35,8 +35,8 @@
"@types/fs-extra": "^9.0.1",
"@types/handlebars": "^4.1.0",
"@types/mjml": "^4.0.4",
- "@vendure/common": "^2.1.4",
- "@vendure/core": "^2.1.4",
+ "@vendure/common": "^2.1.5",
+ "@vendure/core": "^2.1.5",
"rimraf": "^3.0.2",
"typescript": "4.9.5"
}
diff --git a/packages/harden-plugin/package.json b/packages/harden-plugin/package.json
index b68c63d9b0..2cdadcff77 100644
--- a/packages/harden-plugin/package.json
+++ b/packages/harden-plugin/package.json
@@ -1,6 +1,6 @@
{
"name": "@vendure/harden-plugin",
- "version": "2.1.4",
+ "version": "2.1.5",
"license": "MIT",
"main": "lib/index.js",
"types": "lib/index.d.ts",
@@ -21,7 +21,7 @@
"graphql-query-complexity": "^0.12.0"
},
"devDependencies": {
- "@vendure/common": "^2.1.4",
- "@vendure/core": "^2.1.4"
+ "@vendure/common": "^2.1.5",
+ "@vendure/core": "^2.1.5"
}
}
diff --git a/packages/job-queue-plugin/package.json b/packages/job-queue-plugin/package.json
index 36d75cd2e8..96a09e21f4 100644
--- a/packages/job-queue-plugin/package.json
+++ b/packages/job-queue-plugin/package.json
@@ -1,6 +1,6 @@
{
"name": "@vendure/job-queue-plugin",
- "version": "2.1.4",
+ "version": "2.1.5",
"license": "MIT",
"main": "package/index.js",
"types": "package/index.d.ts",
@@ -23,8 +23,8 @@
},
"devDependencies": {
"@google-cloud/pubsub": "^2.8.0",
- "@vendure/common": "^2.1.4",
- "@vendure/core": "^2.1.4",
+ "@vendure/common": "^2.1.5",
+ "@vendure/core": "^2.1.5",
"bullmq": "^3.15.5",
"ioredis": "^5.3.0",
"rimraf": "^3.0.2",
diff --git a/packages/job-queue-plugin/src/bullmq/plugin.ts b/packages/job-queue-plugin/src/bullmq/plugin.ts
index c82d533af9..12f2839895 100644
--- a/packages/job-queue-plugin/src/bullmq/plugin.ts
+++ b/packages/job-queue-plugin/src/bullmq/plugin.ts
@@ -28,13 +28,13 @@ import { BullMQPluginOptions } from './types';
*
* ## Installation
*
- * `yarn add \@vendure/job-queue-plugin bullmq@1`
+ * `yarn add \@vendure/job-queue-plugin bullmq`
*
* or
*
- * `npm install \@vendure/job-queue-plugin bullmq@1`
+ * `npm install \@vendure/job-queue-plugin bullmq`
*
- * **Note:** The v1.x version of this plugin is designed to work with bullmq v1.x.
+ * **Note:** The v1.x version of this plugin is designed to work with bullmq v1.x, etc.
*
* @example
* ```ts
diff --git a/packages/payments-plugin/package.json b/packages/payments-plugin/package.json
index 2a1dc0d135..9432dbc4ee 100644
--- a/packages/payments-plugin/package.json
+++ b/packages/payments-plugin/package.json
@@ -1,6 +1,6 @@
{
"name": "@vendure/payments-plugin",
- "version": "2.1.4",
+ "version": "2.1.5",
"license": "MIT",
"main": "package/index.js",
"types": "package/index.d.ts",
@@ -46,9 +46,9 @@
"@mollie/api-client": "^3.7.0",
"@types/braintree": "^2.22.15",
"@types/localtunnel": "2.0.1",
- "@vendure/common": "^2.1.4",
- "@vendure/core": "^2.1.4",
- "@vendure/testing": "^2.1.4",
+ "@vendure/common": "^2.1.5",
+ "@vendure/core": "^2.1.5",
+ "@vendure/testing": "^2.1.5",
"braintree": "^3.16.0",
"localtunnel": "2.0.2",
"nock": "^13.1.4",
diff --git a/packages/payments-plugin/src/mollie/mollie.controller.ts b/packages/payments-plugin/src/mollie/mollie.controller.ts
index 42f57cc44a..be41ca78c5 100644
--- a/packages/payments-plugin/src/mollie/mollie.controller.ts
+++ b/packages/payments-plugin/src/mollie/mollie.controller.ts
@@ -1,17 +1,16 @@
import { Body, Controller, Param, Post } from '@nestjs/common';
-import { Ctx, Logger, RequestContext, Transaction } from '@vendure/core';
+import { Ctx, Logger, RequestContext, Transaction, ChannelService, LanguageCode } from '@vendure/core';
import { loggerCtx } from './constants';
import { MollieService } from './mollie.service';
@Controller('payments')
export class MollieController {
- constructor(private mollieService: MollieService) {}
+ constructor(private mollieService: MollieService, private channelService: ChannelService) {}
@Post('mollie/:channelToken/:paymentMethodId')
@Transaction()
async webhook(
- @Ctx() ctx: RequestContext,
@Param('channelToken') channelToken: string,
@Param('paymentMethodId') paymentMethodId: string,
@Body() body: any,
@@ -20,8 +19,10 @@ export class MollieController {
return Logger.warn(' Ignoring incoming webhook, because it has no body.id.', loggerCtx);
}
try {
+ // We need to construct a RequestContext based on the channelToken,
+ // because this is an incoming webhook, not a graphql request with a valid Ctx
+ const ctx = await this.createContext(channelToken);
await this.mollieService.handleMollieStatusUpdate(ctx, {
- channelToken,
paymentMethodId,
orderId: body.id,
});
@@ -34,4 +35,15 @@ export class MollieController {
throw error;
}
}
+
+ private async createContext(channelToken: string): Promise {
+ const channel = await this.channelService.getChannelFromToken(channelToken);
+ return new RequestContext({
+ apiType: 'admin',
+ isAuthorized: true,
+ authorizedAsOwnerOnly: false,
+ channel,
+ languageCode: LanguageCode.en,
+ });
+ }
}
diff --git a/packages/payments-plugin/src/mollie/mollie.service.ts b/packages/payments-plugin/src/mollie/mollie.service.ts
index a5a5c84b6e..3845a20b70 100644
--- a/packages/payments-plugin/src/mollie/mollie.service.ts
+++ b/packages/payments-plugin/src/mollie/mollie.service.ts
@@ -37,7 +37,6 @@ import { amountToCents, getLocale, toAmount, toMollieAddress, toMollieOrderLines
import { MolliePluginOptions } from './mollie.plugin';
interface OrderStatusInput {
- channelToken: string;
paymentMethodId: string;
orderId: string;
}
@@ -189,7 +188,7 @@ export class MollieService {
orderInput.method = molliePaymentMethodCode as MollieClientMethod;
}
const mollieOrder = await mollieClient.orders.create(orderInput);
- Logger.info(`Created Mollie order ${mollieOrder.id} for order ${order.code}`);
+ Logger.info(`Created Mollie order ${mollieOrder.id} for order ${order.code}`, loggerCtx);
const url = mollieOrder.getCheckoutUrl();
if (!url) {
throw Error('Unable to getCheckoutUrl() from Mollie order');
@@ -204,10 +203,10 @@ export class MollieService {
*/
async handleMollieStatusUpdate(
ctx: RequestContext,
- { channelToken, paymentMethodId, orderId }: OrderStatusInput,
+ { paymentMethodId, orderId }: OrderStatusInput,
): Promise {
Logger.info(
- `Received status update for channel ${channelToken} for Mollie order ${orderId}`,
+ `Received status update for channel ${ctx.channel.token} for Mollie order ${orderId}`,
loggerCtx,
);
const paymentMethod = await this.paymentMethodService.findOne(ctx, paymentMethodId);
@@ -218,12 +217,12 @@ export class MollieService {
const apiKey = paymentMethod.handler.args.find(a => a.name === 'apiKey')?.value;
const autoCapture = paymentMethod.handler.args.find(a => a.name === 'autoCapture')?.value === 'true';
if (!apiKey) {
- throw Error(`No apiKey found for payment ${paymentMethod.id} for channel ${channelToken}`);
+ throw Error(`No apiKey found for payment ${paymentMethod.id} for channel ${ctx.channel.token}`);
}
const client = createMollieClient({ apiKey });
const mollieOrder = await client.orders.get(orderId);
Logger.info(
- `Processing status '${mollieOrder.status}' for order ${mollieOrder.orderNumber} for channel ${channelToken} for Mollie order ${orderId}`,
+ `Processing status '${mollieOrder.status}' for order ${mollieOrder.orderNumber} for channel ${ctx.channel.token} for Mollie order ${orderId}`,
loggerCtx,
);
let order = await this.orderService.findOneByCode(ctx, mollieOrder.orderNumber, ['payments']);
@@ -260,6 +259,11 @@ export class MollieService {
if (order.state === 'PaymentAuthorized' && mollieOrder.status === OrderStatus.completed) {
return this.settleExistingPayment(ctx, order, mollieOrder.id);
}
+ if (autoCapture && mollieOrder.status === OrderStatus.completed) {
+ // When autocapture is enabled, we should not handle the completed status from Mollie,
+ // because the order will be transitioned to PaymentSettled during auto capture
+ return;
+ }
// Any other combination of Mollie status and Vendure status indicates something is wrong.
throw Error(
`Unhandled incoming Mollie status '${mollieOrder.status}' for order ${order.code} with status '${order.state}'`,
diff --git a/packages/sentry-plugin/.gitignore b/packages/sentry-plugin/.gitignore
new file mode 100644
index 0000000000..368c3fdfbe
--- /dev/null
+++ b/packages/sentry-plugin/.gitignore
@@ -0,0 +1,3 @@
+yarn-error.log
+lib
+e2e/__data__/*.sqlite
diff --git a/packages/sentry-plugin/README.md b/packages/sentry-plugin/README.md
new file mode 100644
index 0000000000..f2ec744784
--- /dev/null
+++ b/packages/sentry-plugin/README.md
@@ -0,0 +1,7 @@
+# Vendure Sentry Plugin
+
+Integrates your Vendure server with the [Sentry](https://sentry.io/) application monitoring service.
+
+`npm install @vendure/sentry-plugin`
+
+For documentation, see [docs.vendure.io/reference/core-plugins/sentry-plugin/](https://docs.vendure.io/reference/core-plugins/sentry-plugin/)
diff --git a/packages/sentry-plugin/index.ts b/packages/sentry-plugin/index.ts
new file mode 100644
index 0000000000..fca085aec0
--- /dev/null
+++ b/packages/sentry-plugin/index.ts
@@ -0,0 +1,4 @@
+export * from './src/sentry-plugin';
+export * from './src/sentry.service';
+export * from './src/types';
+export * from './src/constants';
diff --git a/packages/sentry-plugin/package.json b/packages/sentry-plugin/package.json
new file mode 100644
index 0000000000..2b6186a3f4
--- /dev/null
+++ b/packages/sentry-plugin/package.json
@@ -0,0 +1,28 @@
+{
+ "name": "@vendure/sentry-plugin",
+ "version": "2.1.5",
+ "license": "MIT",
+ "main": "lib/index.js",
+ "types": "lib/index.d.ts",
+ "files": [
+ "lib/**/*"
+ ],
+ "scripts": {
+ "watch": "tsc -p ./tsconfig.build.json --watch",
+ "build": "rimraf lib && tsc -p ./tsconfig.build.json",
+ "lint": "eslint --fix ."
+ },
+ "homepage": "https://www.vendure.io",
+ "funding": "https://github.com/sponsors/michaelbromley",
+ "publishConfig": {
+ "access": "public"
+ },
+ "peerDependencies": {
+ "@sentry/node": "^7.85.0"
+ },
+ "devDependencies": {
+ "@sentry/node": "^7.85.0",
+ "@vendure/common": "^2.1.5",
+ "@vendure/core": "^2.1.5"
+ }
+}
diff --git a/packages/sentry-plugin/src/api/admin-test.resolver.ts b/packages/sentry-plugin/src/api/admin-test.resolver.ts
new file mode 100644
index 0000000000..937f5c1c65
--- /dev/null
+++ b/packages/sentry-plugin/src/api/admin-test.resolver.ts
@@ -0,0 +1,32 @@
+import { Args, Mutation, Resolver } from '@nestjs/graphql';
+import { Allow, Permission, UserInputError } from '@vendure/core';
+
+import { SentryService } from '../sentry.service';
+import { ErrorTestService } from './error-test.service';
+
+declare const a: number;
+
+@Resolver()
+export class SentryAdminTestResolver {
+ constructor(private sentryService: SentryService, private errorTestService: ErrorTestService) {}
+
+ @Allow(Permission.SuperAdmin)
+ @Mutation()
+ async createTestError(@Args() args: { errorType: string }) {
+ switch (args.errorType) {
+ case 'UNCAUGHT_ERROR':
+ return a / 10;
+ case 'THROWN_ERROR':
+ throw new UserInputError('SentryPlugin Test Error');
+ case 'CAPTURED_ERROR':
+ this.sentryService.captureException(new Error('SentryPlugin Direct error'));
+ return true;
+ case 'CAPTURED_MESSAGE':
+ this.sentryService.captureMessage('Captured message');
+ return true;
+ case 'DATABASE_ERROR':
+ await this.errorTestService.createDatabaseError();
+ return true;
+ }
+ }
+}
diff --git a/packages/sentry-plugin/src/api/api-extensions.ts b/packages/sentry-plugin/src/api/api-extensions.ts
new file mode 100644
index 0000000000..6633714597
--- /dev/null
+++ b/packages/sentry-plugin/src/api/api-extensions.ts
@@ -0,0 +1,14 @@
+import gql from 'graphql-tag';
+
+export const testApiExtensions = gql`
+ enum TestErrorType {
+ UNCAUGHT_ERROR
+ THROWN_ERROR
+ CAPTURED_ERROR
+ CAPTURED_MESSAGE
+ DATABASE_ERROR
+ }
+ extend type Mutation {
+ createTestError(errorType: TestErrorType!): Boolean
+ }
+`;
diff --git a/packages/sentry-plugin/src/api/error-test.service.ts b/packages/sentry-plugin/src/api/error-test.service.ts
new file mode 100644
index 0000000000..4a1f2df346
--- /dev/null
+++ b/packages/sentry-plugin/src/api/error-test.service.ts
@@ -0,0 +1,11 @@
+import { Injectable } from '@nestjs/common';
+import { TransactionalConnection } from '@vendure/core';
+
+@Injectable()
+export class ErrorTestService {
+ constructor(private connection: TransactionalConnection) {}
+
+ createDatabaseError() {
+ return this.connection.rawConnection.query('SELECT * FROM non_existent_table');
+ }
+}
diff --git a/packages/sentry-plugin/src/constants.ts b/packages/sentry-plugin/src/constants.ts
new file mode 100644
index 0000000000..baa4e64601
--- /dev/null
+++ b/packages/sentry-plugin/src/constants.ts
@@ -0,0 +1,3 @@
+export const SENTRY_PLUGIN_OPTIONS = 'SENTRY_PLUGIN_OPTIONS';
+export const SENTRY_TRANSACTION_KEY = 'SENTRY_PLUGIN_TRANSACTION';
+export const loggerCtx = 'SentryPlugin';
diff --git a/packages/sentry-plugin/src/sentry-apollo-plugin.ts b/packages/sentry-plugin/src/sentry-apollo-plugin.ts
new file mode 100644
index 0000000000..59deaf9fa3
--- /dev/null
+++ b/packages/sentry-plugin/src/sentry-apollo-plugin.ts
@@ -0,0 +1,58 @@
+/* eslint-disable @typescript-eslint/require-await */
+import {
+ ApolloServerPlugin,
+ GraphQLRequestListener,
+ GraphQLRequestContext,
+ GraphQLRequestContextDidEncounterErrors,
+} from '@apollo/server';
+import { Transaction, setContext } from '@sentry/node';
+
+import { SENTRY_TRANSACTION_KEY } from './constants';
+
+/**
+ * Based on https://github.com/ntegral/nestjs-sentry/issues/97#issuecomment-1252446807
+ */
+export class SentryApolloPlugin implements ApolloServerPlugin {
+ constructor(private options: { enableTracing: boolean }) {}
+
+ async requestDidStart({
+ request,
+ contextValue,
+ }: GraphQLRequestContext): Promise> {
+ const { enableTracing } = this.options;
+ const transaction: Transaction | undefined = contextValue.req[SENTRY_TRANSACTION_KEY];
+ if (request.operationName) {
+ if (enableTracing) {
+ // set the transaction Name if we have named queries
+ transaction?.setName(request.operationName);
+ }
+ setContext('Graphql Request', {
+ operation_name: request.operationName,
+ variables: request.variables,
+ });
+ }
+
+ return {
+ // hook for transaction finished
+ async willSendResponse(context) {
+ transaction?.finish();
+ },
+ async executionDidStart() {
+ return {
+ // hook for each new resolver
+ willResolveField({ info }) {
+ if (enableTracing) {
+ const span = transaction?.startChild({
+ op: 'resolver',
+ description: `${info.parentType.name}.${info.fieldName}`,
+ });
+ return () => {
+ span?.finish();
+ };
+ }
+ },
+ };
+ },
+ };
+ }
+}
diff --git a/packages/sentry-plugin/src/sentry-context.middleware.ts b/packages/sentry-plugin/src/sentry-context.middleware.ts
new file mode 100644
index 0000000000..21cb0b75ab
--- /dev/null
+++ b/packages/sentry-plugin/src/sentry-context.middleware.ts
@@ -0,0 +1,25 @@
+import { Inject, Injectable, NestMiddleware } from '@nestjs/common';
+import { Request, Response, NextFunction } from 'express';
+
+import { SENTRY_PLUGIN_OPTIONS, SENTRY_TRANSACTION_KEY } from './constants';
+import { SentryService } from './sentry.service';
+import { SentryPluginOptions } from './types';
+
+@Injectable()
+export class SentryContextMiddleware implements NestMiddleware {
+ constructor(
+ @Inject(SENTRY_PLUGIN_OPTIONS) private options: SentryPluginOptions,
+ private sentryService: SentryService,
+ ) {}
+
+ use(req: Request, res: Response, next: NextFunction) {
+ if (this.options.enableTracing) {
+ const transaction = this.sentryService.startTransaction({
+ op: 'resolver',
+ name: `GraphQLTransaction`,
+ });
+ req[SENTRY_TRANSACTION_KEY] = transaction;
+ }
+ next();
+ }
+}
diff --git a/packages/sentry-plugin/src/sentry-plugin.ts b/packages/sentry-plugin/src/sentry-plugin.ts
new file mode 100644
index 0000000000..8b92646074
--- /dev/null
+++ b/packages/sentry-plugin/src/sentry-plugin.ts
@@ -0,0 +1,146 @@
+import { MiddlewareConsumer, NestModule } from '@nestjs/common';
+import { APP_FILTER } from '@nestjs/core';
+import { PluginCommonModule, VendurePlugin } from '@vendure/core';
+
+import { SentryAdminTestResolver } from './api/admin-test.resolver';
+import { testApiExtensions } from './api/api-extensions';
+import { ErrorTestService } from './api/error-test.service';
+import { SENTRY_PLUGIN_OPTIONS } from './constants';
+import { SentryApolloPlugin } from './sentry-apollo-plugin';
+import { SentryContextMiddleware } from './sentry-context.middleware';
+import { SentryExceptionsFilter } from './sentry.filter';
+import { SentryService } from './sentry.service';
+import { SentryPluginOptions } from './types';
+
+const SentryOptionsProvider = {
+ provide: SENTRY_PLUGIN_OPTIONS,
+ useFactory: () => SentryPlugin.options,
+};
+
+/**
+ * @description
+ * This plugin integrates the [Sentry](https://sentry.io) error tracking & performance monitoring
+ * service with your Vendure server. In addition to capturing errors, it also provides built-in
+ * support for [tracing](https://docs.sentry.io/product/sentry-basics/concepts/tracing/) as well as
+ * enriching your Sentry events with additional context about the request.
+ *
+ * ## Pre-requisites
+ *
+ * This plugin depends on access to Sentry, which can be self-hosted or used as a cloud service.
+ *
+ * If using the hosted SaaS option, you must have a Sentry account and a project set up ([sign up here](https://sentry.io/signup/)). When setting up your project,
+ * select the "Node.js" platform and no framework.
+ *
+ * Once set up, you will be given a [Data Source Name (DSN)](https://docs.sentry.io/product/sentry-basics/concepts/dsn-explainer/)
+ * which you will need to provide to the plugin.
+ *
+ * ## Installation
+ *
+ * Install this plugin as well as the `@sentry/node` package:
+ *
+ * ```sh
+ * npm install --save \@vendure/sentry-plugin \@sentry/node
+ * ```
+ *
+ * ## Configuration
+ *
+ * Before using the plugin, you must configure it with the DSN provided by Sentry:
+ *
+ * ```ts
+ * import { VendureConfig } from '\@vendure/core';
+ * import { SentryPlugin } from '\@vendure/sentry-plugin';
+ *
+ * export const config: VendureConfig = {
+ * // ...
+ * plugins: [
+ * // ...
+ * // highlight-start
+ * SentryPlugin.init({
+ * dsn: process.env.SENTRY_DSN,
+ * // Optional configuration
+ * includeErrorTestMutation: true,
+ * enableTracing: true,
+ * // you can also pass in any of the options from \@sentry/node
+ * // for instance:
+ * tracesSampleRate: 1.0,
+ * }),
+ * // highlight-end
+ * ],
+ * };
+ *```
+ *
+ * ## Tracing
+ *
+ * This plugin includes built-in support for [tracing](https://docs.sentry.io/product/sentry-basics/concepts/tracing/), which allows you to see the performance of your
+ * GraphQL resolvers in the Sentry dashboard. To enable tracing, set the `enableTracing` option to `true` as shown above.
+ *
+ * ## Instrumenting your own code
+ *
+ * You may want to add your own custom spans to your code. To do so, you can use the `Sentry` object
+ * just as you would in any Node application. For example:
+ *
+ * ```ts
+ * import * as Sentry from "\@sentry/node";
+ *
+ * export class MyService {
+ * async myMethod() {
+ * Sentry.setContext('My Custom Context,{
+ * key: 'value',
+ * });
+ * }
+ * }
+ * ```
+ *
+ * ## Error test mutation
+ *
+ * To test whether your Sentry configuration is working correctly, you can set the `includeErrorTestMutation` option to `true`. This will add a mutation to the Admin API
+ * which will throw an error of the type specified in the `errorType` argument. For example:
+ *
+ * ```graphql
+ * mutation CreateTestError {
+ * createTestError(errorType: DATABASE_ERROR)
+ * }
+ * ```
+ *
+ * You should then be able to see the error in your Sentry dashboard (it may take a couple of minutes to appear).
+ *
+ * @docsCategory core plugins/SentryPlugin
+ */
+@VendurePlugin({
+ imports: [PluginCommonModule],
+ providers: [
+ SentryOptionsProvider,
+ SentryService,
+ ErrorTestService,
+ {
+ provide: APP_FILTER,
+ useClass: SentryExceptionsFilter,
+ },
+ ],
+ configuration: config => {
+ config.apiOptions.apolloServerPlugins.push(
+ new SentryApolloPlugin({
+ enableTracing: !!SentryPlugin.options.enableTracing,
+ }),
+ );
+ return config;
+ },
+ adminApiExtensions: {
+ schema: () => (SentryPlugin.options.includeErrorTestMutation ? testApiExtensions : undefined),
+ resolvers: () => (SentryPlugin.options.includeErrorTestMutation ? [SentryAdminTestResolver] : []),
+ },
+ exports: [SentryService],
+ compatibility: '^2.0.0',
+})
+export class SentryPlugin implements NestModule {
+ static options: SentryPluginOptions = {} as any;
+
+ configure(consumer: MiddlewareConsumer): any {
+ consumer.apply(SentryContextMiddleware).forRoutes('*');
+ }
+
+ static init(options: SentryPluginOptions) {
+ this.options = options;
+ return this;
+ }
+}
diff --git a/packages/sentry-plugin/src/sentry.filter.ts b/packages/sentry-plugin/src/sentry.filter.ts
new file mode 100644
index 0000000000..cd248842ec
--- /dev/null
+++ b/packages/sentry-plugin/src/sentry.filter.ts
@@ -0,0 +1,27 @@
+import type { ArgumentsHost, ExceptionFilter } from '@nestjs/common';
+import { Catch, ExecutionContext } from '@nestjs/common';
+import { GqlContextType, GqlExecutionContext } from '@nestjs/graphql';
+import { setContext } from '@sentry/node';
+
+import { SentryService } from './sentry.service';
+
+@Catch()
+export class SentryExceptionsFilter implements ExceptionFilter {
+ constructor(private readonly sentryService: SentryService) {}
+
+ catch(exception: Error, host: ArgumentsHost): void {
+ if (host.getType() === 'graphql') {
+ const gqlContext = GqlExecutionContext.create(host as ExecutionContext);
+ const info = gqlContext.getInfo();
+ setContext('GraphQL Error Context', {
+ fieldName: info.fieldName,
+ path: info.path,
+ });
+ }
+ const variables = (exception as any).variables;
+ if (variables) {
+ setContext('GraphQL Error Variables', variables);
+ }
+ this.sentryService.captureException(exception);
+ }
+}
diff --git a/packages/sentry-plugin/src/sentry.service.ts b/packages/sentry-plugin/src/sentry.service.ts
new file mode 100644
index 0000000000..307fc339d3
--- /dev/null
+++ b/packages/sentry-plugin/src/sentry.service.ts
@@ -0,0 +1,40 @@
+import { Inject, Injectable, OnApplicationBootstrap, OnApplicationShutdown } from '@nestjs/common';
+import * as Sentry from '@sentry/node';
+import { CaptureContext, TransactionContext } from '@sentry/types';
+
+import { SENTRY_PLUGIN_OPTIONS } from './constants';
+import { SentryPluginOptions } from './types';
+
+@Injectable()
+export class SentryService implements OnApplicationBootstrap, OnApplicationShutdown {
+ constructor(@Inject(SENTRY_PLUGIN_OPTIONS) private options: SentryPluginOptions) {}
+
+ onApplicationBootstrap(): any {
+ const integrations = this.options.integrations ?? [
+ new Sentry.Integrations.Http({ tracing: true }),
+ ...Sentry.autoDiscoverNodePerformanceMonitoringIntegrations(),
+ ];
+ Sentry.init({
+ ...this.options,
+ tracesSampleRate: this.options.tracesSampleRate ?? 1.0,
+ integrations,
+ dsn: this.options.dsn,
+ });
+ }
+
+ onApplicationShutdown() {
+ return Sentry.close();
+ }
+
+ captureException(exception: Error) {
+ Sentry.captureException(exception);
+ }
+
+ captureMessage(message: string, captureContext?: CaptureContext) {
+ Sentry.captureMessage(message, captureContext);
+ }
+
+ startTransaction(context: TransactionContext) {
+ return Sentry.startTransaction(context);
+ }
+}
diff --git a/packages/sentry-plugin/src/types.ts b/packages/sentry-plugin/src/types.ts
new file mode 100644
index 0000000000..b31eb99ba1
--- /dev/null
+++ b/packages/sentry-plugin/src/types.ts
@@ -0,0 +1,26 @@
+import { Transaction } from '@sentry/node';
+import { NodeOptions } from '@sentry/node/types/types';
+
+import { SENTRY_TRANSACTION_KEY } from './constants';
+
+/**
+ * @description
+ * Configuration options for the {@link SentryPlugin}.
+ *
+ * @docsCategory core plugins/SentryPlugin
+ */
+export interface SentryPluginOptions extends NodeOptions {
+ /**
+ * @description
+ * The [Data Source Name](https://docs.sentry.io/product/sentry-basics/concepts/dsn-explainer/) for your Sentry instance.
+ */
+ dsn: string;
+ enableTracing?: boolean;
+ includeErrorTestMutation?: boolean;
+}
+
+declare module 'express' {
+ interface Request {
+ [SENTRY_TRANSACTION_KEY]: Transaction | undefined;
+ }
+}
diff --git a/packages/sentry-plugin/tsconfig.build.json b/packages/sentry-plugin/tsconfig.build.json
new file mode 100644
index 0000000000..821b637ae7
--- /dev/null
+++ b/packages/sentry-plugin/tsconfig.build.json
@@ -0,0 +1,9 @@
+{
+ "extends": "./tsconfig.json",
+ "compilerOptions": {
+ "outDir": "./lib"
+ },
+ "files": [
+ "./index.ts"
+ ]
+}
diff --git a/packages/sentry-plugin/tsconfig.json b/packages/sentry-plugin/tsconfig.json
new file mode 100644
index 0000000000..f343c8c4b3
--- /dev/null
+++ b/packages/sentry-plugin/tsconfig.json
@@ -0,0 +1,10 @@
+{
+ "extends": "../../tsconfig.json",
+ "compilerOptions": {
+ "declaration": true,
+ "removeComments": false,
+ "noLib": false,
+ "skipLibCheck": true,
+ "sourceMap": true
+ }
+}
diff --git a/packages/stellate-plugin/.gitignore b/packages/stellate-plugin/.gitignore
new file mode 100644
index 0000000000..368c3fdfbe
--- /dev/null
+++ b/packages/stellate-plugin/.gitignore
@@ -0,0 +1,3 @@
+yarn-error.log
+lib
+e2e/__data__/*.sqlite
diff --git a/packages/stellate-plugin/README.md b/packages/stellate-plugin/README.md
new file mode 100644
index 0000000000..f7ad80eac5
--- /dev/null
+++ b/packages/stellate-plugin/README.md
@@ -0,0 +1,7 @@
+# Vendure Stellate Plugin
+
+Integrates your Vendure server with the [Stellate](TaxRateEvent) GraphQL API cache.
+
+`npm install @vendure/stellate-plugin`
+
+For documentation, see [docs.vendure.io/reference/core-plugins/stellate-plugin/](https://docs.vendure.io/reference/core-plugins/stellate-plugin/)
diff --git a/packages/stellate-plugin/index.ts b/packages/stellate-plugin/index.ts
new file mode 100644
index 0000000000..e270ae43f8
--- /dev/null
+++ b/packages/stellate-plugin/index.ts
@@ -0,0 +1,6 @@
+export * from './src/stellate-plugin';
+export * from './src/service/stellate.service';
+export * from './src/default-purge-rules';
+export * from './src/purge-rule';
+export * from './src/types';
+export * from './src/constants';
diff --git a/packages/stellate-plugin/package.json b/packages/stellate-plugin/package.json
new file mode 100644
index 0000000000..d1e7b36794
--- /dev/null
+++ b/packages/stellate-plugin/package.json
@@ -0,0 +1,27 @@
+{
+ "name": "@vendure/stellate-plugin",
+ "version": "2.1.5",
+ "license": "MIT",
+ "main": "lib/index.js",
+ "types": "lib/index.d.ts",
+ "files": [
+ "lib/**/*"
+ ],
+ "scripts": {
+ "watch": "tsc -p ./tsconfig.build.json --watch",
+ "build": "rimraf lib && tsc -p ./tsconfig.build.json",
+ "lint": "eslint --fix ."
+ },
+ "homepage": "https://www.vendure.io",
+ "funding": "https://github.com/sponsors/michaelbromley",
+ "publishConfig": {
+ "access": "public"
+ },
+ "dependencies": {
+ "node-fetch": "^2.7.0"
+ },
+ "devDependencies": {
+ "@vendure/common": "^2.1.5",
+ "@vendure/core": "^2.1.5"
+ }
+}
diff --git a/packages/stellate-plugin/src/api/api-extensions.ts b/packages/stellate-plugin/src/api/api-extensions.ts
new file mode 100644
index 0000000000..239c6f3679
--- /dev/null
+++ b/packages/stellate-plugin/src/api/api-extensions.ts
@@ -0,0 +1,17 @@
+import gql from 'graphql-tag';
+
+export const shopApiExtensions = gql`
+ """
+ This type is here to allow us to easily purge the Stellate cache
+ of any search results where the collectionSlug is used. We cannot rely on
+ simply purging the SearchResult type, because in the case of an empty 'items'
+ array, Stellate cannot know that that particular query now needs to be purged.
+ """
+ type SearchResponseCacheIdentifier {
+ collectionSlug: String
+ }
+
+ extend type SearchResponse {
+ cacheIdentifier: SearchResponseCacheIdentifier
+ }
+`;
diff --git a/packages/stellate-plugin/src/api/search-response.resolver.ts b/packages/stellate-plugin/src/api/search-response.resolver.ts
new file mode 100644
index 0000000000..4e522480ff
--- /dev/null
+++ b/packages/stellate-plugin/src/api/search-response.resolver.ts
@@ -0,0 +1,11 @@
+import { Info, ResolveField, Resolver } from '@nestjs/graphql';
+import { GraphQLResolveInfo } from 'graphql/type';
+
+@Resolver('SearchResponse')
+export class SearchResponseFieldResolver {
+ @ResolveField()
+ cacheIdentifier(@Info() info: GraphQLResolveInfo) {
+ const collectionSlug = (info.variableValues.input as any)?.collectionSlug;
+ return { collectionSlug };
+ }
+}
diff --git a/packages/stellate-plugin/src/constants.ts b/packages/stellate-plugin/src/constants.ts
new file mode 100644
index 0000000000..80409e0e7b
--- /dev/null
+++ b/packages/stellate-plugin/src/constants.ts
@@ -0,0 +1,2 @@
+export const STELLATE_PLUGIN_OPTIONS = 'STELLATE_PLUGIN_OPTIONS';
+export const loggerCtx = 'StellatePlugin';
diff --git a/packages/stellate-plugin/src/default-purge-rules.ts b/packages/stellate-plugin/src/default-purge-rules.ts
new file mode 100644
index 0000000000..780ea40057
--- /dev/null
+++ b/packages/stellate-plugin/src/default-purge-rules.ts
@@ -0,0 +1,105 @@
+/* eslint-disable @typescript-eslint/no-floating-promises */
+import {
+ CollectionEvent,
+ CollectionModificationEvent,
+ Logger,
+ ProductChannelEvent,
+ ProductEvent,
+ ProductVariantChannelEvent,
+ ProductVariantEvent,
+ StockMovementEvent,
+ TaxRateEvent,
+} from '@vendure/core';
+
+import { loggerCtx } from './constants';
+import { PurgeRule } from './purge-rule';
+
+export const purgeProductsOnProductEvent = new PurgeRule({
+ eventType: ProductEvent,
+ handler: ({ events, stellateService }) => {
+ const products = events.map(e => e.product);
+ stellateService.purgeProducts(products);
+ stellateService.purgeSearchResults(products);
+ },
+});
+
+export const purgeProductVariantsOnProductVariantEvent = new PurgeRule({
+ eventType: ProductVariantEvent,
+ handler: ({ events, stellateService }) => {
+ const variants = events.map(e => e.variants).flat();
+ stellateService.purgeProductVariants(variants);
+ stellateService.purgeSearchResults(variants);
+ },
+});
+
+export const purgeProductsOnChannelEvent = new PurgeRule({
+ eventType: ProductChannelEvent,
+ handler: ({ events, stellateService }) => {
+ const products = events.map(e => e.product);
+ stellateService.purgeProducts(products);
+ stellateService.purgeSearchResults(products);
+ },
+});
+
+export const purgeProductVariantsOnChannelEvent = new PurgeRule({
+ eventType: ProductVariantChannelEvent,
+ handler: ({ events, stellateService }) => {
+ const variants = events.map(e => e.productVariant);
+ stellateService.purgeProductVariants(variants);
+ stellateService.purgeSearchResults(variants);
+ },
+});
+
+export const purgeProductVariantsOnStockMovementEvent = new PurgeRule({
+ eventType: StockMovementEvent,
+ handler: ({ events, stellateService }) => {
+ const variants = events.map(e => e.stockMovements.map(m => m.productVariant)).flat();
+ stellateService.purgeProductVariants(variants);
+ stellateService.purgeSearchResults(variants);
+ },
+});
+
+export const purgeCollectionsOnCollectionModificationEvent = new PurgeRule({
+ eventType: CollectionModificationEvent,
+ handler: ({ events, stellateService }) => {
+ const collectionsToPurge = events.filter(e => e.productVariantIds.length).map(e => e.collection);
+ Logger.debug(
+ `purgeCollectionsOnCollectionModificationEvent, collectionsToPurge: ${collectionsToPurge
+ .map(c => c.id)
+ .join(', ')}`,
+ loggerCtx,
+ );
+ if (collectionsToPurge.length) {
+ stellateService.purgeCollections(collectionsToPurge);
+ stellateService.purgeSearchResponseCacheIdentifiers(collectionsToPurge);
+ }
+ },
+});
+
+export const purgeCollectionsOnCollectionEvent = new PurgeRule({
+ eventType: CollectionEvent,
+ handler: ({ events, stellateService }) => {
+ const collections = events.map(e => e.entity);
+ stellateService.purgeCollections(collections);
+ },
+});
+
+export const purgeAllOnTaxRateEvent = new PurgeRule({
+ eventType: TaxRateEvent,
+ handler: ({ stellateService }) => {
+ stellateService.purgeAllOfType('ProductVariant');
+ stellateService.purgeAllOfType('Product');
+ stellateService.purgeAllOfType('SearchResponse');
+ },
+});
+
+export const defaultPurgeRules = [
+ purgeAllOnTaxRateEvent,
+ purgeCollectionsOnCollectionEvent,
+ purgeCollectionsOnCollectionModificationEvent,
+ purgeProductsOnChannelEvent,
+ purgeProductsOnProductEvent,
+ purgeProductVariantsOnChannelEvent,
+ purgeProductVariantsOnProductVariantEvent,
+ purgeProductVariantsOnStockMovementEvent,
+];
diff --git a/packages/stellate-plugin/src/purge-rule.ts b/packages/stellate-plugin/src/purge-rule.ts
new file mode 100644
index 0000000000..d73f9ca37b
--- /dev/null
+++ b/packages/stellate-plugin/src/purge-rule.ts
@@ -0,0 +1,60 @@
+import { Type } from '@vendure/common/lib/shared-types';
+import { VendureEvent, Injector } from '@vendure/core';
+
+import { StellateService } from './service/stellate.service';
+
+/**
+ * @description
+ * Configures a {@link PurgeRule}.
+ *
+ * @docsCategory core plugins/StellatePlugin
+ * @docsPage PurgeRule
+ */
+export interface PurgeRuleConfig {
+ /**
+ * @description
+ * Specifies which VendureEvent will trigger this purge rule.
+ */
+ eventType: Type;
+ /**
+ * @description
+ * How long to buffer events for in milliseconds before executing the handler. This allows
+ * us to efficiently batch calls to the Stellate Purge API.
+ *
+ * @default 5000
+ */
+ bufferTime?: number;
+ /**
+ * @description
+ * The function to invoke when the specified event is published. This function should use the
+ * {@link StellateService} instance to call the Stellate Purge API.
+ */
+ handler: (handlerArgs: {
+ events: Event[];
+ stellateService: StellateService;
+ injector: Injector;
+ }) => void | Promise;
+}
+
+/**
+ * @description
+ * Defines a rule that listens for a particular VendureEvent and uses that to
+ * make calls to the [Stellate Purging API](https://docs.stellate.co/docs/purging-api) via
+ * the provided {@link StellateService} instance.
+ *
+ * @docsCategory core plugins/StellatePlugin
+ * @docsPage PurgeRule
+ * @docsWeight 0
+ */
+export class PurgeRule {
+ get eventType(): Type {
+ return this.config.eventType;
+ }
+ get bufferTimeMs(): number | undefined {
+ return this.config.bufferTime;
+ }
+ handle(handlerArgs: { events: Event[]; stellateService: StellateService; injector: Injector }) {
+ return this.config.handler(handlerArgs);
+ }
+ constructor(private config: PurgeRuleConfig) {}
+}
diff --git a/packages/stellate-plugin/src/service/stellate.service.ts b/packages/stellate-plugin/src/service/stellate.service.ts
new file mode 100644
index 0000000000..a3913fd265
--- /dev/null
+++ b/packages/stellate-plugin/src/service/stellate.service.ts
@@ -0,0 +1,150 @@
+import { Inject } from '@nestjs/common';
+import { Collection, ID, Logger, Product, ProductVariant } from '@vendure/core';
+import fetch from 'node-fetch';
+
+import { loggerCtx, STELLATE_PLUGIN_OPTIONS } from '../constants';
+import { StellatePluginOptions } from '../types';
+
+type CachedType =
+ | 'Product'
+ | 'ProductVariant'
+ | 'Collection'
+ | 'SearchResponse'
+ | 'SearchResult'
+ | 'SearchResponseCacheIdentifier'
+ | string;
+
+/**
+ * @description
+ * The StellateService is used to purge the Stellate cache when certain events occur.
+ *
+ * @docsCategory core plugins/StellatePlugin
+ */
+export class StellateService {
+ private readonly purgeApiUrl: string;
+
+ constructor(@Inject(STELLATE_PLUGIN_OPTIONS) private options: StellatePluginOptions) {
+ this.purgeApiUrl = `https://admin.stellate.co/${options.serviceName}`;
+ }
+
+ /**
+ * @description
+ * Purges the cache for the given Products.
+ */
+ async purgeProducts(products: Product[]) {
+ Logger.verbose(`Purging cache: Product(${products.map(p => p.id).join(', ')})`, loggerCtx);
+ await this.purge(
+ 'Product',
+ products.map(p => p.id),
+ );
+ }
+
+ /**
+ * @description
+ * Purges the cache for the given ProductVariants.
+ */
+ async purgeProductVariants(productVariants: ProductVariant[]) {
+ Logger.verbose(
+ `Purging cache: ProductVariant(${productVariants.map(p => p.id).join(', ')})`,
+ loggerCtx,
+ );
+ await this.purge(
+ 'ProductVariant',
+ productVariants.map(p => p.id),
+ );
+ }
+
+ /**
+ * @description
+ * Purges the cache for SearchResults which contain the given Products or ProductVariants.
+ */
+ async purgeSearchResults(items: Array) {
+ const productIds = items.map(item => (item instanceof Product ? item.id : item.productId));
+ Logger.verbose(`Purging cache: SearchResult(${productIds.join(', ')})`, loggerCtx);
+ await this.purge('SearchResult', productIds, 'productId');
+ }
+
+ /**
+ * @description
+ * Purges the entire cache for the given type.
+ */
+ async purgeAllOfType(type: CachedType) {
+ Logger.verbose(`Purging cache: All ${type}s`, loggerCtx);
+ await this.purge(type);
+ }
+
+ /**
+ * @description
+ * Purges the cache for the given Collections.
+ */
+ async purgeCollections(collections: Collection[]) {
+ Logger.verbose(`Purging cache: Collection(${collections.map(c => c.id).join(', ')})`, loggerCtx);
+ await this.purge(
+ 'Collection',
+ collections.map(p => p.id),
+ );
+ }
+
+ /**
+ * @description
+ * Purges the cache of SearchResults for the given Collections based on slug.
+ */
+ async purgeSearchResponseCacheIdentifiers(collections: Collection[]) {
+ const slugs = collections.map(c => c.slug ?? c.translations?.[0]?.slug);
+ if (slugs.length) {
+ Logger.verbose(`Purging cache: SearchResponseCacheIdentifier(${slugs.join(', ')})`, loggerCtx);
+ await this.purge('SearchResponseCacheIdentifier', slugs);
+ }
+ }
+
+ /**
+ * @description
+ * Purges the cache for the given type and keys.
+ */
+ purge(type: CachedType, keys?: ID[], keyName = 'id') {
+ const payload = {
+ query: `
+ mutation PurgeType($type: String!, $keyFields: [KeyFieldInput!]) {
+ _purgeType(type: $type, keyFields: $keyFields)
+ }
+ `,
+ variables: {
+ type,
+ keyFields: keys?.filter(id => !!id).map(id => ({ name: keyName, value: id.toString() })),
+ },
+ };
+ if (this.options.debugLogging === true) {
+ const keyFieldsLength = payload.variables.keyFields?.length ?? 0;
+ if (5 < keyFieldsLength) {
+ payload.variables.keyFields = payload.variables.keyFields?.slice(0, 5);
+ }
+ Logger.debug('Purge arguments:\n' + JSON.stringify(payload.variables, null, 2), loggerCtx);
+ if (5 < keyFieldsLength) {
+ Logger.debug(`(A further ${keyFieldsLength - 5} keyFields truncated)`, loggerCtx);
+ }
+ }
+ if (this.options.devMode === true) {
+ // no-op
+ } else {
+ return fetch(this.purgeApiUrl, {
+ method: 'POST',
+ headers: {
+ 'Content-Type': 'application/json',
+ 'stellate-token': this.options.apiToken,
+ },
+ body: JSON.stringify(payload),
+ timeout: 5000,
+ })
+ .then(res => res.json())
+ .then(json => {
+ if (json.data?._purgeType !== true) {
+ const errors = json.errors?.map((e: any) => e.message) as string[];
+ Logger.error(`Purge failed: ${errors.join(', ') ?? JSON.stringify(json)}`, loggerCtx);
+ }
+ })
+ .catch((err: any) => {
+ Logger.error(`Purge error: ${err.message as string}`, loggerCtx);
+ });
+ }
+ }
+}
diff --git a/packages/stellate-plugin/src/stellate-plugin.ts b/packages/stellate-plugin/src/stellate-plugin.ts
new file mode 100644
index 0000000000..a39cfb8700
--- /dev/null
+++ b/packages/stellate-plugin/src/stellate-plugin.ts
@@ -0,0 +1,288 @@
+import { Inject, OnApplicationBootstrap } from '@nestjs/common';
+import { ModuleRef } from '@nestjs/core';
+import { EventBus, Injector, PluginCommonModule, VendurePlugin } from '@vendure/core';
+import { buffer, debounceTime } from 'rxjs/operators';
+
+import { shopApiExtensions } from './api/api-extensions';
+import { SearchResponseFieldResolver } from './api/search-response.resolver';
+import { STELLATE_PLUGIN_OPTIONS } from './constants';
+import { StellateService } from './service/stellate.service';
+import { StellatePluginOptions } from './types';
+
+const StellateOptionsProvider = {
+ provide: STELLATE_PLUGIN_OPTIONS,
+ useFactory: () => StellatePlugin.options,
+};
+
+/**
+ * @description
+ * A plugin to integrate the [Stellate](https://stellate.co/) GraphQL caching service with your Vendure server.
+ * The main purpose of this plugin is to ensure that cached data gets correctly purged in
+ * response to events inside Vendure. For example, changes to a Product's description should
+ * purge any associated record for that Product in Stellate's cache.
+ *
+ * ## Pre-requisites
+ *
+ * You will first need to [set up a free Stellate account](https://stellate.co/signup).
+ *
+ * You will also need to generate an **API token** for the Stellate Purging API. For instructions on how to generate the token,
+ * see the [Stellate Purging API docs](https://docs.stellate.co/docs/purging-api#authentication).
+ *
+ * ## Installation
+ *
+ * ```
+ * npm install \@vendure/stellate-plugin
+ * ```
+ *
+ * ## Configuration
+ *
+ * The plugin is configured via the `StellatePlugin.init()` method. This method accepts an options object
+ * which defines the Stellate service name and API token, as well as an array of {@link PurgeRule}s which
+ * define how the plugin will respond to Vendure events in order to trigger calls to the
+ * Stellate [Purging API](https://stellate.co/docs/graphql-edge-cache/purging-api).
+ *
+ * @example
+ * ```ts
+ * import { StellatePlugin, defaultPurgeRules } from '\@vendure/stellate-plugin';
+ * import { VendureConfig } from '\@vendure/core';
+ *
+ * export const config: VendureConfig = {
+ * // ...
+ * plugins: [
+ * StellatePlugin.init({
+ * // The Stellate service name, i.e. `.stellate.sh`
+ * serviceName: 'my-service',
+ * // The API token for the Stellate Purging API. See the "pre-requisites" section above.
+ * apiToken: process.env.STELLATE_PURGE_API_TOKEN,
+ * debugMode: !isProd || process.env.STELLATE_DEBUG_MODE ? true : false,
+ * debugLogging: process.env.STELLATE_DEBUG_MODE ? true : false,
+ * purgeRules: [
+ * ...defaultPurgeRules,
+ * // custom purge rules can be added here
+ * ],
+ * }),
+ * ],
+ * };
+ * ```
+ *
+ * In your Stellate dashboard, you can use the following configuration example as a sensible default for a
+ * Vendure application:
+ *
+ * @example
+ * ```ts
+ * import { Config } from "stellate";
+ *
+ * const config: Config = {
+ * config: {
+ * name: "my-vendure-server",
+ * originUrl: "https://my-vendure-server.com/shop-api",
+ * ignoreOriginCacheControl: true,
+ * passThroughOnly: false,
+ * scopes: {
+ * SESSION_BOUND: "header:authorization|cookie:session",
+ * },
+ * headers: {
+ * "access-control-expose-headers": "vendure-auth-token",
+ * },
+ * rootTypeNames: {
+ * query: "Query",
+ * mutation: "Mutation",
+ * },
+ * keyFields: {
+ * types: {
+ * SearchResult: ["productId"],
+ * SearchResponseCacheIdentifier: ["collectionSlug"],
+ * },
+ * },
+ * rules: [
+ * {
+ * types: [
+ * "Product",
+ * "Collection",
+ * "ProductVariant",
+ * "SearchResponse",
+ * ],
+ * maxAge: 900,
+ * swr: 900,
+ * description: "Cache Products & Collections",
+ * },
+ * {
+ * types: ["Channel"],
+ * maxAge: 9000,
+ * swr: 9000,
+ * description: "Cache active channel",
+ * },
+ * {
+ * types: ["Order", "Customer", "User"],
+ * maxAge: 0,
+ * swr: 0,
+ * description: "Do not cache user data",
+ * },
+ * ],
+ * },
+ * };
+ * export default config;
+ * ```
+ *
+ * ## Storefront setup
+ *
+ * In your storefront, you should point your GraphQL client to the Stellate GraphQL API endpoint, which is
+ * `https://.stellate.sh`.
+ *
+ * Wherever you are using the `search` query (typically in product listing & search pages), you should also add the
+ * `cacheIdentifier` field to the query. This will ensure that the Stellate cache is correctly purged when
+ * a Product or Collection is updated.
+ *
+ * @example
+ * ```ts
+ * import { graphql } from '../generated/gql';
+ *
+ * export const searchProductsDocument = graphql(`
+ * query SearchProducts($input: SearchInput!) {
+ * search(input: $input) {
+ * // highlight-start
+ * cacheIdentifier {
+ * collectionSlug
+ * }
+ * // highlight-end
+ * items {
+ * # ...
+ * }
+ * }
+ * }
+ * }`);
+ * ```
+ *
+ * ## Custom PurgeRules
+ *
+ * The configuration above only accounts for caching of some of the built-in Vendure entity types. If you have
+ * custom entity types, you may well want to add them to the Stellate cache. In this case, you'll also need a way to
+ * purge those entities from the cache when they are updated. This is where the {@link PurgeRule} comes in.
+ *
+ * Let's imagine that you have built a simple CMS plugin for Vendure which exposes an `Article` entity in your Shop API, and
+ * you have added this to your Stellate configuration:
+ *
+ * @example
+ * ```ts
+ * import { Config } from "stellate";
+ *
+ * const config: Config = {
+ * config: {
+ * // ...
+ * rules: [
+ * // ...
+ * {
+ * types: ["Article"],
+ * maxAge: 900,
+ * swr: 900,
+ * description: "Cache Articles",
+ * },
+ * ],
+ * },
+ * // ...
+ * };
+ * export default config;
+ * ```
+ *
+ * You can then add a custom {@link PurgeRule} to the StellatePlugin configuration:
+ *
+ * @example
+ * ```ts
+ * import { StellatePlugin, defaultPurgeRules } from "\@vendure/stellate-plugin";
+ * import { VendureConfig } from "\@vendure/core";
+ * import { ArticleEvent } from "./plugins/cms/events/article-event";
+ *
+ * export const config: VendureConfig = {
+ * // ...
+ * plugins: [
+ * StellatePlugin.init({
+ * // ...
+ * purgeRules: [
+ * ...defaultPurgeRules,
+ * new PurgeRule({
+ * eventType: ArticleEvent,
+ * handler: async ({ events, stellateService }) => {
+ * const articleIds = events.map((e) => e.article.id);
+ * stellateService.purge("Article", articleIds);
+ * },
+ * }),
+ * ],
+ * }),
+ * ],
+ * };
+ * ```
+ *
+ * ## DevMode & Debug Logging
+ *
+ * In development, you can set `devMode: true`, which will prevent any calls being made to the Stellate Purging API.
+ *
+ * If you want to log the calls that _would_ be made to the Stellate Purge API when in devMode, you can set `debugLogging: true`.
+ * Note that debugLogging generates a lot of debug-level logging, so it is recommended to only enable this when needed.
+ *
+ * @example
+ * ```ts
+ * import { StellatePlugin, defaultPurgeRules } from '\@vendure/stellate-plugin';
+ * import { VendureConfig } from '\@vendure/core';
+ *
+ * export const config: VendureConfig = {
+ * // ...
+ * plugins: [
+ * StellatePlugin.init({
+ * // ...
+ * devMode: !process.env.PRODUCTION,
+ * debugLogging: process.env.STELLATE_DEBUG_MODE ? true : false,
+ * purgeRules: [
+ * ...defaultPurgeRules,
+ * ],
+ * }),
+ * ],
+ * };
+ * ```
+ *
+ *
+ * @since 2.1.5
+ * @docsCategory core plugins/StellatePlugin
+ */
+@VendurePlugin({
+ imports: [PluginCommonModule],
+ providers: [StellateOptionsProvider, StellateService],
+ shopApiExtensions: {
+ schema: shopApiExtensions,
+ resolvers: [SearchResponseFieldResolver],
+ },
+ compatibility: '^2.0.0',
+})
+export class StellatePlugin implements OnApplicationBootstrap {
+ static options: StellatePluginOptions;
+
+ static init(options: StellatePluginOptions) {
+ this.options = options;
+ return this;
+ }
+
+ constructor(
+ @Inject(STELLATE_PLUGIN_OPTIONS) private options: StellatePluginOptions,
+ private eventBus: EventBus,
+ private stellateService: StellateService,
+ private moduleRef: ModuleRef,
+ ) {}
+
+ onApplicationBootstrap() {
+ const injector = new Injector(this.moduleRef);
+
+ for (const purgeRule of this.options.purgeRules ?? []) {
+ const source$ = this.eventBus.ofType(purgeRule.eventType);
+ source$
+ .pipe(
+ buffer(
+ source$.pipe(
+ debounceTime(purgeRule.bufferTimeMs ?? this.options.defaultBufferTimeMs ?? 2000),
+ ),
+ ),
+ )
+ .subscribe(events =>
+ purgeRule.handle({ events, injector, stellateService: this.stellateService }),
+ );
+ }
+ }
+}
diff --git a/packages/stellate-plugin/src/types.ts b/packages/stellate-plugin/src/types.ts
new file mode 100644
index 0000000000..e2169ad358
--- /dev/null
+++ b/packages/stellate-plugin/src/types.ts
@@ -0,0 +1,52 @@
+import { PurgeRule } from './purge-rule';
+
+/**
+ * @description
+ * Configuration options for the StellatePlugin.
+ *
+ * @docsCategory core plugins/StellatePlugin
+ */
+export interface StellatePluginOptions {
+ /**
+ * @description
+ * The Stellate service name, i.e. `.stellate.sh`
+ */
+ serviceName: string;
+ /**
+ * @description
+ * The Stellate Purging API token. For instructions on how to generate the token,
+ * see the [Stellate docs](https://docs.stellate.co/docs/purging-api#authentication)
+ */
+ apiToken: string;
+ /**
+ * @description
+ * An array of {@link PurgeRule} instances which are used to define how the plugin will
+ * respond to Vendure events in order to trigger calls to the Stellate Purging API.
+ */
+ purgeRules: PurgeRule[];
+ /**
+ * @description
+ * When events are published, the PurgeRules will buffer those events in order to efficiently
+ * batch requests to the Stellate Purging API. You may wish to change the default, e.g. if you are
+ * running in a serverless environment and cannot introduce pauses after the main request has completed.
+ *
+ * @default 2000
+ */
+ defaultBufferTimeMs?: number;
+ /**
+ * @description
+ * When set to `true`, calls will not be made to the Stellate Purge API.
+ *
+ * @default false
+ */
+ devMode?: boolean;
+ /**
+ * @description
+ * If set to true, the plugin will log the calls that would be made
+ * to the Stellate Purge API. Note, this generates a
+ * lot of debug-level logging.
+ *
+ * @default false
+ */
+ debugLogging?: boolean;
+}
diff --git a/packages/stellate-plugin/src/write.mjs b/packages/stellate-plugin/src/write.mjs
new file mode 100644
index 0000000000..944ff0f69b
--- /dev/null
+++ b/packages/stellate-plugin/src/write.mjs
@@ -0,0 +1,210 @@
+import fetch from 'node-fetch'
+import { getIntrospectionQuery } from 'graphql'
+
+// TODO: you can get a token by means of using settings --> api-tokens
+const token = '';
+const apiUrl = 'https://api.graphcdn.io/api'
+const originUrl = 'https://trygql.formidable.dev/graphql/basic-pokedex'
+
+// The app { config { input } } can be used to write the graphcdn.YAML file with help of libs like "@atomist/yaml-updater"
+async function listOrganizations() {
+ const response = await fetch(apiUrl, {
+ method: 'POST',
+ headers: {
+ 'Content-Type': 'application/json',
+ 'graphcdn-token': token,
+ },
+ body: JSON.stringify({
+ query: /* GraphQL */ `
+ query {
+ user {
+ organizations {
+ id
+ name
+ slug
+ }
+ }
+ }
+ `,
+ })
+ })
+
+ const result = await response.json()
+
+ return result.data.user.organizations
+}
+
+async function pushAppConfig(orgId, schema) {
+ const config = {
+ name: 'node-write-test',
+ originUrl,
+ schema: originUrl,
+ queryDepthLimit: 20,
+ ignoreOriginCacheControl: true,
+ enablePlayground: true,
+ injectHeaders: true,
+ headers: {
+ 'something-to-inject': '1',
+ },
+ keyFields: {
+ types: {
+ Pokemon: ['id', 'name']
+ }
+ },
+ scopes: {
+ AUTHENTICATED: 'header:Authorization',
+ },
+ rootTypeNames: { query: 'Query' },
+ rules: [
+ { description: 'Cache all queries', maxAge: 600, swr: 900, scope: 'AUTHENTICATED', types: ['Query'] },
+ ],
+ bypassCacheHeaders: [{ name: 'x-preview-token' }],
+ }
+
+ const result = await fetch(apiUrl, {
+ method: 'POST',
+ headers: {
+ 'Content-Type': 'application/json',
+ 'graphcdn-token': token,
+ },
+ body: JSON.stringify({
+ query: /* GraphQL */ `
+ mutation (
+ $input: Input!
+ $appName: String!
+ $schema: IntrospectionQuery
+ ) {
+ pushAppConfig(
+ input: $input
+ appName: $appName
+ schema: $schema
+ allowDeletion: true
+ )
+ }
+ `,
+ variables: {
+ input: config,
+ schema: schema,
+ appName: config.name,
+ }
+ })
+ })
+}
+
+async function createApp(orgId, schema) {
+ const config = {
+ name: 'node-write-test',
+ originUrl,
+ schema: originUrl,
+ queryDepthLimit: 20,
+ ignoreOriginCacheControl: true,
+ enablePlayground: true,
+ injectHeaders: true,
+ headers: {
+ 'something-to-inject': '1',
+ },
+ keyFields: {
+ types: {
+ Pokemon: ['id', 'name']
+ }
+ },
+ scopes: {
+ AUTHENTICATED: 'header:Authorization',
+ },
+ rootTypeNames: { query: 'Query' },
+ rules: [
+ { description: 'Cache all queries', maxAge: 600, swr: 900, scope: 'AUTHENTICATED', types: ['Query'] },
+ ],
+ bypassCacheHeaders: [{ name: 'x-preview-token' }],
+ }
+
+ const result = await fetch(apiUrl, {
+ method: 'POST',
+ headers: {
+ 'Content-Type': 'application/json',
+ 'graphcdn-token': token,
+ },
+ body: JSON.stringify({
+ query: /* GraphQL */ `
+ mutation (
+ $input: Input!
+ $schema: IntrospectionQuery
+ $organizationId: String!
+ ) {
+ createAppCli(
+ input: $input
+ schema: $schema
+ organizationId: $organizationId
+ ) {
+ id
+ config {
+ input
+ }
+ }
+ }
+ `,
+ variables: {
+ input: config,
+ schema: schema,
+ organizationId: orgId
+ }
+ })
+ })
+
+ return await result.json()
+}
+
+async function getServices(slug) {
+ const response = await fetch(apiUrl, {
+ method: 'POST',
+ headers: {
+ 'Content-Type': 'application/json',
+ 'graphcdn-token': token,
+ },
+ body: JSON.stringify({
+ query: /* GraphQL */`
+ query ($slug: String!) {
+ organization(slug: $slug) {
+ name
+ apps {
+ name
+ updatedAt
+ config {
+ input
+ }
+ }
+ }
+ }
+ `,
+ variables: { slug }
+ })
+ })
+
+ const result = await response.json()
+
+ return result.data.organization.apps
+}
+
+async function main() {
+ const introspectionQuery = getIntrospectionQuery()
+
+ const introspectionResponse = await fetch(originUrl, {
+ method: 'POST',
+ headers: {
+ 'Content-Type': 'application/json',
+ },
+ body: JSON.stringify({
+ query: introspectionQuery,
+ })
+ })
+
+ const { data: schema } = await introspectionResponse.json()
+
+ const organizations = await listOrganizations();
+
+ console.log(organizations)
+ const result = await createApp(organizations[0].id, schema)
+ console.log(result)
+}
+
+main()
diff --git a/packages/stellate-plugin/tsconfig.build.json b/packages/stellate-plugin/tsconfig.build.json
new file mode 100644
index 0000000000..821b637ae7
--- /dev/null
+++ b/packages/stellate-plugin/tsconfig.build.json
@@ -0,0 +1,9 @@
+{
+ "extends": "./tsconfig.json",
+ "compilerOptions": {
+ "outDir": "./lib"
+ },
+ "files": [
+ "./index.ts"
+ ]
+}
diff --git a/packages/stellate-plugin/tsconfig.json b/packages/stellate-plugin/tsconfig.json
new file mode 100644
index 0000000000..f343c8c4b3
--- /dev/null
+++ b/packages/stellate-plugin/tsconfig.json
@@ -0,0 +1,10 @@
+{
+ "extends": "../../tsconfig.json",
+ "compilerOptions": {
+ "declaration": true,
+ "removeComments": false,
+ "noLib": false,
+ "skipLibCheck": true,
+ "sourceMap": true
+ }
+}
diff --git a/packages/testing/package.json b/packages/testing/package.json
index 97b82aa9ef..e6b80f255e 100644
--- a/packages/testing/package.json
+++ b/packages/testing/package.json
@@ -1,6 +1,6 @@
{
"name": "@vendure/testing",
- "version": "2.1.4",
+ "version": "2.1.5",
"description": "End-to-end testing tools for Vendure projects",
"keywords": [
"vendure",
@@ -38,7 +38,7 @@
"dependencies": {
"@graphql-typed-document-node/core": "^3.2.0",
"@types/node-fetch": "^2.6.4",
- "@vendure/common": "^2.1.4",
+ "@vendure/common": "^2.1.5",
"faker": "^4.1.0",
"form-data": "^4.0.0",
"graphql": "16.8.0",
@@ -49,7 +49,7 @@
"devDependencies": {
"@types/mysql": "^2.15.15",
"@types/pg": "^7.14.5",
- "@vendure/core": "^2.1.4",
+ "@vendure/core": "^2.1.5",
"mysql": "^2.18.1",
"pg": "^8.4.0",
"rimraf": "^3.0.0",
diff --git a/packages/ui-devkit/package.json b/packages/ui-devkit/package.json
index 013cad6fd7..dddf975d85 100644
--- a/packages/ui-devkit/package.json
+++ b/packages/ui-devkit/package.json
@@ -1,6 +1,6 @@
{
"name": "@vendure/ui-devkit",
- "version": "2.1.4",
+ "version": "2.1.5",
"description": "A library for authoring Vendure Admin UI extensions",
"keywords": [
"vendure",
@@ -40,8 +40,8 @@
"@angular/cli": "^16.2.0",
"@angular/compiler": "^16.2.2",
"@angular/compiler-cli": "^16.2.2",
- "@vendure/admin-ui": "^2.1.4",
- "@vendure/common": "^2.1.4",
+ "@vendure/admin-ui": "^2.1.5",
+ "@vendure/common": "^2.1.5",
"chalk": "^4.1.0",
"chokidar": "^3.5.3",
"fs-extra": "^11.1.1",
@@ -51,7 +51,7 @@
"devDependencies": {
"@rollup/plugin-node-resolve": "^15.2.1",
"@types/fs-extra": "^11.0.1",
- "@vendure/core": "^2.1.4",
+ "@vendure/core": "^2.1.5",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"rimraf": "^3.0.2",
diff --git a/scripts/changelogs/generate-changelog.ts b/scripts/changelogs/generate-changelog.ts
index 5c5e0b901d..b9dbbea933 100644
--- a/scripts/changelogs/generate-changelog.ts
+++ b/scripts/changelogs/generate-changelog.ts
@@ -35,6 +35,8 @@ const VALID_SCOPES: string[] = [
'testing',
'ui-devkit',
'harden-plugin',
+ 'stellate-plugin',
+ 'sentry-plugin',
];
const mainTemplate = fs.readFileSync(path.join(__dirname, 'template.hbs'), 'utf-8');
diff --git a/scripts/docs/generate-typescript-docs.ts b/scripts/docs/generate-typescript-docs.ts
index 071fb04313..5e3728522f 100644
--- a/scripts/docs/generate-typescript-docs.ts
+++ b/scripts/docs/generate-typescript-docs.ts
@@ -49,6 +49,14 @@ const sections: DocsSectionConfig[] = [
sourceDirs: ['packages/harden-plugin/src/'],
outputPath: '',
},
+ {
+ sourceDirs: ['packages/stellate-plugin/src/'],
+ outputPath: '',
+ },
+ {
+ sourceDirs: ['packages/sentry-plugin/src/'],
+ outputPath: '',
+ },
{
sourceDirs: ['packages/admin-ui/src/lib/', 'packages/ui-devkit/src/'],
exclude: [/generated-types/],
diff --git a/yarn.lock b/yarn.lock
index 9e117b0907..2d285a9514 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -4335,6 +4335,46 @@
"@angular-devkit/schematics" "16.2.0"
jsonc-parser "3.2.0"
+"@sentry-internal/tracing@7.85.0":
+ version "7.85.0"
+ resolved "https://registry.yarnpkg.com/@sentry-internal/tracing/-/tracing-7.85.0.tgz#1b4781a61e1e43badeff826cf40abe33dd760f1d"
+ integrity sha512-p3YMUwkPCy2su9cm/3+7QYR4RiMI0+07DU1BZtht9NLTzY2O87/yvUbn1v2yHR3vJQTy/+7N0ud9/mPBFznRQQ==
+ dependencies:
+ "@sentry/core" "7.85.0"
+ "@sentry/types" "7.85.0"
+ "@sentry/utils" "7.85.0"
+
+"@sentry/core@7.85.0":
+ version "7.85.0"
+ resolved "https://registry.yarnpkg.com/@sentry/core/-/core-7.85.0.tgz#dd90d772a5f75ff674f931f59b22a3fc286d0983"
+ integrity sha512-DFDAc4tWmHN5IWhr7XbHCiyF1Xgb95jz8Uj/JTX9atlgodId1UIbER77qpEmH3eQGid/QBdqrlR98zCixgSbwg==
+ dependencies:
+ "@sentry/types" "7.85.0"
+ "@sentry/utils" "7.85.0"
+
+"@sentry/node@^7.85.0":
+ version "7.85.0"
+ resolved "https://registry.yarnpkg.com/@sentry/node/-/node-7.85.0.tgz#cf4e6022b5cd1f3fb007186c5e04427b108ebe1d"
+ integrity sha512-uiBtRW9G017NHoCXBlK3ttkTwHXLFyI8ndHpaObtyajKTv3ptGIThVEn7DuK7Pwor//RjwjSEEOa7WDK+FdMVQ==
+ dependencies:
+ "@sentry-internal/tracing" "7.85.0"
+ "@sentry/core" "7.85.0"
+ "@sentry/types" "7.85.0"
+ "@sentry/utils" "7.85.0"
+ https-proxy-agent "^5.0.0"
+
+"@sentry/types@7.85.0":
+ version "7.85.0"
+ resolved "https://registry.yarnpkg.com/@sentry/types/-/types-7.85.0.tgz#648488b90f958ca6a86922cc5d26004853410ba6"
+ integrity sha512-R5jR4XkK5tBU2jDiPdSVqzkmjYRr666bcGaFGUHB/xDQCjPsjk+pEmCCL+vpuWoaZmQJUE1hVU7rgnVX81w8zg==
+
+"@sentry/utils@7.85.0":
+ version "7.85.0"
+ resolved "https://registry.yarnpkg.com/@sentry/utils/-/utils-7.85.0.tgz#b84467fd07bc2ef09fdf382ddcdcdc3f5b0d78b0"
+ integrity sha512-JZ7seNOLvhjAQ8GeB3GYknPQJkuhF88xAYOaESZP3xPOWBMFUN+IO4RqjMqMLFDniOwsVQS7GB/MfP+hxufieg==
+ dependencies:
+ "@sentry/types" "7.85.0"
+
"@sigstore/bundle@^1.1.0":
version "1.1.0"
resolved "https://registry.yarnpkg.com/@sigstore/bundle/-/bundle-1.1.0.tgz#17f8d813b09348b16eeed66a8cf1c3d6bd3d04f1"
-
- ![]()
-
-
diff --git a/packages/admin-ui/src/lib/core/src/shared/components/asset-preview/asset-preview.component.scss b/packages/admin-ui/src/lib/core/src/shared/components/asset-preview/asset-preview.component.scss
index 434a533d92..80c88b8d04 100644
--- a/packages/admin-ui/src/lib/core/src/shared/components/asset-preview/asset-preview.component.scss
+++ b/packages/admin-ui/src/lib/core/src/shared/components/asset-preview/asset-preview.component.scss
@@ -96,7 +96,7 @@
justify-content: space-between;
align-items: center;
- button{
+ button.carousel-button {
cursor: pointer;
width: 30px;
height: 30px;
diff --git a/packages/asset-server-plugin/package.json b/packages/asset-server-plugin/package.json
index 8289a15bcc..b83dc06f60 100644
--- a/packages/asset-server-plugin/package.json
+++ b/packages/asset-server-plugin/package.json
@@ -1,6 +1,6 @@
{
"name": "@vendure/asset-server-plugin",
- "version": "2.1.4",
+ "version": "2.1.5",
"main": "lib/index.js",
"types": "lib/index.d.ts",
"files": [
@@ -27,8 +27,8 @@
"@types/fs-extra": "^11.0.1",
"@types/node-fetch": "^2.5.8",
"@types/sharp": "^0.30.4",
- "@vendure/common": "^2.1.4",
- "@vendure/core": "^2.1.4",
+ "@vendure/common": "^2.1.5",
+ "@vendure/core": "^2.1.5",
"express": "^4.17.1",
"node-fetch": "^2.6.7",
"rimraf": "^3.0.2",
diff --git a/packages/cli/package.json b/packages/cli/package.json
index f69dcc0311..9b629824bb 100644
--- a/packages/cli/package.json
+++ b/packages/cli/package.json
@@ -1,6 +1,6 @@
{
"name": "@vendure/cli",
- "version": "2.1.4",
+ "version": "2.1.5",
"description": "A modern, headless ecommerce framework",
"repository": {
"type": "git",
@@ -34,7 +34,7 @@
],
"dependencies": {
"@clack/prompts": "^0.7.0",
- "@vendure/common": "^2.1.4",
+ "@vendure/common": "^2.1.5",
"change-case": "^4.1.2",
"commander": "^11.0.0",
"fs-extra": "^11.1.1",
diff --git a/packages/common/package.json b/packages/common/package.json
index d3c0115e97..f1aa9c1b63 100644
--- a/packages/common/package.json
+++ b/packages/common/package.json
@@ -1,6 +1,6 @@
{
"name": "@vendure/common",
- "version": "2.1.4",
+ "version": "2.1.5",
"main": "index.js",
"license": "MIT",
"scripts": {
diff --git a/packages/common/src/shared-types.ts b/packages/common/src/shared-types.ts
index 9997be7934..a67bc17e0b 100644
--- a/packages/common/src/shared-types.ts
+++ b/packages/common/src/shared-types.ts
@@ -88,7 +88,7 @@ export type ID = string | number;
* string | varchar | String
* localeString | varchar | String
* text | longtext(m), text(p,s) | String
- * localText | longtext(m), text(p,s) | String
+ * localeText | longtext(m), text(p,s) | String
* int | int | Int
* float | double precision | Float
* boolean | tinyint (m), bool (p), boolean (s) | Boolean
diff --git a/packages/core/e2e/fixtures/test-plugins/list-query-plugin.ts b/packages/core/e2e/fixtures/test-plugins/list-query-plugin.ts
index 36d4d29d93..b780f3dea6 100644
--- a/packages/core/e2e/fixtures/test-plugins/list-query-plugin.ts
+++ b/packages/core/e2e/fixtures/test-plugins/list-query-plugin.ts
@@ -39,9 +39,25 @@ export class CustomFieldRelationTestEntity extends VendureEntity {
parent: Relation
-
-
+
-
+
+
-
+
- ![]()
+
+
+
+
+