@haus-tech/package-size-plugin 3.0.0 → 3.0.2

package/README.md

@@ -1,36 +1,204 @@
-# Vendure plugin template
+# Package Size Plugin for Vendure
 
-1. Copy this directory and rename to `vendure-plugin-YOUR-PLUGIN-NAME`
-2. Update the `name` and `description` field in `package.json`
-4. Update this Readme: What does the plugin do? How can someone use your plugin in their project?
-5. Run `yarn` to install the dependencies
-6. Run `yarn start` to start the server
+This plugin adds package size and optional unit functionality to product variants in Vendure.
 
-The admin is now available at `http://localhost:3050/admin`. Login with _superadmin/superadmin_
+## Installation
+
+```bash
+yarn add @haus-tech/package-size-plugin
+```
+
+## Basic Usage
+
+The plugin must be initialized with configuration options using the `.init()` method:
+
+```typescript
+import { VendureConfig } from '@vendure/core'
+import { PackageSizePlugin } from '@haus-tech/package-size-plugin'
+
+export const config: VendureConfig = {
+  // ... other config
+  plugins: [
+    PackageSizePlugin.init({
+      // Configuration options (see below)
+    }),
+    // ... other plugins
+  ],
+}
+```
+
+## Configuration Options
+
+### Basic Configuration (Package Size Only)
+
+```typescript
+PackageSizePlugin.init({
+  // Uses default settings: integer package size, no unit field
+})
+```
+
+This creates a single custom field:
+
+- `packageSizeInternal`: Integer field with default value `1`
+
+### Float Package Size Support
+
+```typescript
+PackageSizePlugin.init({
+  packageSizeFieldType: 'float',
+})
+```
+
+This allows decimal values like `0.5`, `1.25`, `2.75`, etc.
+
+### With Package Size Unit
+
+```typescript
+PackageSizePlugin.init({
+  usePackageSizeUnit: true,
+  defaultUnit: 'kg',
+})
+```
+
+This adds both fields:
+
+- `packageSizeInternal`: Integer package size
+- `packageSizeUnitInternal`: String unit field with text input
+
+### Full Configuration
+
+```typescript
+PackageSizePlugin.init({
+  packageSizeFieldType: 'float', // Enable decimal values
+  usePackageSizeUnit: true, // Enable unit field
+  defaultUnit: 'kg', // Set default unit
+})
+```
+
+## Configuration Reference
+
+| Option                 | Type               | Default | Description                                                              |
+| ---------------------- | ------------------ | ------- | ------------------------------------------------------------------------ |
+| `packageSizeFieldType` | `'int' \| 'float'` | `'int'` | Data type for package size field                                         |
+| `usePackageSizeUnit`   | `boolean`          | `false` | Whether to include the unit field                                        |
+| `defaultUnit`          | `string`           | `'st'`  | Default value for unit field (only used if `usePackageSizeUnit` is true) |
+
+## GraphQL API
+
+The plugin dynamically adds fields to the ProductVariant type based on your configuration:
+
+### Integer Package Size Only
 
-The shop GraphQL `http://localhost:3050/shop-api`. Here you can test your custom GraphQL query:
 ```graphql
-{
-  exampleQuery
+type ProductVariant {
+  packageSize: Int
 }
 ```
 
-## Testing
+### Float Package Size with Unit
+
+```graphql
+type ProductVariant {
+  packageSize: Float
+  packageSizeUnit: String
+}
+```
+
+## Migration from Previous Versions
+
+If you were using this plugin without the `.init()` method, you'll need to update your configuration:
+
+**Before:**
+
+```typescript
+plugins: [PackageSizePlugin]
+```
+
+**After:**
+
+```typescript
+plugins: [
+  PackageSizePlugin.init({
+    // Add your desired configuration
+    packageSizeFieldType: 'int', // or 'float'
+    usePackageSizeUnit: false, // or true if you want units
+  }),
+]
+```
 
-1. Run `yarn test` to run the e2e test.
-2. Don't forget to implement your own!
+## Database Migration
+
+When changing `packageSizeFieldType` from `'int'` to `'float'`, you'll need to create a database migration:
+
+```bash
+npx vendure migration:generate update-package-size-to-float
+npx vendure migration:run
+```
 
-## Publishing to NPM
+## Elasticsearch Integration
 
-1. Make sure you are [logged in to NPM](https://docs.npmjs.com/cli/v9/commands/npm-login)
-2. `yarn build`
-3. `yarn publish`
+If you're using Elasticsearch, configure the mappings based on your field type:
 
-That's it!
+### For Integer Package Size
 
-(Maybe share your accomplishments in the [Vendure slack](https://join.slack.com/t/vendure-ecommerce/shared_invite/zt-1exzio25w-vjL5TYkyJZjK52d6jkOsIA)?
+```typescript
+const elasticSearchConfig: ElasticsearchOptions = {
+  // ... other config
+  indexMappingProperties: {
+    'variant-packageSize': { type: 'integer' },
+    'variant-packageSizeUnit': { type: 'keyword' }, // if using units
+  },
+  customProductVariantMappings: {
+    packageSize: {
+      graphQlType: 'Int!',
+      valueFn: async (productVariant: ProductVariant) => {
+        return productVariant.customFields.packageSizeInternal ?? 1
+      },
+    },
+    packageSizeUnit: {
+      // if using units
+      graphQlType: 'String!',
+      valueFn: async (productVariant: ProductVariant) => {
+        return productVariant.customFields.packageSizeUnitInternal ?? 'st'
+      },
+    },
+  },
+}
+```
+
+### For Float Package Size
+
+```typescript
+const elasticSearchConfig: ElasticsearchOptions = {
+  // ... other config
+  indexMappingProperties: {
+    'variant-packageSize': { type: 'float' },
+    'variant-packageSizeUnit': { type: 'keyword' }, // if using units
+  },
+  customProductVariantMappings: {
+    packageSize: {
+      graphQlType: 'Float!',
+      valueFn: async (productVariant: ProductVariant) => {
+        return productVariant.customFields.packageSizeInternal ?? 1.0
+      },
+    },
+    packageSizeUnit: {
+      // if using units
+      graphQlType: 'String!',
+      valueFn: async (productVariant: ProductVariant) => {
+        return productVariant.customFields.packageSizeUnitInternal ?? 'st'
+      },
+    },
+  },
+}
+```
 
-## Next steps
+## Features
 
-1. Check out [the docs](https://www.vendure.io/docs/plugins/) to see the possibilities of a plugin
-2. Check out [GraphQL codegen](https://the-guild.dev/graphql/codegen) to generate Typescript types for your custom GraphQL types
+- ✅ Configurable package size field type (integer or float)
+- ✅ Optional package size unit field
+- ✅ Dynamic GraphQL schema generation
+- ✅ Elasticsearch integration support
+- ✅ Multi-language labels (English/Swedish)
+- ✅ TypeScript support
+- ✅ Backward compatibility with migration path

package/dist/api/api-extensions.d.ts

@@ -1 +1 @@
-export declare const shopApiExtensions: import("graphql").DocumentNode;
+export declare const getShopApiExtensions: (packageSizeFieldType: "int" | "float") => import("graphql").DocumentNode;

package/dist/api/api-extensions.js

@@ -3,10 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.shopApiExtensions = void 0;
+exports.getShopApiExtensions = void 0;
 const graphql_tag_1 = __importDefault(require("graphql-tag"));
-exports.shopApiExtensions = (0, graphql_tag_1.default) `
-  extend type ProductVariant {
-    packageSize: Int
-  }
-`;
+const getShopApiExtensions = (packageSizeFieldType) => {
+    const packageSizeType = packageSizeFieldType === 'float' ? 'Float' : 'Int';
+    return (0, graphql_tag_1.default) `
+    extend type ProductVariant {
+      packageSize: ${packageSizeType}
+      packageSizeUnit: String
+    }
+  `;
+};
+exports.getShopApiExtensions = getShopApiExtensions;

package/dist/api/package-size.resolver.d.ts

@@ -2,4 +2,5 @@ import { RequestContext, ProductVariant } from '@vendure/core';
 export declare class ProductVariantEntityResolver {
     constructor();
     packageSize(ctx: RequestContext, variant: ProductVariant): number;
+    packageSizeUnit(ctx: RequestContext, variant: ProductVariant): string;
 }

package/dist/api/package-size.resolver.js

@@ -20,7 +20,11 @@ let ProductVariantEntityResolver = class ProductVariantEntityResolver {
     packageSize(ctx, variant) {
         return variant.customFields.packageSizeInternal || 1;
     }
+    packageSizeUnit(ctx, variant) {
+        return variant.customFields.packageSizeUnitInternal || 'st';
+    }
 };
+exports.ProductVariantEntityResolver = ProductVariantEntityResolver;
 __decorate([
     (0, graphql_1.ResolveField)(),
     __param(0, (0, core_1.Ctx)()),
@@ -29,8 +33,15 @@ __decorate([
     __metadata("design:paramtypes", [core_1.RequestContext, core_1.ProductVariant]),
     __metadata("design:returntype", void 0)
 ], ProductVariantEntityResolver.prototype, "packageSize", null);
-ProductVariantEntityResolver = __decorate([
+__decorate([
+    (0, graphql_1.ResolveField)(),
+    __param(0, (0, core_1.Ctx)()),
+    __param(1, (0, graphql_1.Parent)()),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [core_1.RequestContext, core_1.ProductVariant]),
+    __metadata("design:returntype", void 0)
+], ProductVariantEntityResolver.prototype, "packageSizeUnit", null);
+exports.ProductVariantEntityResolver = ProductVariantEntityResolver = __decorate([
     (0, graphql_1.Resolver)('ProductVariant'),
     __metadata("design:paramtypes", [])
 ], ProductVariantEntityResolver);
-exports.ProductVariantEntityResolver = ProductVariantEntityResolver;

package/dist/package-size.plugin.d.ts

@@ -1,10 +1,26 @@
+import { LanguageCode, Type } from '@vendure/core';
+export interface PackageSizeUnit {
+    value: string;
+    label: {
+        languageCode: LanguageCode;
+        value: string;
+    }[];
+}
+export interface PackageSizePluginConfig {
+    defaultUnit?: string;
+    packageSizeFieldType?: 'int' | 'float';
+    usePackageSizeUnit?: boolean;
+}
 declare module '@vendure/core' {
     interface CustomProductVariantFields {
         packageSizeInternal: number;
+        packageSizeUnitInternal: string;
     }
     interface ProductVariant {
         packageSize: number;
+        packageSizeUnit: string;
     }
 }
 export declare class PackageSizePlugin {
+    static init(config: PackageSizePluginConfig): Type<any>;
 }

package/dist/package-size.plugin.js

@@ -10,29 +10,53 @@ exports.PackageSizePlugin = void 0;
 const core_1 = require("@vendure/core");
 const api_extensions_1 = require("./api/api-extensions");
 const package_size_resolver_1 = require("./api/package-size.resolver");
-let PackageSizePlugin = class PackageSizePlugin {
-};
-PackageSizePlugin = __decorate([
-    (0, core_1.VendurePlugin)({
-        imports: [core_1.PluginCommonModule],
-        shopApiExtensions: {
-            resolvers: [package_size_resolver_1.ProductVariantEntityResolver],
-            schema: api_extensions_1.shopApiExtensions,
-        },
-        configuration: (config) => {
-            config.customFields.ProductVariant.push({
-                name: 'packageSizeInternal',
-                type: 'int',
-                defaultValue: 1,
-                public: false,
-                label: [
-                    { languageCode: core_1.LanguageCode.en, value: 'Package Size' },
-                    { languageCode: core_1.LanguageCode.sv, value: 'Förpackningsstorlek' },
-                ],
-            });
-            return config;
-        },
-        compatibility: '^3.0.0',
-    })
-], PackageSizePlugin);
+class PackageSizePlugin {
+    static init(config) {
+        const fieldType = config.packageSizeFieldType || 'int';
+        const usePackageSizeUnit = config.usePackageSizeUnit || false;
+        let DynamicPackageSizePlugin = class DynamicPackageSizePlugin {
+        };
+        DynamicPackageSizePlugin = __decorate([
+            (0, core_1.VendurePlugin)({
+                imports: [core_1.PluginCommonModule],
+                shopApiExtensions: {
+                    resolvers: [package_size_resolver_1.ProductVariantEntityResolver],
+                    schema: (0, api_extensions_1.getShopApiExtensions)(fieldType),
+                },
+                configuration: (vendureConfig) => {
+                    const defaultUnit = config.defaultUnit || 'st';
+                    const defaultValue = fieldType === 'float' ? 1.0 : 1;
+                    vendureConfig.customFields.ProductVariant.push({
+                        name: 'packageSizeInternal',
+                        type: fieldType,
+                        defaultValue: defaultValue,
+                        public: false,
+                        label: [
+                            { languageCode: core_1.LanguageCode.en, value: 'Package Size' },
+                            { languageCode: core_1.LanguageCode.sv, value: 'Förpackningsstorlek' },
+                        ],
+                    });
+                    if (usePackageSizeUnit) {
+                        vendureConfig.customFields.ProductVariant.push({
+                            name: 'packageSizeUnitInternal',
+                            type: 'string',
+                            defaultValue: defaultUnit,
+                            ui: {
+                                component: 'text-form-input',
+                            },
+                            public: false,
+                            label: [
+                                { languageCode: core_1.LanguageCode.en, value: 'Package Size Unit' },
+                                { languageCode: core_1.LanguageCode.sv, value: 'Förpackningsenhet' },
+                            ],
+                        });
+                    }
+                    return vendureConfig;
+                },
+                compatibility: '^3.0.0',
+            })
+        ], DynamicPackageSizePlugin);
+        return DynamicPackageSizePlugin;
+    }
+}
 exports.PackageSizePlugin = PackageSizePlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haus-tech/package-size-plugin",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "Package size plugin for Vendure",
   "author": "Haus Tech",
   "repository": {