@deenruv/upsell-plugin 1.0.0

package/LICENSE

@@ -0,0 +1,23 @@
+# License 1
+
+The MIT License
+
+Copyright (c) 2025-present Aexol
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# License 2
+
+The MIT License
+
+Copyright (c) 2018-2025 Michael Bromley
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,42 @@
+# @deenruv/upsell-plugin
+
+A product upselling plugin that allows you to define and manage upsell/cross-sell relationships between products in your Deenruv store, exposing them via both Admin and Shop APIs.
+
+## Installation
+
+```bash
+pnpm add @deenruv/upsell-plugin
+```
+
+## Configuration
+
+```typescript
+import { UpsellPlugin } from '@deenruv/upsell-plugin';
+
+// In your Deenruv server config:
+plugins: [
+  UpsellPlugin.init({}),
+]
+```
+
+## Features
+
+- Custom `Upsell` entity for defining product-to-product relationships
+- Admin API for creating and managing upsell associations
+- Shop API for querying upsell products on product detail pages
+- Product resolver extensions for seamlessly including upsells in product queries
+
+## Admin UI
+
+This plugin extends the admin UI with an upsell management interface including a product upsell selection dialog and an extras management page for configuring upsell relationships between products.
+
+## API Extensions
+
+The plugin extends both the **Admin API** and **Shop API**:
+
+**Admin API:**
+- Mutations for creating, updating, and deleting upsell relationships
+- Queries for listing upsell associations
+
+**Shop API:**
+- Product type resolver extension for querying upsell products associated with a given product

package/dist/plugin-server/api/upsell-admin.resolver.d.ts

@@ -0,0 +1,16 @@
+import { ID, RequestContext } from "@deenruv/core";
+import { ResolverInputTypes } from "../zeus/index.js";
+import { UpsellService } from "../services/upsell.service.js";
+export declare class UpsellAdminResolver {
+    private upsellService;
+    constructor(upsellService: UpsellService);
+    upsellProducts(ctx: RequestContext, args: {
+        productID: ID;
+    }): Promise<import("@deenruv/core").Product[]>;
+    createUpsell(ctx: RequestContext, args: {
+        input: ResolverInputTypes["UpsellInput"][];
+    }): Promise<true | undefined>;
+    deleteUpsell(ctx: RequestContext, args: {
+        input: ResolverInputTypes["UpsellInput"][];
+    }): Promise<boolean>;
+}

package/dist/plugin-server/api/upsell-admin.resolver.js

@@ -0,0 +1,58 @@
+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); }
+};
+import { Mutation, Args, Query, Resolver } from "@nestjs/graphql";
+import { Ctx, RequestContext } from "@deenruv/core";
+import { UpsellService } from "../services/upsell.service.js";
+let UpsellAdminResolver = class UpsellAdminResolver {
+    constructor(upsellService) {
+        this.upsellService = upsellService;
+    }
+    async upsellProducts(ctx, args) {
+        return this.upsellService.upsells(ctx, args.productID);
+    }
+    async createUpsell(ctx, args) {
+        return this.upsellService.createUpsell(ctx, args.input);
+    }
+    async deleteUpsell(ctx, args) {
+        return this.upsellService.deleteUpsell(ctx, args.input);
+    }
+};
+__decorate([
+    Query(),
+    __param(0, Ctx()),
+    __param(1, Args()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [RequestContext, Object]),
+    __metadata("design:returntype", Promise)
+], UpsellAdminResolver.prototype, "upsellProducts", null);
+__decorate([
+    Mutation(),
+    __param(0, Ctx()),
+    __param(1, Args()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [RequestContext, Object]),
+    __metadata("design:returntype", Promise)
+], UpsellAdminResolver.prototype, "createUpsell", null);
+__decorate([
+    Mutation(),
+    __param(0, Ctx()),
+    __param(1, Args()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [RequestContext, Object]),
+    __metadata("design:returntype", Promise)
+], UpsellAdminResolver.prototype, "deleteUpsell", null);
+UpsellAdminResolver = __decorate([
+    Resolver(),
+    __metadata("design:paramtypes", [UpsellService])
+], UpsellAdminResolver);
+export { UpsellAdminResolver };

package/dist/plugin-server/api/upsell-product.resolver.d.ts

@@ -0,0 +1,7 @@
+import { Product, RequestContext } from "@deenruv/core";
+import { UpsellService } from "../services/upsell.service.js";
+export declare class UpsellProductResolver {
+    private upsellService;
+    constructor(upsellService: UpsellService);
+    upsellProducts(ctx: RequestContext, product: Product): Promise<Product[]>;
+}

package/dist/plugin-server/api/upsell-product.resolver.js

@@ -0,0 +1,36 @@
+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); }
+};
+import { Ctx, Product, RequestContext } from "@deenruv/core";
+import { Parent, ResolveField, Resolver } from "@nestjs/graphql";
+import { UpsellService } from "../services/upsell.service.js";
+let UpsellProductResolver = class UpsellProductResolver {
+    constructor(upsellService) {
+        this.upsellService = upsellService;
+    }
+    async upsellProducts(ctx, product) {
+        return this.upsellService.upsells(ctx, product.id);
+    }
+};
+__decorate([
+    ResolveField("upsellProducts"),
+    __param(0, Ctx()),
+    __param(1, Parent()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [RequestContext, Product]),
+    __metadata("design:returntype", Promise)
+], UpsellProductResolver.prototype, "upsellProducts", null);
+UpsellProductResolver = __decorate([
+    Resolver("Product"),
+    __metadata("design:paramtypes", [UpsellService])
+], UpsellProductResolver);
+export { UpsellProductResolver };

package/dist/plugin-server/constants.d.ts

@@ -0,0 +1 @@
+export declare const UPSELL_PLUGIN_OPTIONS: unique symbol;

package/dist/plugin-server/constants.js

@@ -0,0 +1 @@
+export const UPSELL_PLUGIN_OPTIONS = Symbol("upsell-plugin-options");

package/dist/plugin-server/entities/upsell.entity.d.ts

@@ -0,0 +1,8 @@
+import { Product, DeenruvEntity } from "@deenruv/core";
+import type { DeepPartial } from "@deenruv/core";
+import type { Relation } from "typeorm";
+export declare class UpsellEntity extends DeenruvEntity {
+    constructor(input?: DeepPartial<UpsellEntity>);
+    base: Relation<Product>;
+    upsell: Relation<Product>;
+}

package/dist/plugin-server/entities/upsell.entity.js

@@ -0,0 +1,38 @@
+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);
+};
+import { Product, DeenruvEntity } from "@deenruv/core";
+import { JoinColumn, Unique, ManyToOne, Entity } from "typeorm";
+let UpsellEntity = class UpsellEntity extends DeenruvEntity {
+    constructor(input) {
+        super(input);
+    }
+};
+__decorate([
+    ManyToOne(() => Product, (product) => product.id, {
+        onDelete: "CASCADE",
+        nullable: false,
+    }),
+    JoinColumn(),
+    __metadata("design:type", Object)
+], UpsellEntity.prototype, "base", void 0);
+__decorate([
+    ManyToOne(() => Product, (product) => product.id, {
+        onDelete: "CASCADE",
+        nullable: false,
+    }),
+    JoinColumn(),
+    __metadata("design:type", Object)
+], UpsellEntity.prototype, "upsell", void 0);
+UpsellEntity = __decorate([
+    Entity(),
+    Unique(["base", "upsell"]),
+    __metadata("design:paramtypes", [Object])
+], UpsellEntity);
+export { UpsellEntity };

package/dist/plugin-server/extensions/upsell.extension.d.ts

@@ -0,0 +1,3 @@
+export declare const base: import("graphql").DocumentNode;
+export declare const ShopAPIExtension: import("graphql").DocumentNode;
+export declare const AdminAPIExtension: import("graphql").DocumentNode;

package/dist/plugin-server/extensions/upsell.extension.js

@@ -0,0 +1,26 @@
+import { gql } from "graphql-tag";
+export const base = gql `
+  extend type Product {
+    upsellProducts: [Product!]!
+  }
+`;
+export const ShopAPIExtension = gql `
+  ${base}
+`;
+export const AdminAPIExtension = gql `
+  ${base}
+
+  input UpsellInput {
+    baseProductID: ID!
+    upsellProductID: ID!
+  }
+
+  extend type Mutation {
+    createUpsell(input: [UpsellInput!]!): Boolean!
+    deleteUpsell(input: [UpsellInput!]!): Boolean!
+  }
+
+  extend type Query {
+    upsellProducts(productID: ID!): [Product!]!
+  }
+`;

package/dist/plugin-server/index.d.ts

@@ -0,0 +1,8 @@
+import type { UpsellPluginOptions } from "./types.js";
+import { ModuleRef } from "@nestjs/core";
+export declare class UpsellPlugin {
+    private moduleRef;
+    static options: UpsellPluginOptions;
+    constructor(moduleRef: ModuleRef);
+    static init(options: UpsellPluginOptions): typeof UpsellPlugin;
+}

package/dist/plugin-server/index.js

@@ -0,0 +1,43 @@
+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);
+};
+import { PluginCommonModule, DeenruvPlugin } from "@deenruv/core";
+import { ModuleRef } from "@nestjs/core";
+import { UpsellEntity } from "./entities/upsell.entity.js";
+import { UpsellService } from "./services/upsell.service.js";
+import { AdminAPIExtension, ShopAPIExtension, } from "./extensions/upsell.extension.js";
+import { UpsellAdminResolver } from "./api/upsell-admin.resolver.js";
+import { UpsellProductResolver } from "./api/upsell-product.resolver.js";
+let UpsellPlugin = class UpsellPlugin {
+    constructor(moduleRef) {
+        this.moduleRef = moduleRef;
+    }
+    static init(options) {
+        this.options = options;
+        return this;
+    }
+};
+UpsellPlugin = __decorate([
+    DeenruvPlugin({
+        compatibility: "0.0.1",
+        imports: [PluginCommonModule],
+        entities: [UpsellEntity],
+        providers: [UpsellService],
+        shopApiExtensions: {
+            schema: ShopAPIExtension,
+            resolvers: [UpsellProductResolver],
+        },
+        adminApiExtensions: {
+            schema: AdminAPIExtension,
+            resolvers: [UpsellProductResolver, UpsellAdminResolver],
+        },
+    }),
+    __metadata("design:paramtypes", [ModuleRef])
+], UpsellPlugin);
+export { UpsellPlugin };

package/dist/plugin-server/services/upsell.service.d.ts

@@ -0,0 +1,11 @@
+import { TransactionalConnection, RequestContext, ID } from "@deenruv/core";
+import { ResolverInputTypes } from "../zeus/index.js";
+export declare class UpsellService {
+    private connection;
+    private readonly logger;
+    private readonly log;
+    constructor(connection: TransactionalConnection);
+    upsells(ctx: RequestContext, productID: ID): Promise<import("@deenruv/core").Product[]>;
+    createUpsell(ctx: RequestContext, input: ResolverInputTypes["UpsellInput"][]): Promise<true | undefined>;
+    deleteUpsell(ctx: RequestContext, input: ResolverInputTypes["UpsellInput"][]): Promise<boolean>;
+}

package/dist/plugin-server/services/upsell.service.js

@@ -0,0 +1,76 @@
+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);
+};
+import { Injectable } from "@nestjs/common";
+import { TransactionalConnection, Logger, } from "@deenruv/core";
+import { UpsellEntity } from "../entities/upsell.entity.js";
+let UpsellService = class UpsellService {
+    constructor(connection) {
+        this.connection = connection;
+        this.logger = new Logger();
+        this.log = (msg) => this.logger.log(msg, "UpsellService");
+        this.log("UpsellService initialized");
+    }
+    async upsells(ctx, productID) {
+        try {
+            const upsell = await this.connection
+                .getRepository(ctx, UpsellEntity)
+                .find({
+                where: { base: { id: productID } },
+                relations: { upsell: { variants: true } },
+            });
+            return upsell.map(({ upsell }) => upsell);
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : "An error occurred";
+            this.logger.error(errorMessage);
+            return [];
+        }
+    }
+    async createUpsell(ctx, input) {
+        const entities = input.flatMap(({ baseProductID, upsellProductID }) => [
+            new UpsellEntity({
+                base: { id: baseProductID },
+                upsell: { id: upsellProductID },
+            }),
+            new UpsellEntity({
+                base: { id: upsellProductID },
+                upsell: { id: baseProductID },
+            }),
+        ]);
+        try {
+            return !!(await Promise.all(entities.map((entity) => this.connection.getRepository(ctx, UpsellEntity).upsert(entity, {
+                conflictPaths: { base: true, upsell: true },
+                upsertType: "on-conflict-do-update",
+            }))));
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : "An error occurred";
+            this.logger.error(errorMessage);
+        }
+    }
+    async deleteUpsell(ctx, input) {
+        const [deletedA, deletedB] = await Promise.all([
+            input.map(({ baseProductID, upsellProductID }) => this.connection.getRepository(ctx, UpsellEntity).delete({
+                base: { id: baseProductID },
+                upsell: { id: upsellProductID },
+            })),
+            input.map(({ baseProductID, upsellProductID }) => this.connection.getRepository(ctx, UpsellEntity).delete({
+                base: { id: upsellProductID },
+                upsell: { id: baseProductID },
+            })),
+        ]);
+        return !!deletedA.length && !!deletedB.length;
+    }
+};
+UpsellService = __decorate([
+    Injectable(),
+    __metadata("design:paramtypes", [TransactionalConnection])
+], UpsellService);
+export { UpsellService };

package/dist/plugin-server/types.d.ts

@@ -0,0 +1 @@
+export type UpsellPluginOptions = {};

package/dist/plugin-server/types.js

@@ -0,0 +1 @@
+export {};

package/dist/plugin-server/zeus/const.d.ts

@@ -0,0 +1,6 @@
+export declare const AllTypesProps: Record<string, any>;
+export declare const ReturnTypes: Record<string, any>;
+export declare const Ops: {
+    query: "Query";
+    mutation: "Mutation";
+};