@deenruv/method-modal-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,36 @@
+# @deenruv/method-modal-plugin
+
+Plugin that adds localized modal content fields to both PaymentMethod and ShippingMethod entities. This enables storefronts to display informational modals with custom title, description, and additional description for each payment and shipping method.
+
+## Installation
+
+```bash
+pnpm add @deenruv/method-modal-plugin
+```
+
+## Configuration
+
+```typescript
+import { MethodModalServerPlugin } from '@deenruv/method-modal-plugin';
+
+// In your Deenruv server config:
+plugins: [
+  MethodModalServerPlugin,
+]
+```
+
+## Features
+
+- Adds `modalTitle` (localeString) custom field to PaymentMethod and ShippingMethod
+- Adds `modalDescription` (localeText with rich text) custom field to PaymentMethod and ShippingMethod
+- Adds `modalAdditionalDescription` (localeText with rich text) custom field to PaymentMethod and ShippingMethod
+- Full-width rich text editor support in the admin UI
+- All fields are public and accessible from the Shop API
+
+## Admin UI
+
+This plugin is server-only and does not add any admin UI extensions. The custom fields are editable through the standard PaymentMethod and ShippingMethod detail pages in the admin panel.
+
+## API Extensions
+
+This plugin does not add any GraphQL API extensions. It registers localized custom fields on PaymentMethod and ShippingMethod entities, which are automatically exposed through the standard Deenruv GraphQL API.

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

@@ -0,0 +1,2 @@
+export declare class MethodModalServerPlugin {
+}

package/dist/plugin-server/index.js

@@ -0,0 +1,48 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MethodModalServerPlugin = void 0;
+const core_1 = require("@deenruv/core");
+const MethodModalFields = [
+    {
+        name: "modalTitle",
+        type: "localeString",
+        label: [{ languageCode: core_1.LanguageCode.en, value: "Modal title" }],
+        public: true,
+    },
+    {
+        name: "modalDescription",
+        type: "localeText",
+        label: [{ languageCode: core_1.LanguageCode.en, value: "Modal description" }],
+        ui: { richText: true, fullWidth: true },
+        public: true,
+    },
+    {
+        name: "modalAdditionalDescription",
+        type: "localeText",
+        label: [
+            { languageCode: core_1.LanguageCode.en, value: "Modal additional description" },
+        ],
+        ui: { richText: true, fullWidth: true },
+        public: true,
+    },
+];
+let MethodModalServerPlugin = class MethodModalServerPlugin {
+};
+exports.MethodModalServerPlugin = MethodModalServerPlugin;
+exports.MethodModalServerPlugin = MethodModalServerPlugin = __decorate([
+    (0, core_1.DeenruvPlugin)({
+        compatibility: "^0.0.20",
+        imports: [core_1.PluginCommonModule],
+        configuration: (config) => {
+            config.customFields.PaymentMethod.push(...MethodModalFields);
+            config.customFields.ShippingMethod.push(...MethodModalFields);
+            return config;
+        },
+    })
+], MethodModalServerPlugin);

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@deenruv/method-modal-plugin",
+  "version": "1.0.0",
+  "homepage": "https://deenruv.com/",
+  "license": "MIT",
+  "files": [
+    "dist/**/*"
+  ],
+  "main": "./dist/plugin-server/index.js",
+  "exports": {
+    ".": "./dist/plugin-server/index.js",
+    "./plugin-server": "./dist/plugin-server/index.js"
+  },
+  "dependencies": {
+    "@deenruv/common": "^1.0.0",
+    "@deenruv/react-ui-devkit": "^1.0.0"
+  },
+  "peerDependencies": {
+    "@deenruv/core": "^0.1.0"
+  },
+  "devDependencies": {
+    "rimraf": "^5.0.10",
+    "typescript": "5.3.3",
+    "@deenruv/core": "^1.0.0"
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc --build",
+    "watch": "tsc --build --watch",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "zeus": "zeus http://localhost:3000/admin-api ./src/plugin-server && zeus http://localhost:3000/admin-api ./src/plugin-ui"
+  }
+}