@deenruv/facet-harmonica-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,40 @@
+# @deenruv/facet-harmonica-plugin
+
+Plugin that extends Facet and FacetValue entities with additional custom fields for enhanced product filtering. It adds color support, visibility controls, product creation flags, and image associations to facet values, enabling rich filter UI components like color swatches and accordion-style facet navigation.
+
+## Installation
+
+```bash
+pnpm add @deenruv/facet-harmonica-plugin
+```
+
+## Configuration
+
+```typescript
+import { FacetHarmonicaServerPlugin } from '@deenruv/facet-harmonica-plugin';
+
+// In your Deenruv server config:
+plugins: [
+  FacetHarmonicaServerPlugin.init({}),
+]
+```
+
+## Features
+
+- **Facet custom fields:**
+  - `usedForColors` — Boolean flag to mark facets representing color attributes
+  - `usedForProductCreations` — Boolean flag for facets used in product creation flows
+  - `colorsCollection` — Boolean flag for color collection grouping (e.g., "BLAT/CORPUS" paths)
+- **FacetValue custom fields:**
+  - `hexColor` — Hex color string with a color picker UI component
+  - `isNew` — Boolean flag to mark new facet values
+  - `isHidden` — Boolean flag to hide facet values from the storefront
+  - `image` — Relation to an Asset for visual representation
+
+## Admin UI
+
+This plugin extends the admin UI with an accordion-style facet management interface, including a color picker input for hex colors, checkbox accordion components, and dedicated action buttons for facet operations.
+
+## API Extensions
+
+This plugin does not add any GraphQL API extensions. It registers custom fields on Facet and FacetValue entities, which are automatically exposed through the standard Deenruv GraphQL API.

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

@@ -0,0 +1,4 @@
+export declare class FacetHarmonicaServerPlugin {
+    static config: {};
+    static init(config: {}): typeof FacetHarmonicaServerPlugin;
+}

package/dist/plugin-server/index.js

@@ -0,0 +1,128 @@
+"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.FacetHarmonicaServerPlugin = void 0;
+const core_1 = require("@deenruv/core");
+const FacetCustomFields = [
+    {
+        name: "usedForColors",
+        type: "boolean",
+        label: [
+            { languageCode: core_1.LanguageCode.en, value: "Used for colors" },
+            { languageCode: core_1.LanguageCode.pl, value: "Używany dla kolorów" },
+        ],
+        description: [
+            {
+                languageCode: core_1.LanguageCode.en,
+                value: "Use this attribute for guys that are colours",
+            },
+            {
+                languageCode: core_1.LanguageCode.pl,
+                value: "Użyj tego atrybutu dla facetów, którzy mają kolory",
+            },
+        ],
+        defaultValue: false,
+        public: true,
+    },
+    {
+        name: "usedForProductCreations",
+        type: "boolean",
+        ui: { component: "product-creations-input" },
+        defaultValue: false,
+        label: [
+            { languageCode: core_1.LanguageCode.en, value: "Used for product creations" },
+            { languageCode: core_1.LanguageCode.pl, value: "Używany przy kreacji" },
+        ],
+        description: [
+            { languageCode: core_1.LanguageCode.en, value: "" },
+            { languageCode: core_1.LanguageCode.pl, value: "" },
+        ],
+    },
+    {
+        name: "colorsCollection",
+        type: "boolean",
+        label: [
+            { languageCode: core_1.LanguageCode.en, value: "Color collection" },
+            { languageCode: core_1.LanguageCode.pl, value: "Kolekcja kolorów" },
+        ],
+        description: [
+            {
+                languageCode: core_1.LanguageCode.en,
+                value: "Use this for the product paths in COLOUR (BLATH/CORPUS)",
+            },
+            {
+                languageCode: core_1.LanguageCode.pl,
+                value: "Użyj tej opcji dla ścieżek produktu w KOLORZE (BLAT/CORPUS)",
+            },
+        ],
+        defaultValue: false,
+        public: true,
+    },
+];
+const FacetValueCustomFields = [
+    {
+        name: "hexColor",
+        type: "string",
+        label: [
+            { languageCode: core_1.LanguageCode.en, value: "Color" },
+            { languageCode: core_1.LanguageCode.pl, value: "Kolor" },
+        ],
+        public: true,
+        defaultValue: "---",
+        nullable: true,
+        ui: { component: "color-picker-input" },
+    },
+    {
+        name: "isNew",
+        type: "boolean",
+        label: [
+            { languageCode: core_1.LanguageCode.en, value: "New" },
+            { languageCode: core_1.LanguageCode.pl, value: "Nowy" },
+        ],
+        defaultValue: false,
+        public: true,
+    },
+    {
+        name: "isHidden",
+        type: "boolean",
+        label: [
+            { languageCode: core_1.LanguageCode.en, value: "Hidden" },
+            { languageCode: core_1.LanguageCode.pl, value: "Ukryty" },
+        ],
+        defaultValue: false,
+        public: true,
+    },
+    {
+        name: "image",
+        type: "relation",
+        label: [
+            { languageCode: core_1.LanguageCode.en, value: "Image" },
+            { languageCode: core_1.LanguageCode.pl, value: "Obraz" },
+        ],
+        entity: core_1.Asset,
+        public: true,
+    },
+];
+let FacetHarmonicaServerPlugin = class FacetHarmonicaServerPlugin {
+    static init(config) {
+        this.config = config;
+        return this;
+    }
+};
+exports.FacetHarmonicaServerPlugin = FacetHarmonicaServerPlugin;
+exports.FacetHarmonicaServerPlugin = FacetHarmonicaServerPlugin = __decorate([
+    (0, core_1.DeenruvPlugin)({
+        compatibility: "^0.0.20",
+        imports: [core_1.PluginCommonModule],
+        configuration: (config) => {
+            config.customFields.Facet.push(...FacetCustomFields);
+            config.customFields.FacetValue.push(...FacetValueCustomFields);
+            return config;
+        },
+    })
+], FacetHarmonicaServerPlugin);

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";
+};