@pinelab/vendure-plugin-anonymized-order 1.0.1 → 1.1.0

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.1.0 (2024-06-14)
+
+- Allow overriding the default removal of fields with the custom strategy
+
 # 1.0.1 (2023-12-29)
 
 - Fixed exposed fields bug reported in [here](https://github.com/Pinelab-studio/pinelab-vendure-plugins/issues/316)

package/README.md

@@ -8,13 +8,7 @@ Add the plugin to your config:
 
 ```ts
 import { AnonymizedOrderPlugin } from '@pinelab/vendure-plugin-anonymized-order';
-plugins: [
-  AnonymizedOrderPlugin.init({
-    anonymizeOrderFn: (order) => {
-      order.lines = [];
-    },
-  }),
-];
+plugins: [AnonymizedOrderPlugin.init({})];
 ```
 
 ## Displaying placed order without requiring the customer to log in
@@ -36,3 +30,22 @@ In the order confirmation email, you could have a link like `https://my-storefro
 ```
 
 This will then return the order without `shippingAddress`, `billingAddress` and `customer` fields.
+
+## Customizing what data is removed
+
+You can supply your own strategy for anonymizing a given order. In that case, **the plugin will not remove any data from the order** for you.
+
+The example below will only remove the customer, but still expose shipping and billing address:
+
+```ts
+import { AnonymizedOrderPlugin } from '@pinelab/vendure-plugin-anonymized-order';
+plugins: [
+  AnonymizedOrderPlugin.init({
+    anonymizeOrderFn: (order) => {
+      order.customer = {};
+    },
+  }),
+];
+```
+
+You should be cautious about what to return, because of the relational nature of GraphQL. For example, exposing the `order.customer`, will also allow the client to query `order.customer.orders`, thus exposing all orders of that customer.

package/dist/anonymized-order.resolver.d.ts

@@ -6,5 +6,5 @@ export declare class AnonymizeOrderShopResolver {
     anonymizedOrder(ctx: RequestContext, args: {
         orderCode: string;
         emailAddress: string;
-    }): Promise<Order>;
+    }, info: any): Promise<Order>;
 }

package/dist/anonymized-order.resolver.js

@@ -20,7 +20,7 @@ let AnonymizeOrderShopResolver = class AnonymizeOrderShopResolver {
     constructor(anonymizeOrderService) {
         this.anonymizeOrderService = anonymizeOrderService;
     }
-    async anonymizedOrder(ctx, args) {
+    async anonymizedOrder(ctx, args, info) {
         return await this.anonymizeOrderService.getAnonymizedOrder(ctx, args.orderCode, args.emailAddress);
     }
 };
@@ -28,8 +28,9 @@ __decorate([
     (0, graphql_1.Query)(),
     __param(0, (0, core_1.Ctx)()),
     __param(1, (0, graphql_1.Args)()),
+    __param(2, (0, graphql_1.Info)()),
     __metadata("design:type", Function),
-    __metadata("design:paramtypes", [core_1.RequestContext, Object]),
+    __metadata("design:paramtypes", [core_1.RequestContext, Object, Object]),
     __metadata("design:returntype", Promise)
 ], AnonymizeOrderShopResolver.prototype, "anonymizedOrder", null);
 AnonymizeOrderShopResolver = __decorate([

package/dist/anonymized-order.service.js

@@ -22,17 +22,16 @@ let AnonymizeOrderService = class AnonymizeOrderService {
         this.orderService = orderService;
     }
     async getAnonymizedOrder(ctx, orderCode, emailAddress) {
-        const order = await this.orderService.findOneByCode(ctx, orderCode);
+        let order = await this.orderService.findOneByCode(ctx, orderCode);
         if (order && order.customer?.emailAddress === emailAddress) {
-            order.customer = undefined;
-            order.shippingAddress = {};
-            order.billingAddress = {};
-            for (let line of order.lines) {
-                line.order = new core_1.Order();
-            }
             if (this.options?.anonymizeOrderFn) {
                 this.options.anonymizeOrderFn(order);
             }
+            else {
+                order.customer = undefined;
+                order.shippingAddress = {};
+                order.billingAddress = {};
+            }
             return order;
         }
         throw new core_1.ForbiddenError();

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@pinelab/vendure-plugin-anonymized-order",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "This plugin facilitates the retrieval of anonymized customer orders",
-  "icon": "incognito",
   "author": "Surafel Tariku <surafelmelese09@gmail.com>",
   "homepage": "https://pinelab-plugins.com/",
   "repository": "https://github.com/Pinelab-studio/pinelab-vendure-plugins",
@@ -25,7 +24,8 @@
     "start": "yarn ts-node test/dev-server.ts",
     "build": "rimraf dist && yarn graphql-codegen && tsc",
     "test": "vitest run",
-    "generate": "graphql-codegen"
+    "generate": "graphql-codegen",
+    "lint": "echo 'No linting configured'"
   },
-  "gitHead": "4720c6183691dbf9fb027bb901f53fba18e5d3cb"
+  "gitHead": "58fff53b60a3f1fa9933affdee99001247f46f49"
 }