@deenruv/deenruv-examples-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,37 @@
+# @deenruv/deenruv-examples-plugin
+
+Example and reference plugin demonstrating how to use custom fields across various Deenruv entities. It registers a wide variety of custom field types on Products, Orders, OrderLines, Collections, Facets, ProductVariants, and Assets for development and testing purposes.
+
+## Installation
+
+```bash
+pnpm add @deenruv/deenruv-examples-plugin
+```
+
+## Configuration
+
+```typescript
+import { DeenruvExamplesServerPlugin } from '@deenruv/deenruv-examples-plugin';
+
+// In your Deenruv server config:
+plugins: [
+  DeenruvExamplesServerPlugin,
+]
+```
+
+## Features
+
+- Demonstrates all supported custom field types: string, boolean, float, int, text, datetime, localeString, localeText
+- Examples of list-type custom fields (string list, int list, float list, text list, localeString list, localeText list)
+- Relation custom fields: single Asset, list of Assets, list of Products, list of ProductVariants
+- Custom fields on multiple entities: Product, Order, OrderLine, Collection, Facet, ProductVariant, Asset
+- Multi-language labels and descriptions (English and Polish)
+- Reference implementation for plugin developers
+
+## Admin UI
+
+This plugin extends the admin UI with example pages, test components, custom input components, and custom table configurations to demonstrate the plugin UI extension system.
+
+## API Extensions
+
+This plugin does not add any GraphQL API extensions. It only registers custom fields on existing entities, which are automatically exposed through the standard Deenruv GraphQL API.

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

@@ -0,0 +1,3 @@
+import { OrderLineEvent, OrderStateTransitionEvent, LoginEvent, LogoutEvent } from "@deenruv/core";
+export declare const PLUGIN_INIT_OPTIONS: unique symbol;
+export declare const events: (typeof OrderLineEvent | typeof OrderStateTransitionEvent | typeof LoginEvent | typeof LogoutEvent)[];

package/dist/plugin-server/constants.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.events = exports.PLUGIN_INIT_OPTIONS = void 0;
+const core_1 = require("@deenruv/core");
+exports.PLUGIN_INIT_OPTIONS = Symbol("ANALYTICS_PLUGIN_OPTIONS");
+exports.events = [
+    core_1.OrderLineEvent,
+    core_1.OrderStateTransitionEvent,
+    core_1.LoginEvent,
+    core_1.LogoutEvent,
+];

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

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

package/dist/plugin-server/index.js

@@ -0,0 +1,286 @@
+"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.DeenruvExamplesServerPlugin = void 0;
+const core_1 = require("@deenruv/core");
+let DeenruvExamplesServerPlugin = class DeenruvExamplesServerPlugin {
+};
+exports.DeenruvExamplesServerPlugin = DeenruvExamplesServerPlugin;
+exports.DeenruvExamplesServerPlugin = DeenruvExamplesServerPlugin = __decorate([
+    (0, core_1.DeenruvPlugin)({
+        compatibility: "0.0.1",
+        imports: [core_1.PluginCommonModule],
+        controllers: [],
+        providers: [],
+        configuration: (config) => {
+            // PRODUCT
+            config.customFields.Product.push({
+                name: "discountBy",
+                type: "string",
+                nullable: true,
+                defaultValue: "",
+                ui: { component: "string-custom-field-input" },
+                label: [
+                    { languageCode: core_1.LanguageCode.en, value: "Discount by" },
+                    { languageCode: core_1.LanguageCode.pl, value: "Obniż cenę o" },
+                ],
+                description: [
+                    {
+                        languageCode: core_1.LanguageCode.en,
+                        value: "This field lets user define discount by given number.",
+                    },
+                    {
+                        languageCode: core_1.LanguageCode.pl,
+                        value: "Te pole pozwala określić o ile taniej produkt ma kosztować.",
+                    },
+                ],
+            });
+            config.customFields.Product.push({
+                name: "boolTest",
+                type: "boolean",
+                label: [{ languageCode: core_1.LanguageCode.en, value: "boolean Test" }],
+            });
+            config.customFields.Product.push({
+                name: "floatTest",
+                type: "float",
+                label: [{ languageCode: core_1.LanguageCode.en, value: "float Test" }],
+            });
+            config.customFields.Product.push({
+                name: "intTest",
+                type: "int",
+                label: [{ languageCode: core_1.LanguageCode.en, value: "int Test" }],
+            });
+            config.customFields.Product.push({
+                name: "stringTest",
+                type: "string",
+                label: [{ languageCode: core_1.LanguageCode.en, value: "string Test" }],
+            });
+            config.customFields.Product.push({
+                name: "textTest",
+                type: "text",
+                label: [{ languageCode: core_1.LanguageCode.en, value: "text Test" }],
+            });
+            config.customFields.Product.push({
+                name: "dateTime",
+                type: "datetime",
+                label: [{ languageCode: core_1.LanguageCode.en, value: "dateTime Test" }],
+            });
+            config.customFields.Product.push({
+                name: "listTestString",
+                type: "string",
+                list: true,
+                label: [
+                    { languageCode: core_1.LanguageCode.en, value: "String list test" },
+                    { languageCode: core_1.LanguageCode.pl, value: "test listy String" },
+                ],
+            });
+            config.customFields.Product.push({
+                name: "listTestInt",
+                type: "int",
+                list: true,
+                label: [{ languageCode: core_1.LanguageCode.en, value: "int list test" }],
+            });
+            config.customFields.Product.push({
+                name: "listTestFloat",
+                type: "float",
+                list: true,
+                label: [{ languageCode: core_1.LanguageCode.en, value: "float list test" }],
+            });
+            config.customFields.Product.push({
+                name: "listTestText",
+                type: "text",
+                list: true,
+                label: [{ languageCode: core_1.LanguageCode.en, value: "Text list test" }],
+            });
+            config.customFields.Product.push({
+                name: "listLocaleString",
+                list: true,
+                type: "localeString",
+                label: [
+                    { languageCode: core_1.LanguageCode.en, value: "listLocaleString Test" },
+                ],
+            });
+            config.customFields.Product.push({
+                name: "listLocaleText",
+                list: true,
+                type: "localeText",
+                label: [{ languageCode: core_1.LanguageCode.en, value: "listLocaleText Test" }],
+            });
+            config.customFields.Product.push({
+                name: "singleAssetTestP",
+                type: "relation",
+                graphQLType: "Asset",
+                entity: core_1.Asset,
+                public: true,
+                nullable: true,
+                eager: true,
+                label: [{ languageCode: core_1.LanguageCode.en, value: "single asset Test" }],
+                description: [
+                    {
+                        languageCode: core_1.LanguageCode.en,
+                        value: "Recommended size: 1200x630px",
+                    },
+                ],
+            });
+            config.customFields.Product.push({
+                name: "listAssetTestP",
+                type: "relation",
+                graphQLType: "Asset",
+                entity: core_1.Asset,
+                public: true,
+                nullable: true,
+                eager: true,
+                list: true,
+                label: [{ languageCode: core_1.LanguageCode.en, value: "list asset Test" }],
+                description: [
+                    {
+                        languageCode: core_1.LanguageCode.en,
+                        value: "Recommended size: 1200x630px",
+                    },
+                ],
+            });
+            // ORDER
+            config.customFields.Order.push({
+                name: "attributes",
+                type: "text",
+                label: [
+                    { languageCode: core_1.LanguageCode.en, value: "Attributes" },
+                    { languageCode: core_1.LanguageCode.pl, value: "Atrybuty" },
+                ],
+                description: [
+                    {
+                        languageCode: core_1.LanguageCode.en,
+                        value: "Here you can specify order attributes",
+                    },
+                    {
+                        languageCode: core_1.LanguageCode.pl,
+                        value: "Tutaj możesz opisać różne atrybuty zamówienia",
+                    },
+                ],
+                defaultValue: "",
+                nullable: true,
+            }, {
+                name: "additionalInfo",
+                type: "string",
+                label: [
+                    { languageCode: core_1.LanguageCode.en, value: "Additional info" },
+                    { languageCode: core_1.LanguageCode.pl, value: "Dodatkowe informacje" },
+                ],
+                defaultValue: "",
+                nullable: true,
+            });
+            // ORDER_LINE
+            config.customFields.OrderLine.push({
+                name: "SOMETHING",
+                type: "string",
+                label: [{ languageCode: core_1.LanguageCode.en, value: "string Test" }],
+            });
+            // COLLECTION
+            config.customFields.Collection.push({
+                name: "stringTest",
+                type: "string",
+                label: [{ languageCode: core_1.LanguageCode.en, value: "string Test" }],
+            });
+            config.customFields.Collection.push({
+                name: "localestringTest",
+                type: "localeString",
+                label: [{ languageCode: core_1.LanguageCode.en, value: "localestring Test" }],
+            });
+            // FACET
+            config.customFields.Facet.push({
+                name: "stringTest",
+                type: "string",
+                label: [{ languageCode: core_1.LanguageCode.en, value: "string Test" }],
+            });
+            config.customFields.Facet.push({
+                name: "localestringTest",
+                type: "localeString",
+                label: [{ languageCode: core_1.LanguageCode.en, value: "localestring Test" }],
+            });
+            config.customFields.Facet.push({
+                name: "ProductListTest",
+                type: "relation",
+                graphQLType: "Product",
+                entity: core_1.Product,
+                public: true,
+                nullable: true,
+                eager: true,
+                list: true,
+                label: [{ languageCode: core_1.LanguageCode.en, value: "list Product Test" }],
+                description: [
+                    {
+                        languageCode: core_1.LanguageCode.en,
+                        value: "Recommended size: 1200x630px",
+                    },
+                ],
+            });
+            config.customFields.Facet.push({
+                name: "listProductVariantTest",
+                type: "relation",
+                graphQLType: "ProductVariant",
+                entity: core_1.ProductVariant,
+                public: true,
+                nullable: true,
+                eager: true,
+                list: true,
+                label: [
+                    { languageCode: core_1.LanguageCode.en, value: "list product variant test" },
+                ],
+            });
+            //ORDER_LINE
+            config.customFields.OrderLine.push({
+                name: "stringTest",
+                type: "string",
+                label: [{ languageCode: core_1.LanguageCode.en, value: "string Test" }],
+            });
+            config.customFields.OrderLine.push({
+                name: "textTest",
+                type: "text",
+                label: [{ languageCode: core_1.LanguageCode.en, value: "text Test" }],
+            });
+            //PRODUCT_VARIANT
+            config.customFields.ProductVariant.push({
+                name: "stringTest",
+                type: "string",
+                label: [{ languageCode: core_1.LanguageCode.en, value: "string Test" }],
+            });
+            // ASSET
+            config.customFields.Asset.push({
+                name: "attributes",
+                type: "text",
+                label: [
+                    { languageCode: core_1.LanguageCode.en, value: "Attributes" },
+                    { languageCode: core_1.LanguageCode.pl, value: "Atrybuty" },
+                ],
+                description: [
+                    {
+                        languageCode: core_1.LanguageCode.en,
+                        value: "Here you can specify order attributes",
+                    },
+                    {
+                        languageCode: core_1.LanguageCode.pl,
+                        value: "Tutaj możesz opisać różne atrybuty zamówienia",
+                    },
+                ],
+                defaultValue: "",
+                nullable: true,
+            }, {
+                name: "additionalInfo",
+                type: "string",
+                label: [
+                    { languageCode: core_1.LanguageCode.en, value: "Additional info" },
+                    { languageCode: core_1.LanguageCode.pl, value: "Dodatkowe informacje" },
+                ],
+                defaultValue: "",
+                nullable: true,
+            });
+            // relation fields
+            return config;
+        },
+    })
+], DeenruvExamplesServerPlugin);

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