@pinelab/vendure-plugin-anonymized-order 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0 (2023-12-28)
+
+- Created the plugin

package/README.md

@@ -0,0 +1,38 @@
+# Vendure Anonymized Order
+
+This plugin enables the retrieval of an anonymized customer order. By default, the `anonymizedOrder` query omits the fields `customer`, `billingAddress`, and `shippingAddress` from the order details. However, users have the flexibility to further customize this process by adding a callback, allowing the removal of additional fields as needed.
+
+## Getting started
+
+Add the plugin to your config:
+
+```ts
+import { AnonymizedOrderPlugin } from '@pinelab/vendure-plugin-anonymized-order';
+plugins: [
+  AnonymizedOrderPlugin.init({
+    anonymizeOrderFn: (order) => {
+      order.lines = [];
+    },
+  }),
+];
+```
+
+## Displaying placed order without requiring the customer to log in
+
+The `anonymizedOrder` query can be used to display a customers' placed order permanently, instead of for a limited time only, like the built-in `orderByCode` query. This can be used to show a placed order via a link in email for example.
+
+In the order confirmation email, you could have a link like `https://my-storefront.io/order/GX83VCD73?emailAddress=the-customer@email.com`. On your storefront, you'd then use the following query to display the order:
+
+```graphql
+    anonymizedOrder(orderCode: "GX83VCD73", emailAddress: "the-customer@email.com") {
+      id
+      code
+      totalWithTax
+      lines {
+        id
+        linePriceWithTax
+      }
+    }
+```
+
+This will then return the order without `shippingAddress`, `billingAddress` and `customer` fields.

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

@@ -0,0 +1,10 @@
+import { Order, RequestContext } from '@vendure/core';
+import { AnonymizeOrderService } from './anonymized-order.service';
+export declare class AnonymizeOrderShopResolver {
+    private readonly anonymizeOrderService;
+    constructor(anonymizeOrderService: AnonymizeOrderService);
+    anonymizedOrder(ctx: RequestContext, args: {
+        orderCode: string;
+        emailAddress: string;
+    }): Promise<Order>;
+}

package/dist/anonymized-order.resolver.js

@@ -0,0 +1,39 @@
+"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.AnonymizeOrderShopResolver = void 0;
+const graphql_1 = require("@nestjs/graphql");
+const core_1 = require("@vendure/core");
+const anonymized_order_service_1 = require("./anonymized-order.service");
+let AnonymizeOrderShopResolver = class AnonymizeOrderShopResolver {
+    constructor(anonymizeOrderService) {
+        this.anonymizeOrderService = anonymizeOrderService;
+    }
+    async anonymizedOrder(ctx, args) {
+        return await this.anonymizeOrderService.getAnonymizedOrder(ctx, args.orderCode, args.emailAddress);
+    }
+};
+__decorate([
+    (0, graphql_1.Query)(),
+    __param(0, (0, core_1.Ctx)()),
+    __param(1, (0, graphql_1.Args)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [core_1.RequestContext, Object]),
+    __metadata("design:returntype", Promise)
+], AnonymizeOrderShopResolver.prototype, "anonymizedOrder", null);
+AnonymizeOrderShopResolver = __decorate([
+    (0, graphql_1.Resolver)(),
+    __metadata("design:paramtypes", [anonymized_order_service_1.AnonymizeOrderService])
+], AnonymizeOrderShopResolver);
+exports.AnonymizeOrderShopResolver = AnonymizeOrderShopResolver;

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

@@ -0,0 +1,8 @@
+import { AnonymizeOrderPluginOptions } from './types';
+import { Order, OrderService, RequestContext } from '@vendure/core';
+export declare class AnonymizeOrderService {
+    private readonly options;
+    private readonly orderService;
+    constructor(options: AnonymizeOrderPluginOptions, orderService: OrderService);
+    getAnonymizedOrder(ctx: RequestContext, orderCode: string, emailAddress: string): Promise<Order>;
+}

package/dist/anonymized-order.service.js

@@ -0,0 +1,43 @@
+"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.AnonymizeOrderService = void 0;
+const common_1 = require("@nestjs/common");
+const constants_1 = require("./constants");
+const core_1 = require("@vendure/core");
+let AnonymizeOrderService = class AnonymizeOrderService {
+    constructor(options, orderService) {
+        this.options = options;
+        this.orderService = orderService;
+    }
+    async getAnonymizedOrder(ctx, orderCode, emailAddress) {
+        const order = await this.orderService.findOneByCode(ctx, orderCode);
+        if (order && order.customer?.emailAddress === emailAddress) {
+            order.customer = undefined;
+            order.shippingAddress = {};
+            order.billingAddress = {};
+            if (this.options?.anonymizeOrderFn) {
+                this.options.anonymizeOrderFn(order);
+            }
+            return order;
+        }
+        throw new core_1.ForbiddenError();
+    }
+};
+AnonymizeOrderService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, common_1.Inject)(constants_1.PLUGIN_INIT_OPTIONS)),
+    __metadata("design:paramtypes", [Object, core_1.OrderService])
+], AnonymizeOrderService);
+exports.AnonymizeOrderService = AnonymizeOrderService;

package/dist/api-extensions.d.ts

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

package/dist/api-extensions.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.anonymizeOrderShopSchema = void 0;
+const graphql_tag_1 = require("graphql-tag");
+const scalars = (0, graphql_tag_1.gql) `
+  scalar Order
+`;
+exports.anonymizeOrderShopSchema = (0, graphql_tag_1.gql) `
+  extend type Query {
+    anonymizedOrder(orderCode: String!, emailAddress: String!): Order!
+  }
+`;

package/dist/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const loggerCtx = "AnonymizedOrderPlugin";
+export declare const PLUGIN_INIT_OPTIONS: unique symbol;

package/dist/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PLUGIN_INIT_OPTIONS = exports.loggerCtx = void 0;
+exports.loggerCtx = 'AnonymizedOrderPlugin';
+exports.PLUGIN_INIT_OPTIONS = Symbol('PLUGIN_INIT_OPTIONS');

package/dist/generated/graphql.d.ts

@@ -0,0 +1,30 @@
+export type Maybe<T> = T | null;
+export type InputMaybe<T> = Maybe<T>;
+export type Exact<T extends {
+    [key: string]: unknown;
+}> = {
+    [K in keyof T]: T[K];
+};
+export type MakeOptional<T, K extends keyof T> = Omit<T, K> & {
+    [SubKey in K]?: Maybe<T[SubKey]>;
+};
+export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & {
+    [SubKey in K]: Maybe<T[SubKey]>;
+};
+/** All built-in and custom scalars, mapped to their actual values */
+export type Scalars = {
+    ID: string;
+    String: string;
+    Boolean: boolean;
+    Int: number;
+    Float: number;
+    Order: any;
+};
+export type Query = {
+    __typename?: 'Query';
+    anonymizedOrder: Scalars['Order'];
+};
+export type QueryAnonymizedOrderArgs = {
+    emailAddress: Scalars['String'];
+    orderCode: Scalars['String'];
+};

package/dist/generated/graphql.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './plugin';
+export * from './types';
+export * from './anonymized-order.service';
+export * from './anonymized-order.resolver';

package/dist/index.js

@@ -0,0 +1,20 @@
+"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("./plugin"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./anonymized-order.service"), exports);
+__exportStar(require("./anonymized-order.resolver"), exports);

package/dist/plugin.d.ts

@@ -0,0 +1,5 @@
+import { AnonymizeOrderPluginOptions } from './types';
+export declare class AnonymizedOrderPlugin {
+    static options: AnonymizeOrderPluginOptions | undefined;
+    static init(options: AnonymizeOrderPluginOptions): typeof AnonymizedOrderPlugin;
+}

package/dist/plugin.js

@@ -0,0 +1,38 @@
+"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 AnonymizedOrderPlugin_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnonymizedOrderPlugin = void 0;
+const core_1 = require("@vendure/core");
+const anonymized_order_service_1 = require("./anonymized-order.service");
+const constants_1 = require("./constants");
+const anonymized_order_resolver_1 = require("./anonymized-order.resolver");
+const api_extensions_1 = require("./api-extensions");
+let AnonymizedOrderPlugin = AnonymizedOrderPlugin_1 = class AnonymizedOrderPlugin {
+    static init(options) {
+        this.options = options;
+        return AnonymizedOrderPlugin_1;
+    }
+};
+AnonymizedOrderPlugin = AnonymizedOrderPlugin_1 = __decorate([
+    (0, core_1.VendurePlugin)({
+        providers: [
+            anonymized_order_service_1.AnonymizeOrderService,
+            {
+                provide: constants_1.PLUGIN_INIT_OPTIONS,
+                useFactory: () => AnonymizedOrderPlugin_1.options,
+            },
+        ],
+        shopApiExtensions: {
+            resolvers: [anonymized_order_resolver_1.AnonymizeOrderShopResolver],
+            schema: api_extensions_1.anonymizeOrderShopSchema,
+        },
+        imports: [core_1.PluginCommonModule],
+    })
+], AnonymizedOrderPlugin);
+exports.AnonymizedOrderPlugin = AnonymizedOrderPlugin;

package/dist/types.d.ts

@@ -0,0 +1,5 @@
+import { Order } from '@vendure/core';
+export type AnonymizeOrderFn = (order: Order) => void;
+export interface AnonymizeOrderPluginOptions {
+    anonymizeOrderFn?: AnonymizeOrderFn;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@pinelab/vendure-plugin-anonymized-order",
+  "version": "1.0.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",
+  "license": "MIT",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "start": "yarn ts-node test/dev-server.ts",
+    "build": "rimraf dist && yarn graphql-codegen && tsc",
+    "test": "vitest run",
+    "generate": "graphql-codegen"
+  },
+  "gitHead": "b6d884add25e1b5a335767af35ba52b13a2037ac"
+}