@vendure/stellate-plugin 2.1.4

package/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/typescript-api/core-plugins/stellate-plugin/](https://docs.vendure.io/typescript-api/core-plugins/stellate-plugin/)

package/lib/index.d.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';

package/lib/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/stellate-plugin"), exports);
+__exportStar(require("./src/service/stellate.service"), exports);
+__exportStar(require("./src/default-purge-rules"), exports);
+__exportStar(require("./src/purge-rule"), exports);
+__exportStar(require("./src/types"), exports);
+__exportStar(require("./src/constants"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,iEAA+C;AAC/C,4DAA0C;AAC1C,mDAAiC;AACjC,8CAA4B;AAC5B,kDAAgC"}

package/lib/src/api/api-extensions.d.ts

@@ -0,0 +1 @@
+export declare const shopApiExtensions: import("graphql").DocumentNode;

package/lib/src/api/api-extensions.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shopApiExtensions = void 0;
+const graphql_tag_1 = __importDefault(require("graphql-tag"));
+exports.shopApiExtensions = (0, graphql_tag_1.default) `
+    """
+    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
+    }
+`;
+//# sourceMappingURL=api-extensions.js.map

package/lib/src/api/api-extensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-extensions.js","sourceRoot":"","sources":["../../../src/api/api-extensions.ts"],"names":[],"mappings":";;;;;;AAAA,8DAA8B;AAEjB,QAAA,iBAAiB,GAAG,IAAA,qBAAG,EAAA;;;;;;;;;;;;;;CAcnC,CAAC"}

package/lib/src/api/search-response.resolver.d.ts

@@ -0,0 +1,6 @@
+import { GraphQLResolveInfo } from 'graphql/type';
+export declare class SearchResponseFieldResolver {
+    cacheIdentifier(info: GraphQLResolveInfo): {
+        collectionSlug: any;
+    };
+}

package/lib/src/api/search-response.resolver.js

@@ -0,0 +1,35 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchResponseFieldResolver = void 0;
+const graphql_1 = require("@nestjs/graphql");
+let SearchResponseFieldResolver = class SearchResponseFieldResolver {
+    cacheIdentifier(info) {
+        var _a;
+        const collectionSlug = (_a = info.variableValues.input) === null || _a === void 0 ? void 0 : _a.collectionSlug;
+        return { collectionSlug };
+    }
+};
+__decorate([
+    (0, graphql_1.ResolveField)(),
+    __param(0, (0, graphql_1.Info)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", void 0)
+], SearchResponseFieldResolver.prototype, "cacheIdentifier", null);
+SearchResponseFieldResolver = __decorate([
+    (0, graphql_1.Resolver)('SearchResponse')
+], SearchResponseFieldResolver);
+exports.SearchResponseFieldResolver = SearchResponseFieldResolver;
+//# sourceMappingURL=search-response.resolver.js.map

package/lib/src/api/search-response.resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-response.resolver.js","sourceRoot":"","sources":["../../../src/api/search-response.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,6CAA+D;AAIxD,IAAM,2BAA2B,GAAjC,MAAM,2BAA2B;IAEpC,eAAe,CAAS,IAAwB;;QAC5C,MAAM,cAAc,GAAG,MAAC,IAAI,CAAC,cAAc,CAAC,KAAa,0CAAE,cAAc,CAAC;QAC1E,OAAO,EAAE,cAAc,EAAE,CAAC;IAC9B,CAAC;CACJ,CAAA;AALG;IAAC,IAAA,sBAAY,GAAE;IACE,WAAA,IAAA,cAAI,GAAE,CAAA;;;;kEAGtB;AALQ,2BAA2B;IADvC,IAAA,kBAAQ,EAAC,gBAAgB,CAAC;GACd,2BAA2B,CAMvC;AANY,kEAA2B"}

package/lib/src/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const STELLATE_PLUGIN_OPTIONS = "STELLATE_PLUGIN_OPTIONS";
+export declare const loggerCtx = "StellatePlugin";

package/lib/src/constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loggerCtx = exports.STELLATE_PLUGIN_OPTIONS = void 0;
+exports.STELLATE_PLUGIN_OPTIONS = 'STELLATE_PLUGIN_OPTIONS';
+exports.loggerCtx = 'StellatePlugin';
+//# sourceMappingURL=constants.js.map

package/lib/src/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,uBAAuB,GAAG,yBAAyB,CAAC;AACpD,QAAA,SAAS,GAAG,gBAAgB,CAAC"}

package/lib/src/default-purge-rules.d.ts

@@ -0,0 +1,11 @@
+import { CollectionEvent, CollectionModificationEvent, ProductChannelEvent, ProductEvent, ProductVariantChannelEvent, ProductVariantEvent, StockMovementEvent, TaxRateEvent } from '@vendure/core';
+import { PurgeRule } from './purge-rule';
+export declare const purgeProductsOnProductEvent: PurgeRule<ProductEvent>;
+export declare const purgeProductVariantsOnProductVariantEvent: PurgeRule<ProductVariantEvent>;
+export declare const purgeProductsOnChannelEvent: PurgeRule<ProductChannelEvent>;
+export declare const purgeProductVariantsOnChannelEvent: PurgeRule<ProductVariantChannelEvent>;
+export declare const purgeProductVariantsOnStockMovementEvent: PurgeRule<StockMovementEvent>;
+export declare const purgeCollectionsOnCollectionModificationEvent: PurgeRule<CollectionModificationEvent>;
+export declare const purgeCollectionsOnCollectionEvent: PurgeRule<CollectionEvent>;
+export declare const purgeAllOnTaxRateEvent: PurgeRule<TaxRateEvent>;
+export declare const defaultPurgeRules: (PurgeRule<ProductEvent> | PurgeRule<ProductVariantEvent> | PurgeRule<ProductChannelEvent> | PurgeRule<ProductVariantChannelEvent> | PurgeRule<StockMovementEvent> | PurgeRule<CollectionModificationEvent> | PurgeRule<CollectionEvent> | PurgeRule<TaxRateEvent>)[];

package/lib/src/default-purge-rules.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultPurgeRules = exports.purgeAllOnTaxRateEvent = exports.purgeCollectionsOnCollectionEvent = exports.purgeCollectionsOnCollectionModificationEvent = exports.purgeProductVariantsOnStockMovementEvent = exports.purgeProductVariantsOnChannelEvent = exports.purgeProductsOnChannelEvent = exports.purgeProductVariantsOnProductVariantEvent = exports.purgeProductsOnProductEvent = void 0;
+/* eslint-disable @typescript-eslint/no-floating-promises */
+const core_1 = require("@vendure/core");
+const constants_1 = require("./constants");
+const purge_rule_1 = require("./purge-rule");
+exports.purgeProductsOnProductEvent = new purge_rule_1.PurgeRule({
+    eventType: core_1.ProductEvent,
+    handler: ({ events, stellateService }) => {
+        const products = events.map(e => e.product);
+        stellateService.purgeProducts(products);
+        stellateService.purgeSearchResults(products);
+    },
+});
+exports.purgeProductVariantsOnProductVariantEvent = new purge_rule_1.PurgeRule({
+    eventType: core_1.ProductVariantEvent,
+    handler: ({ events, stellateService }) => {
+        const variants = events.map(e => e.variants).flat();
+        stellateService.purgeProductVariants(variants);
+        stellateService.purgeSearchResults(variants);
+    },
+});
+exports.purgeProductsOnChannelEvent = new purge_rule_1.PurgeRule({
+    eventType: core_1.ProductChannelEvent,
+    handler: ({ events, stellateService }) => {
+        const products = events.map(e => e.product);
+        stellateService.purgeProducts(products);
+        stellateService.purgeSearchResults(products);
+    },
+});
+exports.purgeProductVariantsOnChannelEvent = new purge_rule_1.PurgeRule({
+    eventType: core_1.ProductVariantChannelEvent,
+    handler: ({ events, stellateService }) => {
+        const variants = events.map(e => e.productVariant);
+        stellateService.purgeProductVariants(variants);
+        stellateService.purgeSearchResults(variants);
+    },
+});
+exports.purgeProductVariantsOnStockMovementEvent = new purge_rule_1.PurgeRule({
+    eventType: core_1.StockMovementEvent,
+    handler: ({ events, stellateService }) => {
+        const variants = events.map(e => e.stockMovements.map(m => m.productVariant)).flat();
+        stellateService.purgeProductVariants(variants);
+        stellateService.purgeSearchResults(variants);
+    },
+});
+exports.purgeCollectionsOnCollectionModificationEvent = new purge_rule_1.PurgeRule({
+    eventType: core_1.CollectionModificationEvent,
+    handler: ({ events, stellateService }) => {
+        const collectionsToPurge = events.filter(e => e.productVariantIds.length).map(e => e.collection);
+        core_1.Logger.debug(`purgeCollectionsOnCollectionModificationEvent, collectionsToPurge: ${collectionsToPurge
+            .map(c => c.id)
+            .join(', ')}`, constants_1.loggerCtx);
+        if (collectionsToPurge.length) {
+            stellateService.purgeCollections(collectionsToPurge);
+            stellateService.purgeSearchResponseCacheIdentifiers(collectionsToPurge);
+        }
+    },
+});
+exports.purgeCollectionsOnCollectionEvent = new purge_rule_1.PurgeRule({
+    eventType: core_1.CollectionEvent,
+    handler: ({ events, stellateService }) => {
+        const collections = events.map(e => e.entity);
+        stellateService.purgeCollections(collections);
+    },
+});
+exports.purgeAllOnTaxRateEvent = new purge_rule_1.PurgeRule({
+    eventType: core_1.TaxRateEvent,
+    handler: ({ stellateService }) => {
+        stellateService.purgeAllOfType('ProductVariant');
+        stellateService.purgeAllOfType('Product');
+        stellateService.purgeAllOfType('SearchResponse');
+    },
+});
+exports.defaultPurgeRules = [
+    exports.purgeAllOnTaxRateEvent,
+    exports.purgeCollectionsOnCollectionEvent,
+    exports.purgeCollectionsOnCollectionModificationEvent,
+    exports.purgeProductsOnChannelEvent,
+    exports.purgeProductsOnProductEvent,
+    exports.purgeProductVariantsOnChannelEvent,
+    exports.purgeProductVariantsOnProductVariantEvent,
+    exports.purgeProductVariantsOnStockMovementEvent,
+];
+//# sourceMappingURL=default-purge-rules.js.map

package/lib/src/default-purge-rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-purge-rules.js","sourceRoot":"","sources":["../../src/default-purge-rules.ts"],"names":[],"mappings":";;;AAAA,4DAA4D;AAC5D,wCAUuB;AAEvB,2CAAwC;AACxC,6CAAyC;AAE5B,QAAA,2BAA2B,GAAG,IAAI,sBAAS,CAAC;IACrD,SAAS,EAAE,mBAAY;IACvB,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,EAAE;QACrC,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAC5C,eAAe,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxC,eAAe,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;CACJ,CAAC,CAAC;AAEU,QAAA,yCAAyC,GAAG,IAAI,sBAAS,CAAC;IACnE,SAAS,EAAE,0BAAmB;IAC9B,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,EAAE;QACrC,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC;QACpD,eAAe,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAC/C,eAAe,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;CACJ,CAAC,CAAC;AAEU,QAAA,2BAA2B,GAAG,IAAI,sBAAS,CAAC;IACrD,SAAS,EAAE,0BAAmB;IAC9B,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,EAAE;QACrC,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QAC5C,eAAe,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxC,eAAe,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;CACJ,CAAC,CAAC;AAEU,QAAA,kCAAkC,GAAG,IAAI,sBAAS,CAAC;IAC5D,SAAS,EAAE,iCAA0B;IACrC,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,EAAE;QACrC,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;QACnD,eAAe,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAC/C,eAAe,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;CACJ,CAAC,CAAC;AAEU,QAAA,wCAAwC,GAAG,IAAI,sBAAS,CAAC;IAClE,SAAS,EAAE,yBAAkB;IAC7B,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,EAAE;QACrC,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACrF,eAAe,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAC/C,eAAe,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;CACJ,CAAC,CAAC;AAEU,QAAA,6CAA6C,GAAG,IAAI,sBAAS,CAAC;IACvE,SAAS,EAAE,kCAA2B;IACtC,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,EAAE;QACrC,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;QACjG,aAAM,CAAC,KAAK,CACR,sEAAsE,kBAAkB;aACnF,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACd,IAAI,CAAC,IAAI,CAAC,EAAE,EACjB,qBAAS,CACZ,CAAC;QACF,IAAI,kBAAkB,CAAC,MAAM,EAAE;YAC3B,eAAe,CAAC,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;YACrD,eAAe,CAAC,mCAAmC,CAAC,kBAAkB,CAAC,CAAC;SAC3E;IACL,CAAC;CACJ,CAAC,CAAC;AAEU,QAAA,iCAAiC,GAAG,IAAI,sBAAS,CAAC;IAC3D,SAAS,EAAE,sBAAe;IAC1B,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,EAAE,EAAE;QACrC,MAAM,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QAC9C,eAAe,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;CACJ,CAAC,CAAC;AAEU,QAAA,sBAAsB,GAAG,IAAI,sBAAS,CAAC;IAChD,SAAS,EAAE,mBAAY;IACvB,OAAO,EAAE,CAAC,EAAE,eAAe,EAAE,EAAE,EAAE;QAC7B,eAAe,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;QACjD,eAAe,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QAC1C,eAAe,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IACrD,CAAC;CACJ,CAAC,CAAC;AAEU,QAAA,iBAAiB,GAAG;IAC7B,8BAAsB;IACtB,yCAAiC;IACjC,qDAA6C;IAC7C,mCAA2B;IAC3B,mCAA2B;IAC3B,0CAAkC;IAClC,iDAAyC;IACzC,gDAAwC;CAC3C,CAAC"}

package/lib/src/purge-rule.d.ts

@@ -0,0 +1,56 @@
+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<Event extends VendureEvent> {
+    /**
+     * @description
+     * Specifies which VendureEvent will trigger this purge rule.
+     */
+    eventType: Type<Event>;
+    /**
+     * @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<void>;
+}
+/**
+ * @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 declare class PurgeRule<Event extends VendureEvent = VendureEvent> {
+    private config;
+    get eventType(): Type<Event>;
+    get bufferTimeMs(): number | undefined;
+    handle(handlerArgs: {
+        events: Event[];
+        stellateService: StellateService;
+        injector: Injector;
+    }): void | Promise<void>;
+    constructor(config: PurgeRuleConfig<Event>);
+}

package/lib/src/purge-rule.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PurgeRule = void 0;
+/**
+ * @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
+ */
+class PurgeRule {
+    get eventType() {
+        return this.config.eventType;
+    }
+    get bufferTimeMs() {
+        return this.config.bufferTime;
+    }
+    handle(handlerArgs) {
+        return this.config.handler(handlerArgs);
+    }
+    constructor(config) {
+        this.config = config;
+    }
+}
+exports.PurgeRule = PurgeRule;
+//# sourceMappingURL=purge-rule.js.map

package/lib/src/purge-rule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"purge-rule.js","sourceRoot":"","sources":["../../src/purge-rule.ts"],"names":[],"mappings":";;;AAsCA;;;;;;;;;GASG;AACH,MAAa,SAAS;IAClB,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;IACjC,CAAC;IACD,IAAI,YAAY;QACZ,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAClC,CAAC;IACD,MAAM,CAAC,WAAsF;QACzF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC5C,CAAC;IACD,YAAoB,MAA8B;QAA9B,WAAM,GAAN,MAAM,CAAwB;IAAG,CAAC;CACzD;AAXD,8BAWC"}

package/lib/src/service/stellate.service.d.ts

@@ -0,0 +1,50 @@
+import { Collection, ID, Product, ProductVariant } from '@vendure/core';
+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 declare class StellateService {
+    private options;
+    private readonly purgeApiUrl;
+    constructor(options: StellatePluginOptions);
+    /**
+     * @description
+     * Purges the cache for the given Products.
+     */
+    purgeProducts(products: Product[]): Promise<void>;
+    /**
+     * @description
+     * Purges the cache for the given ProductVariants.
+     */
+    purgeProductVariants(productVariants: ProductVariant[]): Promise<void>;
+    /**
+     * @description
+     * Purges the cache for SearchResults which contain the given Products or ProductVariants.
+     */
+    purgeSearchResults(items: Array<ProductVariant | Product>): Promise<void>;
+    /**
+     * @description
+     * Purges the entire cache for the given type.
+     */
+    purgeAllOfType(type: CachedType): Promise<void>;
+    /**
+     * @description
+     * Purges the cache for the given Collections.
+     */
+    purgeCollections(collections: Collection[]): Promise<void>;
+    /**
+     * @description
+     * Purges the cache of SearchResults for the given Collections based on slug.
+     */
+    purgeSearchResponseCacheIdentifiers(collections: Collection[]): Promise<void>;
+    /**
+     * @description
+     * Purges the cache for the given type and keys.
+     */
+    purge(type: CachedType, keys?: ID[], keyName?: string): Promise<void> | undefined;
+}
+export {};

package/lib/src/service/stellate.service.js

@@ -0,0 +1,145 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StellateService = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@vendure/core");
+const node_fetch_1 = __importDefault(require("node-fetch"));
+const constants_1 = require("../constants");
+/**
+ * @description
+ * The StellateService is used to purge the Stellate cache when certain events occur.
+ *
+ * @docsCategory core plugins/StellatePlugin
+ */
+let StellateService = class StellateService {
+    constructor(options) {
+        this.options = options;
+        this.purgeApiUrl = `https://admin.stellate.co/${options.serviceName}`;
+    }
+    /**
+     * @description
+     * Purges the cache for the given Products.
+     */
+    async purgeProducts(products) {
+        core_1.Logger.verbose(`Purging cache: Product(${products.map(p => p.id).join(', ')})`, constants_1.loggerCtx);
+        await this.purge('Product', products.map(p => p.id));
+    }
+    /**
+     * @description
+     * Purges the cache for the given ProductVariants.
+     */
+    async purgeProductVariants(productVariants) {
+        core_1.Logger.verbose(`Purging cache: ProductVariant(${productVariants.map(p => p.id).join(', ')})`, constants_1.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) {
+        const productIds = items.map(item => (item instanceof core_1.Product ? item.id : item.productId));
+        core_1.Logger.verbose(`Purging cache: SearchResult(${productIds.join(', ')})`, constants_1.loggerCtx);
+        await this.purge('SearchResult', productIds, 'productId');
+    }
+    /**
+     * @description
+     * Purges the entire cache for the given type.
+     */
+    async purgeAllOfType(type) {
+        core_1.Logger.verbose(`Purging cache: All ${type}s`, constants_1.loggerCtx);
+        await this.purge(type);
+    }
+    /**
+     * @description
+     * Purges the cache for the given Collections.
+     */
+    async purgeCollections(collections) {
+        core_1.Logger.verbose(`Purging cache: Collection(${collections.map(c => c.id).join(', ')})`, constants_1.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) {
+        const slugs = collections.map(c => { var _a, _b, _c; return (_a = c.slug) !== null && _a !== void 0 ? _a : (_c = (_b = c.translations) === null || _b === void 0 ? void 0 : _b[0]) === null || _c === void 0 ? void 0 : _c.slug; });
+        if (slugs.length) {
+            core_1.Logger.verbose(`Purging cache: SearchResponseCacheIdentifier(${slugs.join(', ')})`, constants_1.loggerCtx);
+            await this.purge('SearchResponseCacheIdentifier', slugs);
+        }
+    }
+    /**
+     * @description
+     * Purges the cache for the given type and keys.
+     */
+    purge(type, keys, keyName = 'id') {
+        var _a, _b, _c;
+        const payload = {
+            query: `
+                mutation PurgeType($type: String!, $keyFields: [KeyFieldInput!]) {
+                    _purgeType(type: $type, keyFields: $keyFields)
+                }
+            `,
+            variables: {
+                type,
+                keyFields: keys === null || keys === void 0 ? void 0 : keys.filter(id => !!id).map(id => ({ name: keyName, value: id.toString() })),
+            },
+        };
+        if (this.options.debugLogging === true) {
+            const keyFieldsLength = (_b = (_a = payload.variables.keyFields) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0;
+            if (5 < keyFieldsLength) {
+                payload.variables.keyFields = (_c = payload.variables.keyFields) === null || _c === void 0 ? void 0 : _c.slice(0, 5);
+            }
+            core_1.Logger.debug('Purge arguments:\n' + JSON.stringify(payload.variables, null, 2), constants_1.loggerCtx);
+            if (5 < keyFieldsLength) {
+                core_1.Logger.debug(`(A further ${keyFieldsLength - 5} keyFields truncated)`, constants_1.loggerCtx);
+            }
+        }
+        if (this.options.devMode === true) {
+            // no-op
+        }
+        else {
+            return (0, node_fetch_1.default)(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 => {
+                var _a, _b, _c;
+                if (((_a = json.data) === null || _a === void 0 ? void 0 : _a._purgeType) !== true) {
+                    const errors = (_b = json.errors) === null || _b === void 0 ? void 0 : _b.map((e) => e.message);
+                    core_1.Logger.error(`Purge failed: ${(_c = errors.join(', ')) !== null && _c !== void 0 ? _c : JSON.stringify(json)}`, constants_1.loggerCtx);
+                }
+            })
+                .catch((err) => {
+                core_1.Logger.error(`Purge error: ${err.message}`, constants_1.loggerCtx);
+            });
+        }
+    }
+};
+StellateService = __decorate([
+    __param(0, (0, common_1.Inject)(constants_1.STELLATE_PLUGIN_OPTIONS)),
+    __metadata("design:paramtypes", [Object])
+], StellateService);
+exports.StellateService = StellateService;
+//# sourceMappingURL=stellate.service.js.map

package/lib/src/service/stellate.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stellate.service.js","sourceRoot":"","sources":["../../../src/service/stellate.service.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,2CAAwC;AACxC,wCAAgF;AAChF,4DAA+B;AAE/B,4CAAkE;AAYlE;;;;;GAKG;AACI,IAAM,eAAe,GAArB,MAAM,eAAe;IAGxB,YAAqD,OAA8B;QAA9B,YAAO,GAAP,OAAO,CAAuB;QAC/E,IAAI,CAAC,WAAW,GAAG,6BAA6B,OAAO,CAAC,WAAW,EAAE,CAAC;IAC1E,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,QAAmB;QACnC,aAAM,CAAC,OAAO,CAAC,0BAA0B,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,qBAAS,CAAC,CAAC;QAC3F,MAAM,IAAI,CAAC,KAAK,CACZ,SAAS,EACT,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAC1B,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,oBAAoB,CAAC,eAAiC;QACxD,aAAM,CAAC,OAAO,CACV,iCAAiC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAC7E,qBAAS,CACZ,CAAC;QACF,MAAM,IAAI,CAAC,KAAK,CACZ,gBAAgB,EAChB,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CACjC,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,kBAAkB,CAAC,KAAsC;QAC3D,MAAM,UAAU,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,YAAY,cAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QAC3F,aAAM,CAAC,OAAO,CAAC,+BAA+B,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,qBAAS,CAAC,CAAC;QACnF,MAAM,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc,CAAC,IAAgB;QACjC,aAAM,CAAC,OAAO,CAAC,sBAAsB,IAAI,GAAG,EAAE,qBAAS,CAAC,CAAC;QACzD,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB,CAAC,WAAyB;QAC5C,aAAM,CAAC,OAAO,CAAC,6BAA6B,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,qBAAS,CAAC,CAAC;QACjG,MAAM,IAAI,CAAC,KAAK,CACZ,YAAY,EACZ,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAC7B,CAAC;IACN,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mCAAmC,CAAC,WAAyB;QAC/D,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,mBAAC,OAAA,MAAA,CAAC,CAAC,IAAI,mCAAI,MAAA,MAAA,CAAC,CAAC,YAAY,0CAAG,CAAC,CAAC,0CAAE,IAAI,CAAA,EAAA,CAAC,CAAC;QACxE,IAAI,KAAK,CAAC,MAAM,EAAE;YACd,aAAM,CAAC,OAAO,CAAC,gDAAgD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,qBAAS,CAAC,CAAC;YAC/F,MAAM,IAAI,CAAC,KAAK,CAAC,+BAA+B,EAAE,KAAK,CAAC,CAAC;SAC5D;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAgB,EAAE,IAAW,EAAE,OAAO,GAAG,IAAI;;QAC/C,MAAM,OAAO,GAAG;YACZ,KAAK,EAAE;;;;aAIN;YACD,SAAS,EAAE;gBACP,IAAI;gBACJ,SAAS,EAAE,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;aAC3F;SACJ,CAAC;QACF,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,KAAK,IAAI,EAAE;YACpC,MAAM,eAAe,GAAG,MAAA,MAAA,OAAO,CAAC,SAAS,CAAC,SAAS,0CAAE,MAAM,mCAAI,CAAC,CAAC;YACjE,IAAI,CAAC,GAAG,eAAe,EAAE;gBACrB,OAAO,CAAC,SAAS,CAAC,SAAS,GAAG,MAAA,OAAO,CAAC,SAAS,CAAC,SAAS,0CAAE,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aAC1E;YACD,aAAM,CAAC,KAAK,CAAC,oBAAoB,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,qBAAS,CAAC,CAAC;YAC3F,IAAI,CAAC,GAAG,eAAe,EAAE;gBACrB,aAAM,CAAC,KAAK,CAAC,cAAc,eAAe,GAAG,CAAC,uBAAuB,EAAE,qBAAS,CAAC,CAAC;aACrF;SACJ;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,KAAK,IAAI,EAAE;YAC/B,QAAQ;SACX;aAAM;YACH,OAAO,IAAA,oBAAK,EAAC,IAAI,CAAC,WAAW,EAAE;gBAC3B,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACL,cAAc,EAAE,kBAAkB;oBAClC,gBAAgB,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;iBAC1C;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;gBAC7B,OAAO,EAAE,IAAI;aAChB,CAAC;iBACG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;iBACvB,IAAI,CAAC,IAAI,CAAC,EAAE;;gBACT,IAAI,CAAA,MAAA,IAAI,CAAC,IAAI,0CAAE,UAAU,MAAK,IAAI,EAAE;oBAChC,MAAM,MAAM,GAAG,MAAA,IAAI,CAAC,MAAM,0CAAE,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAa,CAAC;oBACnE,aAAM,CAAC,KAAK,CAAC,iBAAiB,MAAA,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,mCAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,qBAAS,CAAC,CAAC;iBACzF;YACL,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,GAAQ,EAAE,EAAE;gBAChB,aAAM,CAAC,KAAK,CAAC,gBAAgB,GAAG,CAAC,OAAiB,EAAE,EAAE,qBAAS,CAAC,CAAC;YACrE,CAAC,CAAC,CAAC;SACV;IACL,CAAC;CACJ,CAAA;AA/HY,eAAe;IAGX,WAAA,IAAA,eAAM,EAAC,mCAAuB,CAAC,CAAA;;GAHnC,eAAe,CA+H3B;AA/HY,0CAAe"}

package/lib/src/stellate-plugin.d.ts

@@ -0,0 +1,244 @@
+import { OnApplicationBootstrap } from '@nestjs/common';
+import { ModuleRef } from '@nestjs/core';
+import { EventBus } from '@vendure/core';
+import { StellateService } from './service/stellate.service';
+import { StellatePluginOptions } from './types';
+/**
+ * @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. `<serviceName>.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://<service-name>.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
+ */
+export declare class StellatePlugin implements OnApplicationBootstrap {
+    private options;
+    private eventBus;
+    private stellateService;
+    private moduleRef;
+    static options: StellatePluginOptions;
+    static init(options: StellatePluginOptions): typeof StellatePlugin;
+    constructor(options: StellatePluginOptions, eventBus: EventBus, stellateService: StellateService, moduleRef: ModuleRef);
+    onApplicationBootstrap(): void;
+}

package/lib/src/stellate-plugin.js

@@ -0,0 +1,295 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StellatePlugin = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const core_2 = require("@vendure/core");
+const operators_1 = require("rxjs/operators");
+const api_extensions_1 = require("./api/api-extensions");
+const search_response_resolver_1 = require("./api/search-response.resolver");
+const constants_1 = require("./constants");
+const stellate_service_1 = require("./service/stellate.service");
+const StellateOptionsProvider = {
+    provide: constants_1.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. `<serviceName>.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://<service-name>.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
+ */
+let StellatePlugin = class StellatePlugin {
+    static init(options) {
+        this.options = options;
+        return this;
+    }
+    constructor(options, eventBus, stellateService, moduleRef) {
+        this.options = options;
+        this.eventBus = eventBus;
+        this.stellateService = stellateService;
+        this.moduleRef = moduleRef;
+    }
+    onApplicationBootstrap() {
+        var _a, _b, _c;
+        const injector = new core_2.Injector(this.moduleRef);
+        for (const purgeRule of (_a = this.options.purgeRules) !== null && _a !== void 0 ? _a : []) {
+            const source$ = this.eventBus.ofType(purgeRule.eventType);
+            source$
+                .pipe((0, operators_1.buffer)(source$.pipe((0, operators_1.debounceTime)((_c = (_b = purgeRule.bufferTimeMs) !== null && _b !== void 0 ? _b : this.options.defaultBufferTimeMs) !== null && _c !== void 0 ? _c : 2000))))
+                .subscribe(events => purgeRule.handle({ events, injector, stellateService: this.stellateService }));
+        }
+    }
+};
+StellatePlugin = __decorate([
+    (0, core_2.VendurePlugin)({
+        imports: [core_2.PluginCommonModule],
+        providers: [StellateOptionsProvider, stellate_service_1.StellateService],
+        shopApiExtensions: {
+            schema: api_extensions_1.shopApiExtensions,
+            resolvers: [search_response_resolver_1.SearchResponseFieldResolver],
+        },
+        compatibility: '^2.0.0',
+    }),
+    __param(0, (0, common_1.Inject)(constants_1.STELLATE_PLUGIN_OPTIONS)),
+    __metadata("design:paramtypes", [Object, core_2.EventBus,
+        stellate_service_1.StellateService,
+        core_1.ModuleRef])
+], StellatePlugin);
+exports.StellatePlugin = StellatePlugin;
+//# sourceMappingURL=stellate-plugin.js.map

package/lib/src/stellate-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stellate-plugin.js","sourceRoot":"","sources":["../../src/stellate-plugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAgE;AAChE,uCAAyC;AACzC,wCAAsF;AACtF,8CAAsD;AAEtD,yDAAyD;AACzD,6EAA6E;AAC7E,2CAAsD;AACtD,iEAA6D;AAG7D,MAAM,uBAAuB,GAAG;IAC5B,OAAO,EAAE,mCAAuB;IAChC,UAAU,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,OAAO;CAC3C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoOG;AAUI,IAAM,cAAc,GAApB,MAAM,cAAc;IAGvB,MAAM,CAAC,IAAI,CAAC,OAA8B;QACtC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,YAC6C,OAA8B,EAC/D,QAAkB,EAClB,eAAgC,EAChC,SAAoB;QAHa,YAAO,GAAP,OAAO,CAAuB;QAC/D,aAAQ,GAAR,QAAQ,CAAU;QAClB,oBAAe,GAAf,eAAe,CAAiB;QAChC,cAAS,GAAT,SAAS,CAAW;IAC7B,CAAC;IAEJ,sBAAsB;;QAClB,MAAM,QAAQ,GAAG,IAAI,eAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAE9C,KAAK,MAAM,SAAS,IAAI,MAAA,IAAI,CAAC,OAAO,CAAC,UAAU,mCAAI,EAAE,EAAE;YACnD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;YAC1D,OAAO;iBACF,IAAI,CACD,IAAA,kBAAM,EACF,OAAO,CAAC,IAAI,CACR,IAAA,wBAAY,EAAC,MAAA,MAAA,SAAS,CAAC,YAAY,mCAAI,IAAI,CAAC,OAAO,CAAC,mBAAmB,mCAAI,IAAI,CAAC,CACnF,CACJ,CACJ;iBACA,SAAS,CAAC,MAAM,CAAC,EAAE,CAChB,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC,CAChF,CAAC;SACT;IACL,CAAC;CACJ,CAAA;AAjCY,cAAc;IAT1B,IAAA,oBAAa,EAAC;QACX,OAAO,EAAE,CAAC,yBAAkB,CAAC;QAC7B,SAAS,EAAE,CAAC,uBAAuB,EAAE,kCAAe,CAAC;QACrD,iBAAiB,EAAE;YACf,MAAM,EAAE,kCAAiB;YACzB,SAAS,EAAE,CAAC,sDAA2B,CAAC;SAC3C;QACD,aAAa,EAAE,QAAQ;KAC1B,CAAC;IAUO,WAAA,IAAA,eAAM,EAAC,mCAAuB,CAAC,CAAA;6CACd,eAAQ;QACD,kCAAe;QACrB,gBAAS;GAZvB,cAAc,CAiC1B;AAjCY,wCAAc"}

package/lib/src/types.d.ts

@@ -0,0 +1,51 @@
+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. `<service-name>.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;
+}

package/lib/src/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,27 @@
+{
+    "name": "@vendure/stellate-plugin",
+    "version": "2.1.4",
+    "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.4",
+        "@vendure/core": "^2.1.4"
+    }
+}