@deenruv/replicate-simple-bg-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,54 @@
+# @deenruv/replicate-simple-bg-plugin
+
+An AI-powered background generation plugin that uses [Replicate](https://replicate.com/) models to generate styled room backgrounds from uploaded images, ideal for virtual staging of product photography.
+
+## Installation
+
+```bash
+pnpm add @deenruv/replicate-simple-bg-plugin replicate
+```
+
+## Configuration
+
+```typescript
+import { ReplicateSimpleBGPlugin } from '@deenruv/replicate-simple-bg-plugin';
+
+// In your Deenruv server config:
+plugins: [
+  ReplicateSimpleBGPlugin.init({
+    envs: {
+      deploymentName: 'your-replicate-deployment',
+      apiToken: process.env.REPLICATE_API_TOKEN,
+      assetPrefix: 'https://your-cdn.com/assets',
+    },
+    // Optional: custom prompts for image generation
+    prompts: {
+      positive: 'modern interior design',
+      negative: 'blurry, distorted',
+    },
+    // Optional: predefined room types and themes
+    roomType: [{ value: 'living-room', label: 'Living Room' }],
+    roomTheme: [{ value: 'modern', label: 'Modern', image: '/themes/modern.jpg' }],
+  }),
+]
+```
+
+## Features
+
+- AI-powered background generation using Replicate models
+- Configurable room types and interior design themes
+- File upload support with drag-and-drop interface
+- Custom entity for tracking generation jobs and results
+- Configurable positive/negative prompts and seed values
+- Admin API for triggering and managing background generation tasks
+
+## Admin UI
+
+This plugin extends the admin UI with a background generation interface including image upload via drag-and-drop, room type and style selection, generation progress tracking, and a product sidebar for quick access to generated backgrounds.
+
+## API Extensions
+
+The plugin extends the **Admin API** with:
+
+- Mutations for triggering background generation from uploaded images
+- Queries for retrieving generation status and results

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

@@ -0,0 +1,13 @@
+export declare const REPLICATE_SIMPLE_BG_PLUGIN_OPTIONS: unique symbol;
+export declare const LOGGER_CTX = "ReplicateSimpleBGPlugin";
+export declare const DEFAULT_ROOM_TYPE: {
+    value: string;
+    label: string;
+}[];
+export declare const DEFAULT_ROOM_THEME: {
+    value: string;
+    label: string;
+    image: string;
+}[];
+export declare const DEFAULT_PROMPT: string[];
+export declare const DEFAULT_NEGATIVE_PROMPT: string[];

package/dist/plugin-server/constants.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_NEGATIVE_PROMPT = exports.DEFAULT_PROMPT = exports.DEFAULT_ROOM_THEME = exports.DEFAULT_ROOM_TYPE = exports.LOGGER_CTX = exports.REPLICATE_SIMPLE_BG_PLUGIN_OPTIONS = void 0;
+exports.REPLICATE_SIMPLE_BG_PLUGIN_OPTIONS = Symbol("options");
+exports.LOGGER_CTX = "ReplicateSimpleBGPlugin";
+exports.DEFAULT_ROOM_TYPE = [
+    {
+        value: "BEDROOM",
+        label: "bedroom",
+    },
+    {
+        value: "LIVING_ROOM",
+        label: "living_room",
+    },
+    {
+        value: "DINING_ROOM",
+        label: "dining_room",
+    },
+    {
+        value: "KITCHEN",
+        label: "kitchen",
+    },
+    {
+        value: "BATHROOM",
+        label: "bathroom",
+    },
+    {
+        value: "OFFICE",
+        label: "office",
+    },
+];
+exports.DEFAULT_ROOM_THEME = [
+    {
+        value: "MODERN",
+        label: "modern",
+        image: "someimg-modern.png",
+    },
+    {
+        value: "SUMMER",
+        label: "summer",
+        image: "someimg-summer.png",
+    },
+    {
+        value: "PROFESSIONAL",
+        label: "professional",
+        image: "someimg-professional.png",
+    },
+    {
+        value: "TROPICAL",
+        label: "tropical",
+        image: "someimg-tropical.png",
+    },
+    {
+        value: "COASTAL",
+        label: "coastal",
+        image: "someimg-coastal.png",
+    },
+    {
+        value: "VINTAGE",
+        label: "vintage",
+        image: "someimg-vintage.png",
+    },
+    {
+        value: "INDUSTRIAL",
+        label: "industrial",
+        image: "someimg-industrial.png",
+    },
+    {
+        value: "NEOCLASSIC",
+        label: "neoclassic",
+        image: "someimg-neoclassic.png",
+    },
+];
+exports.DEFAULT_PROMPT = [
+    "High resolution",
+    "photography",
+    "interior design",
+    "dreamy sunken",
+    "conversion pit",
+    "wooden floor",
+    "small windows opening onto the garden",
+    "bauhaus furniture and decoration",
+    "high ceiling",
+    "beige blue salmon pastel palette",
+    "interior design magazine",
+    "cozy atmosphere",
+    "8k",
+    "intricate detail",
+    "photorealistic",
+    "realistic light",
+    "wide angle",
+    "kinkfolk photography",
+    "A+D architecture",
+];
+exports.DEFAULT_NEGATIVE_PROMPT = [
+    "deformed iris",
+    "deformed pupils",
+    "semi-realistic",
+    "cgi",
+    "3d",
+    "render",
+    "sketch",
+    "cartoon",
+    "drawing",
+    "anime",
+    "mutated",
+    "hands and fingers:1.4",
+    "deformed",
+    "distorted",
+    "poorly drawn",
+    "bad anatomy",
+    "wrong anatomy",
+    "extra limb",
+    "missing limb",
+    "floating limbs",
+    "disconnected limbs",
+    "mutation",
+    "mutated",
+    "ugly",
+    "disgusting",
+    "amputation",
+];

package/dist/plugin-server/entities/replicate-simple-bg.d.ts

@@ -0,0 +1,11 @@
+import { DeenruvEntity, DeepPartial } from "@deenruv/core";
+import "reflect-metadata";
+export declare class ReplicateSimpleBgEntity extends DeenruvEntity {
+    constructor(input?: DeepPartial<ReplicateSimpleBgEntity>);
+    prediction_simple_bg_id: string;
+    output: string;
+    status: string;
+    finishedAt: Date | null;
+    roomType: string;
+    roomStyle: string;
+}

package/dist/plugin-server/entities/replicate-simple-bg.js

@@ -0,0 +1,49 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReplicateSimpleBgEntity = void 0;
+const core_1 = require("@deenruv/core");
+const typeorm_1 = require("typeorm");
+require("reflect-metadata");
+let ReplicateSimpleBgEntity = class ReplicateSimpleBgEntity extends core_1.DeenruvEntity {
+    constructor(input) {
+        super(input);
+    }
+};
+exports.ReplicateSimpleBgEntity = ReplicateSimpleBgEntity;
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, type: "varchar", length: 255 }),
+    __metadata("design:type", String)
+], ReplicateSimpleBgEntity.prototype, "prediction_simple_bg_id", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, type: "varchar", length: 255 }),
+    __metadata("design:type", String)
+], ReplicateSimpleBgEntity.prototype, "output", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ default: "starting" }),
+    __metadata("design:type", String)
+], ReplicateSimpleBgEntity.prototype, "status", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ type: Date, nullable: true }),
+    __metadata("design:type", Object)
+], ReplicateSimpleBgEntity.prototype, "finishedAt", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, type: "varchar", length: 255 }),
+    __metadata("design:type", String)
+], ReplicateSimpleBgEntity.prototype, "roomType", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, type: "varchar", length: 255 }),
+    __metadata("design:type", String)
+], ReplicateSimpleBgEntity.prototype, "roomStyle", void 0);
+exports.ReplicateSimpleBgEntity = ReplicateSimpleBgEntity = __decorate([
+    (0, typeorm_1.Entity)(),
+    __metadata("design:paramtypes", [Object])
+], ReplicateSimpleBgEntity);

package/dist/plugin-server/extensions/replicate-simple-bg.extension.d.ts

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

package/dist/plugin-server/extensions/replicate-simple-bg.extension.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdminExtension = void 0;
+const graphql_tag_1 = require("graphql-tag");
+exports.AdminExtension = (0, graphql_tag_1.gql) `
+  input StartGenerateSimpleBgInput {
+    assetId: String
+    roomType: String
+    roomStyle: String
+    prompt: String
+  }
+
+  input GetPredictionAssetInput {
+    predictionId: String!
+    productId: String!
+  }
+
+  type AssetPrediction {
+    id: ID!
+    preview: String!
+    source: String!
+  }
+
+  extend type Mutation {
+    startGenerateSimpleBg(input: StartGenerateSimpleBgInput!): String!
+    getPredictionAsset(input: GetPredictionAssetInput!): Asset!
+  }
+
+  input GetSimpleBgEntityInput {
+    prediction_simple_bg_entity_id: String!
+  }
+
+  enum PredictionSimpleBgStatus {
+    starting
+    preprocessing
+    succeeded
+    failed
+  }
+
+  type PredictionSimpleBgResult {
+    id: ID!
+    status: PredictionSimpleBgStatus
+    image: String
+    roomType: String
+    roomStyle: String
+  }
+
+  input ReplicateSimpleBgEntityListOptions
+
+  type Image {
+    url: String!
+  }
+
+  type RoomType implements Node {
+    id: ID!
+    value: String
+    label: String
+  }
+
+  type RoomTheme implements Node {
+    id: ID!
+    value: String
+    label: String
+    image: String
+  }
+
+  type SimpleBgPluginOptions {
+    roomTypes: [RoomType]
+    roomThemes: [RoomTheme]
+  }
+
+  extend type Query {
+    getSimpleBgID(input: GetSimpleBgEntityInput!): String
+    getSimpleBgPredictions(
+      options: ReplicateSimpleBgEntityListOptions
+    ): ReplicateSimpleBgEntityList!
+    getSimpleBgItem(id: String!): PredictionSimpleBgResult!
+    getSimpleBgThemeAsset(url: String!): Image!
+    getSimpleBgOptions: SimpleBgPluginOptions!
+  }
+
+  type ReplicateSimpleBgEntity implements Node {
+    id: ID!
+    status: PredictionSimpleBgStatus!
+    finishedAt: DateTime
+  }
+
+  type ReplicateSimpleBgEntityList implements PaginatedList {
+    items: [ReplicateSimpleBgEntity!]!
+    totalItems: Int!
+  }
+
+  type SimpleBgProduct implements Node {
+    createdAt: DateTime
+    updatedAt: DateTime
+    name: String
+    slug: String
+    id: ID!
+  }
+
+  type SimpleBgProductList implements PaginatedList {
+    items: [SimpleBgProduct!]!
+    totalItems: Int!
+  }
+`;