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

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+## 3.0.3
+
+### 🚀 Features
+
+- **package-size-plugin:** enhance package size configuration options ([c04bd80](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/c04bd80))
+- **package-size-plugin:** add package size unit support to ProductVariant ([3e2cdf0](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/3e2cdf0))
+- **product:** Product package size plugin ([#2](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/pull/2))
+
+### 🩹 Fixes
+
+- **package-size-plugin:** set default package size unit to 'st' ([e08589c](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/e08589c))
+
+## 3.0.1
+
+### 🚀 Features
+
+- **package-size-plugin:** add package size unit support to ProductVariant ([3e2cdf0](https://github.com/WeAreHausTech/haus-tech-vendure-plugins/commit/3e2cdf0))
+
+## 3.0.0
+
+### 🚀 Features
+
+- Product package size plugin (#2) ([b38c847](https://github.com/WeAreHausTech/haus-vendure-plugins-public/commit/b38c8477c4728556f5711d57b7ef8acdfad029e9))
+- New plugin - product popularity (#6) ([3de3285](https://github.com/WeAreHausTech/haus-vendure-plugins-public/commit/3de3285c57c300ee46e2d02f5c960ceb323401e2))

package/README.md

@@ -1,4 +1,11 @@
-# Package Size Plugin for Vendure
+---
+name: package-size-plugin
+title: Package Size Plugin
+description: Vendure plugin that allows you to manage and expose custom package size information for product variants.
+version: 3.0.2
+---
+
+# Package Size Plugin
 
 This plugin adds package size and optional unit functionality to product variants in Vendure.
 
@@ -193,6 +200,51 @@ const elasticSearchConfig: ElasticsearchOptions = {
 }
 ```
 
+## Use Cases
+
+The Package Size Plugin is ideal for:
+
+- E-commerce platforms that require detailed package size information for logistics and shipping calculations.
+- Businesses that need to expose package size data to customers or third-party systems via the shop API.
+- Scenarios where Elasticsearch is used to index and search for product variant data, including package sizes.
+
+## Example GraphQL Query
+
+You can query the `packageSize` field using the shop API:
+
+```graphql
+query {
+  product(id: "1") {
+    variants {
+      id
+      name
+      packageSize
+      packageSizeUnit # if using units
+    }
+  }
+}
+```
+
+## Testing
+
+1. Run `yarn test` to execute the e2e tests.
+2. Implement additional tests to cover your specific use cases.
+
+## Publishing to NPM
+
+1. Make sure you are [logged in to NPM](https://docs.npmjs.com/cli/v9/commands/npm-login).
+2. Build the plugin:
+
+   ```bash
+   yarn build
+   ```
+
+3. Publish the plugin:
+
+   ```bash
+   yarn publish
+   ```
+
 ## Features
 
 - ✅ Configurable package size field type (integer or float)
@@ -202,3 +254,8 @@ const elasticSearchConfig: ElasticsearchOptions = {
 - ✅ Multi-language labels (English/Swedish)
 - ✅ TypeScript support
 - ✅ Backward compatibility with migration path
+
+## Resources
+
+- [Vendure Plugin Documentation](https://www.vendure.io/docs/plugins/)
+- [GraphQL Code Generator](https://the-guild.dev/graphql/codegen) for generating TypeScript types for custom GraphQL types.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haus-tech/package-size-plugin",
-  "version": "3.0.2",
+  "version": "3.0.4",
   "description": "Package size plugin for Vendure",
   "author": "Haus Tech",
   "repository": {
@@ -11,16 +11,10 @@
   "engines": {
     "node": ">=20.0.0"
   },
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist",
-    "README.md"
-  ],
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
   "scripts": {
-    "start": "yarn ts-node test/dev-server.ts",
-    "build": "rimraf dist && tsc",
-    "test": "jest --preset=\"ts-jest\"",
-    "prepublishOnly": "yarn && yarn build"
-  }
-}
+    "start": "yarn ts-node test/dev-server.ts"
+  },
+  "type": "commonjs"
+}

package/{dist → src}/api/api-extensions.js

@@ -15,3 +15,4 @@ const getShopApiExtensions = (packageSizeFieldType) => {
   `;
 };
 exports.getShopApiExtensions = getShopApiExtensions;
+//# sourceMappingURL=api-extensions.js.map

package/src/api/api-extensions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-extensions.js","sourceRoot":"","sources":["../../../../../packages/package-size-plugin/src/api/api-extensions.ts"],"names":[],"mappings":";;;;;;AAAA,8DAA6B;AAEtB,MAAM,oBAAoB,GAAG,CAAC,oBAAqC,EAAE,EAAE;IAC5E,MAAM,eAAe,GAAG,oBAAoB,KAAK,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAA;IAE1E,OAAO,IAAA,qBAAG,EAAA;;qBAES,eAAe;;;GAGjC,CAAA;AACH,CAAC,CAAA;AATY,QAAA,oBAAoB,wBAShC"}

package/{dist → src}/api/package-size.resolver.js

@@ -45,3 +45,4 @@ exports.ProductVariantEntityResolver = ProductVariantEntityResolver = __decorate
     (0, graphql_1.Resolver)('ProductVariant'),
     __metadata("design:paramtypes", [])
 ], ProductVariantEntityResolver);
+//# sourceMappingURL=package-size.resolver.js.map

package/src/api/package-size.resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-size.resolver.js","sourceRoot":"","sources":["../../../../../packages/package-size-plugin/src/api/package-size.resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,6CAAgE;AAChE,wCAAmE;AAG5D,IAAM,4BAA4B,GAAlC,MAAM,4BAA4B;IACvC,gBAAe,CAAC;IAGhB,WAAW,CAAQ,GAAmB,EAAY,OAAuB;QACvE,OAAO,OAAO,CAAC,YAAY,CAAC,mBAAmB,IAAI,CAAC,CAAA;IACtD,CAAC;IAGD,eAAe,CAAQ,GAAmB,EAAY,OAAuB;QAC3E,OAAO,OAAO,CAAC,YAAY,CAAC,uBAAuB,IAAI,IAAI,CAAA;IAC7D,CAAC;CACF,CAAA;AAZY,oEAA4B;AAIvC;IADC,IAAA,sBAAY,GAAE;IACF,WAAA,IAAA,UAAG,GAAE,CAAA;IAAuB,WAAA,IAAA,gBAAM,GAAE,CAAA;;qCAAzB,qBAAc,EAAqB,qBAAc;;+DAExE;AAGD;IADC,IAAA,sBAAY,GAAE;IACE,WAAA,IAAA,UAAG,GAAE,CAAA;IAAuB,WAAA,IAAA,gBAAM,GAAE,CAAA;;qCAAzB,qBAAc,EAAqB,qBAAc;;mEAE5E;uCAXU,4BAA4B;IADxC,IAAA,kBAAQ,EAAC,gBAAgB,CAAC;;GACd,4BAA4B,CAYxC"}

package/{dist → src}/constants.js

@@ -3,3 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PLUGIN_INIT_OPTIONS = exports.loggerCtx = void 0;
 exports.loggerCtx = 'PackageSizePlugin';
 exports.PLUGIN_INIT_OPTIONS = Symbol('PACKAGE_SIZE_PLUGIN_INIT_OPTIONS');
+//# sourceMappingURL=constants.js.map

package/src/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../packages/package-size-plugin/src/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,SAAS,GAAG,mBAAmB,CAAA;AAC/B,QAAA,mBAAmB,GAAG,MAAM,CAAC,kCAAkC,CAAC,CAAA"}

package/{dist → src}/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./package-size.plugin"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/package-size-plugin/src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC"}

package/{dist → src}/package-size.plugin.js

@@ -60,3 +60,4 @@ class PackageSizePlugin {
     }
 }
 exports.PackageSizePlugin = PackageSizePlugin;
+//# sourceMappingURL=package-size.plugin.js.map

package/src/package-size.plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-size.plugin.js","sourceRoot":"","sources":["../../../../packages/package-size-plugin/src/package-size.plugin.ts"],"names":[],"mappings":";;;;;;;;;AAAA,wCAMsB;AACtB,yDAA2D;AAC3D,uEAA0E;AAyB1E,MAAa,iBAAiB;IACrB,AAAP,MAAM,CAAC,IAAI,CAAC,MAA+B;QACzC,MAAM,SAAS,GAAG,MAAM,CAAC,oBAAoB,IAAI,KAAK,CAAA;QACtD,MAAM,kBAAkB,GAAG,MAAM,CAAC,kBAAkB,IAAI,KAAK,CAAA;QA2C7D,IAAM,wBAAwB,GAA9B,MAAM,wBAAwB;SAAG,CAAA;QAA3B,wBAAwB;YAzC7B,IAAA,oBAAa,EAAC;gBACb,OAAO,EAAE,CAAC,yBAAkB,CAAC;gBAC7B,iBAAiB,EAAE;oBACjB,SAAS,EAAE,CAAC,oDAA4B,CAAC;oBACzC,MAAM,EAAE,IAAA,qCAAoB,EAAC,SAAS,CAAC;iBACxC;gBACD,aAAa,EAAE,CAAC,aAAa,EAAE,EAAE;oBAC/B,MAAM,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,IAAI,CAAA;oBAC9C,MAAM,YAAY,GAAG,SAAS,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;oBAEpD,aAAa,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC;wBAC7C,IAAI,EAAE,qBAAqB;wBAC3B,IAAI,EAAE,SAAS;wBACf,YAAY,EAAE,YAAY;wBAC1B,MAAM,EAAE,KAAK;wBACb,KAAK,EAAE;4BACL,EAAE,YAAY,EAAE,mBAAY,CAAC,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE;4BACxD,EAAE,YAAY,EAAE,mBAAY,CAAC,EAAE,EAAE,KAAK,EAAE,qBAAqB,EAAE;yBAChE;qBACF,CAAC,CAAA;oBAEF,IAAI,kBAAkB,EAAE,CAAC;wBACvB,aAAa,CAAC,YAAY,CAAC,cAAc,CAAC,IAAI,CAAC;4BAC7C,IAAI,EAAE,yBAAyB;4BAC/B,IAAI,EAAE,QAAQ;4BACd,YAAY,EAAE,WAAW;4BACzB,EAAE,EAAE;gCACF,SAAS,EAAE,iBAAiB;6BAC7B;4BACD,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE;gCACL,EAAE,YAAY,EAAE,mBAAY,CAAC,EAAE,EAAE,KAAK,EAAE,mBAAmB,EAAE;gCAC7D,EAAE,YAAY,EAAE,mBAAY,CAAC,EAAE,EAAE,KAAK,EAAE,mBAAmB,EAAE;6BAC9D;yBACF,CAAC,CAAA;oBACJ,CAAC;oBAED,OAAO,aAAa,CAAA;gBACtB,CAAC;gBACD,aAAa,EAAE,QAAQ;aACxB,CAAC;WACI,wBAAwB,CAAG;QAEjC,OAAO,wBAAwB,CAAA;IACjC,CAAC;CACF;AAlDD,8CAkDC"}