medusajs-documents-plugin 1.1.9 → 1.1.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/README.md +10 -8
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
7
7
 
8
8
  ---
9
9
 
10
+ ## [1.1.10] - 2026-10-16
11
+
12
+ ### Documentation & Registration Safeguards
13
+
14
+ - **Installation & Setup Documentation Update**:
15
+ - Corrected `medusa-config.ts` registration snippet in `README.md` to show registration solely within the `plugins: [...]` array.
16
+ - Added a prominent `[!IMPORTANT]` warning cautioning users never to declare the plugin in both `plugins` and `modules`, explaining how Medusa v2's `mergePluginModules` loader overwrites internal model/migration directory paths, causing skipped migrations (`relation "document_settings" does not exist`) and MikroORM `reading 'fork'` runtime exceptions.
17
+
18
+ ---
19
+
10
20
  ## [1.1.9] - 2026-10-16
11
21
 
12
22
  ### Patch Release: PostgreSQL 42P01 Missing Table Resilience & Barcode Generation Support
package/README.md CHANGED
@@ -102,21 +102,23 @@ module.exports = defineConfig({
102
102
  plugins: [
103
103
  {
104
104
  resolve: "medusajs-documents-plugin",
105
- options: {}
105
+ options: {
106
+ // Optional plugin configuration
107
+ }
106
108
  },
107
109
  // other plugins...
108
110
  ],
109
- modules: [
110
- {
111
- key: "documents",
112
- resolve: "medusajs-documents-plugin",
113
- options: {}
114
- }
115
- ]
116
111
  });
117
112
  ```
118
113
 
114
+ > [!IMPORTANT]
115
+ > **DO NOT declare `medusajs-documents-plugin` in `modules: [...]`!**
116
+ > In Medusa v2, plugins should **ONLY** be registered in the `plugins: [...]` array.
117
+ >
118
+ > Declaring the plugin in both `plugins` and `modules` (e.g. `{ key: "documents", resolve: "medusajs-documents-plugin" }`) causes Medusa's module loader (`mergePluginModules`) to overwrite the auto-discovered module directory. This prevents Medusa from finding the models and migrations, leading to `relation "document_settings" does not exist` and MikroORM `reading 'fork'` runtime exceptions.
119
+
119
120
  ### 2. Run Database Migrations
121
+ Run the migrations to create the required tables (`document_settings`, `document_record`, `document_link`):
120
122
  ```bash
121
123
  npx medusa db:migrate
122
124
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "medusajs-documents-plugin",
3
- "version": "1.1.9",
3
+ "version": "1.1.10",
4
4
  "description": "Comprehensive document generation and management module for Medusa v2 with Zoho Books integration, PDFKit fallback, QR codes, shortlinks, multi-channel notifications and unified admin hub.",
5
5
  "author": "Urban Device Care <info@urbandevicecare.co.uk>",
6
6
  "license": "MIT",