@developerx12/invoices-medusa 0.1.2 → 0.1.4
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.
- package/.medusa/server/src/admin/index.js +234 -43
- package/.medusa/server/src/admin/index.mjs +237 -46
- package/.medusa/server/src/api/admin/orders/[id]/credit-invoice/route.js +69 -0
- package/.medusa/server/src/api/admin/orders/[id]/invoice/[invoice_id]/upload/route.js +55 -0
- package/.medusa/server/src/api/admin/orders/[id]/invoice/route.js +43 -0
- package/.medusa/server/src/api/middlewares.js +17 -1
- package/.medusa/server/src/core/classes/pdf-generator/templates/base.js +29 -2
- package/.medusa/server/src/core/classes/pdf-generator/templates/credit-invoice-content.js +2 -2
- package/.medusa/server/src/core/classes/pdf-generator/templates/invoice-content.js +2 -2
- package/.medusa/server/src/modules/invoice/service.js +52 -10
- package/.medusa/server/src/subscribers/payment-refunded-invoice.js +14 -26
- package/.medusa/server/src/utils/order-invoices.js +65 -0
- package/.medusa/server/src/utils/store-invoice-file.js +37 -0
- package/.medusa/server/src/workflows/index.js +4 -2
- package/.medusa/server/src/workflows/steps/replace-invoice-pdf-step.js +7 -12
- package/.medusa/server/src/workflows/steps/upload-invoice-pdf-step.js +4 -13
- package/.medusa/server/src/workflows/upload-invoice-pdf.js +14 -0
- package/README.md +93 -13
- package/package.json +2 -1
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.getOrderInvoiceLinks = getOrderInvoiceLinks;
|
|
7
|
+
exports.findInvoiceByType = findInvoiceByType;
|
|
8
|
+
exports.hasInvoiceForResource = hasInvoiceForResource;
|
|
9
|
+
exports.getOrderRefunds = getOrderRefunds;
|
|
10
|
+
const utils_1 = require("@medusajs/framework/utils");
|
|
11
|
+
const invoice_order_1 = __importDefault(require("../links/invoice-order"));
|
|
12
|
+
/**
|
|
13
|
+
* All invoices that are linked to an order.
|
|
14
|
+
*/
|
|
15
|
+
async function getOrderInvoiceLinks(container, orderId) {
|
|
16
|
+
const query = container.resolve(utils_1.ContainerRegistrationKeys.QUERY);
|
|
17
|
+
const { data } = await query.graph({
|
|
18
|
+
entity: invoice_order_1.default.entryPoint,
|
|
19
|
+
fields: [
|
|
20
|
+
"invoice_id",
|
|
21
|
+
"created_at",
|
|
22
|
+
"invoice.id",
|
|
23
|
+
"invoice.resource_id",
|
|
24
|
+
"invoice.type",
|
|
25
|
+
"invoice.display_id",
|
|
26
|
+
"invoice.created_at",
|
|
27
|
+
],
|
|
28
|
+
filters: {
|
|
29
|
+
order_id: orderId,
|
|
30
|
+
},
|
|
31
|
+
});
|
|
32
|
+
return (data ?? []);
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* The most recent invoice of the given type ("debit" | "credit").
|
|
36
|
+
*/
|
|
37
|
+
function findInvoiceByType(links, type) {
|
|
38
|
+
return links
|
|
39
|
+
.filter((l) => l.invoice?.type === type)
|
|
40
|
+
.sort((a, b) => new Date(b.invoice?.created_at ?? 0).getTime() -
|
|
41
|
+
new Date(a.invoice?.created_at ?? 0).getTime())[0];
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* Whether an invoice already exists for the given resource (a refund id).
|
|
45
|
+
*/
|
|
46
|
+
function hasInvoiceForResource(links, resourceId) {
|
|
47
|
+
return links.some((l) => l.invoice?.resource_id === resourceId);
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* All refunds of an order, across all payment collections.
|
|
51
|
+
*/
|
|
52
|
+
async function getOrderRefunds(container, orderId) {
|
|
53
|
+
const query = container.resolve(utils_1.ContainerRegistrationKeys.QUERY);
|
|
54
|
+
const { data: [order], } = await query.graph({
|
|
55
|
+
entity: "order",
|
|
56
|
+
fields: ["id", "payment_collections.payments.refunds.*"],
|
|
57
|
+
filters: {
|
|
58
|
+
id: orderId,
|
|
59
|
+
},
|
|
60
|
+
}, { throwIfKeyNotFound: true });
|
|
61
|
+
return (order?.payment_collections ?? [])
|
|
62
|
+
.flatMap((pc) => pc.payments ?? [])
|
|
63
|
+
.flatMap((payment) => payment.refunds ?? []);
|
|
64
|
+
}
|
|
65
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib3JkZXItaW52b2ljZXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvdXRpbHMvb3JkZXItaW52b2ljZXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUF5QkEsb0RBdUJDO0FBS0QsOENBV0M7QUFLRCxzREFLQztBQUtELDBDQXNCQztBQXJHRCxxREFBbUU7QUFDbkUsMkVBQXFEO0FBcUJyRDs7R0FFRztBQUNJLEtBQUssVUFBVSxvQkFBb0IsQ0FDeEMsU0FBUyxFQUNULE9BQWU7SUFFZixNQUFNLEtBQUssR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDLGlDQUF5QixDQUFDLEtBQUssQ0FBQyxDQUFBO0lBRWhFLE1BQU0sRUFBQyxJQUFJLEVBQUMsR0FBRyxNQUFNLEtBQUssQ0FBQyxLQUFLLENBQUM7UUFDL0IsTUFBTSxFQUFFLHVCQUFnQixDQUFDLFVBQVU7UUFDbkMsTUFBTSxFQUFFO1lBQ04sWUFBWTtZQUNaLFlBQVk7WUFDWixZQUFZO1lBQ1oscUJBQXFCO1lBQ3JCLGNBQWM7WUFDZCxvQkFBb0I7WUFDcEIsb0JBQW9CO1NBQ3JCO1FBQ0QsT0FBTyxFQUFFO1lBQ1AsUUFBUSxFQUFFLE9BQU87U0FDbEI7S0FDRixDQUFDLENBQUE7SUFFRixPQUFPLENBQUMsSUFBSSxJQUFJLEVBQUUsQ0FBdUIsQ0FBQTtBQUMzQyxDQUFDO0FBRUQ7O0dBRUc7QUFDSCxTQUFnQixpQkFBaUIsQ0FDL0IsS0FBeUIsRUFDekIsSUFBd0I7SUFFeEIsT0FBTyxLQUFLO1NBQ1QsTUFBTSxDQUFDLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDLENBQUMsT0FBTyxFQUFFLElBQUksS0FBSyxJQUFJLENBQUM7U0FDdkMsSUFBSSxDQUNILENBQUMsQ0FBQyxFQUFFLENBQUMsRUFBRSxFQUFFLENBQ1AsSUFBSSxJQUFJLENBQUMsQ0FBQyxDQUFDLE9BQU8sRUFBRSxVQUFVLElBQUksQ0FBQyxDQUFDLENBQUMsT0FBTyxFQUFFO1FBQzlDLElBQUksSUFBSSxDQUFDLENBQUMsQ0FBQyxPQUFPLEVBQUUsVUFBVSxJQUFJLENBQUMsQ0FBQyxDQUFDLE9BQU8sRUFBRSxDQUNqRCxDQUFDLENBQUMsQ0FBQyxDQUFBO0FBQ1IsQ0FBQztBQUVEOztHQUVHO0FBQ0gsU0FBZ0IscUJBQXFCLENBQ25DLEtBQXlCLEVBQ3pCLFVBQWtCO0lBRWxCLE9BQU8sS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQyxDQUFDLE9BQU8sRUFBRSxXQUFXLEtBQUssVUFBVSxDQUFDLENBQUE7QUFDakUsQ0FBQztBQUVEOztHQUVHO0FBQ0ksS0FBSyxVQUFVLGVBQWUsQ0FDbkMsU0FBUyxFQUNULE9BQWU7SUFFZixNQUFNLEtBQUssR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDLGlDQUF5QixDQUFDLEtBQUssQ0FBQyxDQUFBO0lBRWhFLE1BQU0sRUFDSixJQUFJLEVBQUUsQ0FBQyxLQUFLLENBQUMsR0FDZCxHQUFHLE1BQU0sS0FBSyxDQUFDLEtBQUssQ0FDbkI7UUFDRSxNQUFNLEVBQUUsT0FBTztRQUNmLE1BQU0sRUFBRSxDQUFDLElBQUksRUFBRSx3Q0FBd0MsQ0FBQztRQUN4RCxPQUFPLEVBQUU7WUFDUCxFQUFFLEVBQUUsT0FBTztTQUNaO0tBQ0YsRUFDRCxFQUFDLGtCQUFrQixFQUFFLElBQUksRUFBQyxDQUMzQixDQUFBO0lBRUQsT0FBTyxDQUFDLEtBQUssRUFBRSxtQkFBbUIsSUFBSSxFQUFFLENBQUM7U0FDdEMsT0FBTyxDQUFDLENBQUMsRUFBRSxFQUFFLEVBQUUsQ0FBQyxFQUFFLENBQUMsUUFBUSxJQUFJLEVBQUUsQ0FBQztTQUNsQyxPQUFPLENBQUMsQ0FBQyxPQUFPLEVBQUUsRUFBRSxDQUFDLE9BQU8sQ0FBQyxPQUFPLElBQUksRUFBRSxDQUFrQixDQUFBO0FBQ2pFLENBQUMifQ==
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.storePrivatePdf = storePrivatePdf;
|
|
4
|
+
exports.deleteStoredFile = deleteStoredFile;
|
|
5
|
+
const utils_1 = require("@medusajs/framework/utils");
|
|
6
|
+
/**
|
|
7
|
+
* Stores a PDF in the file module as a private file and returns the created
|
|
8
|
+
* file. The file id is the storage key (e.g. "invoices/invoice-42.pdf").
|
|
9
|
+
*/
|
|
10
|
+
async function storePrivatePdf(container, fileName, base64Content) {
|
|
11
|
+
const fileModuleService = container.resolve(utils_1.Modules.FILE);
|
|
12
|
+
const [file] = await fileModuleService.createFiles([
|
|
13
|
+
{
|
|
14
|
+
filename: fileName,
|
|
15
|
+
mimeType: "application/pdf",
|
|
16
|
+
content: base64Content,
|
|
17
|
+
access: "private",
|
|
18
|
+
},
|
|
19
|
+
]);
|
|
20
|
+
return file;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Removes a stored file. Missing files are ignored.
|
|
24
|
+
*/
|
|
25
|
+
async function deleteStoredFile(container, fileId) {
|
|
26
|
+
if (!fileId) {
|
|
27
|
+
return;
|
|
28
|
+
}
|
|
29
|
+
const fileModuleService = container.resolve(utils_1.Modules.FILE);
|
|
30
|
+
try {
|
|
31
|
+
await fileModuleService.deleteFiles([fileId]);
|
|
32
|
+
}
|
|
33
|
+
catch {
|
|
34
|
+
// The file might have been removed already.
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3RvcmUtaW52b2ljZS1maWxlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL3V0aWxzL3N0b3JlLWludm9pY2UtZmlsZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQU1BLDBDQWlCQztBQUtELDRDQVlDO0FBeENELHFEQUFpRDtBQUVqRDs7O0dBR0c7QUFDSSxLQUFLLFVBQVUsZUFBZSxDQUNuQyxTQUFTLEVBQ1QsUUFBZ0IsRUFDaEIsYUFBcUI7SUFFckIsTUFBTSxpQkFBaUIsR0FBRyxTQUFTLENBQUMsT0FBTyxDQUFDLGVBQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQTtJQUV6RCxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsTUFBTSxpQkFBaUIsQ0FBQyxXQUFXLENBQUM7UUFDakQ7WUFDRSxRQUFRLEVBQUUsUUFBUTtZQUNsQixRQUFRLEVBQUUsaUJBQWlCO1lBQzNCLE9BQU8sRUFBRSxhQUFhO1lBQ3RCLE1BQU0sRUFBRSxTQUFTO1NBQ2xCO0tBQ0YsQ0FBQyxDQUFBO0lBRUYsT0FBTyxJQUFJLENBQUE7QUFDYixDQUFDO0FBRUQ7O0dBRUc7QUFDSSxLQUFLLFVBQVUsZ0JBQWdCLENBQUMsU0FBUyxFQUFFLE1BQWM7SUFDOUQsSUFBSSxDQUFDLE1BQU0sRUFBRSxDQUFDO1FBQ1osT0FBTTtJQUNSLENBQUM7SUFFRCxNQUFNLGlCQUFpQixHQUFHLFNBQVMsQ0FBQyxPQUFPLENBQUMsZUFBTyxDQUFDLElBQUksQ0FBQyxDQUFBO0lBRXpELElBQUksQ0FBQztRQUNILE1BQU0saUJBQWlCLENBQUMsV0FBVyxDQUFDLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQTtJQUMvQyxDQUFDO0lBQUMsTUFBTSxDQUFDO1FBQ1AsNENBQTRDO0lBQzlDLENBQUM7QUFDSCxDQUFDIn0=
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.refreshInvoicePdfWorkflow = exports.generateInvoicePdfWorkflow = exports.createCreditInvoiceWorkflow = exports.createInvoiceWorkflow = void 0;
|
|
3
|
+
exports.uploadInvoicePdfWorkflow = exports.refreshInvoicePdfWorkflow = exports.generateInvoicePdfWorkflow = exports.createCreditInvoiceWorkflow = exports.createInvoiceWorkflow = void 0;
|
|
4
4
|
var create_invoice_1 = require("./create-invoice");
|
|
5
5
|
Object.defineProperty(exports, "createInvoiceWorkflow", { enumerable: true, get: function () { return create_invoice_1.createInvoiceWorkflow; } });
|
|
6
6
|
var create_credit_invoice_1 = require("./create-credit-invoice");
|
|
@@ -9,4 +9,6 @@ var generate_invoice_pdf_1 = require("./generate-invoice-pdf");
|
|
|
9
9
|
Object.defineProperty(exports, "generateInvoicePdfWorkflow", { enumerable: true, get: function () { return generate_invoice_pdf_1.generateInvoicePdfWorkflow; } });
|
|
10
10
|
var refresh_invoice_pdf_1 = require("./refresh-invoice-pdf");
|
|
11
11
|
Object.defineProperty(exports, "refreshInvoicePdfWorkflow", { enumerable: true, get: function () { return refresh_invoice_pdf_1.refreshInvoicePdfWorkflow; } });
|
|
12
|
-
|
|
12
|
+
var upload_invoice_pdf_1 = require("./upload-invoice-pdf");
|
|
13
|
+
Object.defineProperty(exports, "uploadInvoicePdfWorkflow", { enumerable: true, get: function () { return upload_invoice_pdf_1.uploadInvoicePdfWorkflow; } });
|
|
14
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvd29ya2Zsb3dzL2luZGV4LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLG1EQUF3RDtBQUEvQyx1SEFBQSxxQkFBcUIsT0FBQTtBQUM5QixpRUFBcUU7QUFBNUQsb0lBQUEsMkJBQTJCLE9BQUE7QUFDcEMsK0RBQW1FO0FBQTFELGtJQUFBLDBCQUEwQixPQUFBO0FBQ25DLDZEQUFpRTtBQUF4RCxnSUFBQSx5QkFBeUIsT0FBQTtBQUNsQywyREFBK0Q7QUFBdEQsOEhBQUEsd0JBQXdCLE9BQUEifQ==
|
|
@@ -3,33 +3,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.replaceInvoicePdfStep = void 0;
|
|
4
4
|
const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
|
|
5
5
|
const invoice_1 = require("../../modules/invoice");
|
|
6
|
-
const
|
|
6
|
+
const store_invoice_file_1 = require("../../utils/store-invoice-file");
|
|
7
7
|
exports.replaceInvoicePdfStep = (0, workflows_sdk_1.createStep)("replace-invoice-pdf-step", async ({ invoice_id, file_name, data }, { container }) => {
|
|
8
|
-
const fileModuleService = container.resolve(utils_1.Modules.FILE);
|
|
9
8
|
const invoiceModule = container.resolve(invoice_1.INVOICE_MODULE);
|
|
10
9
|
const invoice = await invoiceModule.retrieveInvoice(invoice_id);
|
|
11
10
|
const previousFileId = invoice.pdf_url ?? null;
|
|
12
|
-
const
|
|
13
|
-
{
|
|
14
|
-
filename: `invoices/${file_name}`,
|
|
15
|
-
mimeType: "application/pdf",
|
|
16
|
-
content: data,
|
|
17
|
-
access: "private",
|
|
18
|
-
},
|
|
19
|
-
]);
|
|
11
|
+
const file = await (0, store_invoice_file_1.storePrivatePdf)(container, `invoices/${file_name}`, data);
|
|
20
12
|
await invoiceModule.updateInvoices({ id: invoice_id, pdf_url: file.id });
|
|
21
13
|
return new workflows_sdk_1.StepResponse(file.id, {
|
|
22
14
|
invoice_id,
|
|
15
|
+
file_id: file.id,
|
|
23
16
|
previous_file_id: previousFileId,
|
|
24
17
|
});
|
|
25
18
|
}, async (rollbackData, { container }) => {
|
|
26
19
|
if (!rollbackData)
|
|
27
20
|
return;
|
|
28
|
-
const { invoice_id, previous_file_id } = rollbackData;
|
|
21
|
+
const { invoice_id, file_id, previous_file_id } = rollbackData;
|
|
29
22
|
const invoiceModule = container.resolve(invoice_1.INVOICE_MODULE);
|
|
30
23
|
await invoiceModule.updateInvoices({
|
|
31
24
|
id: invoice_id,
|
|
32
25
|
pdf_url: previous_file_id,
|
|
33
26
|
});
|
|
27
|
+
// Clean up the newly uploaded file, it is no longer referenced.
|
|
28
|
+
await (0, store_invoice_file_1.deleteStoredFile)(container, file_id);
|
|
34
29
|
});
|
|
35
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
30
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVwbGFjZS1pbnZvaWNlLXBkZi1zdGVwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vLi4vc3JjL3dvcmtmbG93cy9zdGVwcy9yZXBsYWNlLWludm9pY2UtcGRmLXN0ZXAudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEscUVBQTBFO0FBQzFFLG1EQUFvRDtBQUVwRCx1RUFBZ0Y7QUFRbkUsUUFBQSxxQkFBcUIsR0FBRyxJQUFBLDBCQUFVLEVBQzdDLDBCQUEwQixFQUMxQixLQUFLLEVBQ0gsRUFBQyxVQUFVLEVBQUUsU0FBUyxFQUFFLElBQUksRUFBNkIsRUFDekQsRUFBQyxTQUFTLEVBQUMsRUFDWCxFQUFFO0lBQ0YsTUFBTSxhQUFhLEdBQXlCLFNBQVMsQ0FBQyxPQUFPLENBQUMsd0JBQWMsQ0FBQyxDQUFBO0lBRTdFLE1BQU0sT0FBTyxHQUFHLE1BQU0sYUFBYSxDQUFDLGVBQWUsQ0FBQyxVQUFVLENBQUMsQ0FBQTtJQUMvRCxNQUFNLGNBQWMsR0FBRyxPQUFPLENBQUMsT0FBTyxJQUFJLElBQUksQ0FBQTtJQUU5QyxNQUFNLElBQUksR0FBRyxNQUFNLElBQUEsb0NBQWUsRUFBQyxTQUFTLEVBQUUsWUFBWSxTQUFTLEVBQUUsRUFBRSxJQUFJLENBQUMsQ0FBQTtJQUU1RSxNQUFNLGFBQWEsQ0FBQyxjQUFjLENBQUMsRUFBQyxFQUFFLEVBQUUsVUFBVSxFQUFFLE9BQU8sRUFBRSxJQUFJLENBQUMsRUFBRSxFQUFDLENBQUMsQ0FBQTtJQUV0RSxPQUFPLElBQUksNEJBQVksQ0FBQyxJQUFJLENBQUMsRUFBRSxFQUFFO1FBQy9CLFVBQVU7UUFDVixPQUFPLEVBQUUsSUFBSSxDQUFDLEVBQUU7UUFDaEIsZ0JBQWdCLEVBQUUsY0FBYztLQUNqQyxDQUFDLENBQUE7QUFDSixDQUFDLEVBQ0QsS0FBSyxFQUNILFlBRWEsRUFDYixFQUFDLFNBQVMsRUFBQyxFQUNYLEVBQUU7SUFDRixJQUFJLENBQUMsWUFBWTtRQUFFLE9BQU07SUFDekIsTUFBTSxFQUFDLFVBQVUsRUFBRSxPQUFPLEVBQUUsZ0JBQWdCLEVBQUMsR0FBRyxZQUFZLENBQUE7SUFFNUQsTUFBTSxhQUFhLEdBQXlCLFNBQVMsQ0FBQyxPQUFPLENBQUMsd0JBQWMsQ0FBQyxDQUFBO0lBRTdFLE1BQU0sYUFBYSxDQUFDLGNBQWMsQ0FBQztRQUNqQyxFQUFFLEVBQUUsVUFBVTtRQUNkLE9BQU8sRUFBRSxnQkFBZ0I7S0FDMUIsQ0FBQyxDQUFBO0lBRUYsZ0VBQWdFO0lBQ2hFLE1BQU0sSUFBQSxxQ0FBZ0IsRUFBQyxTQUFTLEVBQUUsT0FBTyxDQUFDLENBQUE7QUFDNUMsQ0FBQyxDQUNGLENBQUEifQ==
|
|
@@ -3,27 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.uploadInvoicePdfStep = void 0;
|
|
4
4
|
const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
|
|
5
5
|
const invoice_1 = require("../../modules/invoice");
|
|
6
|
-
const
|
|
6
|
+
const store_invoice_file_1 = require("../../utils/store-invoice-file");
|
|
7
7
|
exports.uploadInvoicePdfStep = (0, workflows_sdk_1.createStep)("upload-invoice-pdf-step", async ({ invoice_id, file_name, data }, { container }) => {
|
|
8
|
-
const fileModuleService = container.resolve(utils_1.Modules.FILE);
|
|
9
8
|
const invoiceModule = container.resolve(invoice_1.INVOICE_MODULE);
|
|
10
|
-
const
|
|
11
|
-
{
|
|
12
|
-
filename: `invoices/${file_name}`,
|
|
13
|
-
mimeType: "application/pdf",
|
|
14
|
-
content: data,
|
|
15
|
-
access: "private",
|
|
16
|
-
},
|
|
17
|
-
]);
|
|
9
|
+
const file = await (0, store_invoice_file_1.storePrivatePdf)(container, `invoices/${file_name}`, data);
|
|
18
10
|
await invoiceModule.updateInvoices({ id: invoice_id, pdf_url: file.id });
|
|
19
11
|
return new workflows_sdk_1.StepResponse(file.id, { invoice_id, file_id: file.id });
|
|
20
12
|
}, async (rollbackData, { container }) => {
|
|
21
13
|
if (!rollbackData)
|
|
22
14
|
return;
|
|
23
15
|
const { invoice_id, file_id } = rollbackData;
|
|
24
|
-
const fileModuleService = container.resolve(utils_1.Modules.FILE);
|
|
25
16
|
const invoiceModule = container.resolve(invoice_1.INVOICE_MODULE);
|
|
26
|
-
await fileModuleService.deleteFiles([file_id]);
|
|
27
17
|
await invoiceModule.updateInvoices({ id: invoice_id, pdf_url: null });
|
|
18
|
+
await (0, store_invoice_file_1.deleteStoredFile)(container, file_id);
|
|
28
19
|
});
|
|
29
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
20
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXBsb2FkLWludm9pY2UtcGRmLXN0ZXAuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi8uLi9zcmMvd29ya2Zsb3dzL3N0ZXBzL3VwbG9hZC1pbnZvaWNlLXBkZi1zdGVwLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLHFFQUEwRTtBQUMxRSxtREFBb0Q7QUFFcEQsdUVBQWdGO0FBUW5FLFFBQUEsb0JBQW9CLEdBQUcsSUFBQSwwQkFBVSxFQUM1Qyx5QkFBeUIsRUFDekIsS0FBSyxFQUFFLEVBQUMsVUFBVSxFQUFFLFNBQVMsRUFBRSxJQUFJLEVBQTRCLEVBQUUsRUFBQyxTQUFTLEVBQUMsRUFBRSxFQUFFO0lBQzlFLE1BQU0sYUFBYSxHQUF5QixTQUFTLENBQUMsT0FBTyxDQUFDLHdCQUFjLENBQUMsQ0FBQTtJQUU3RSxNQUFNLElBQUksR0FBRyxNQUFNLElBQUEsb0NBQWUsRUFBQyxTQUFTLEVBQUUsWUFBWSxTQUFTLEVBQUUsRUFBRSxJQUFJLENBQUMsQ0FBQTtJQUU1RSxNQUFNLGFBQWEsQ0FBQyxjQUFjLENBQUMsRUFBQyxFQUFFLEVBQUUsVUFBVSxFQUFFLE9BQU8sRUFBRSxJQUFJLENBQUMsRUFBRSxFQUFDLENBQUMsQ0FBQTtJQUV0RSxPQUFPLElBQUksNEJBQVksQ0FBQyxJQUFJLENBQUMsRUFBRSxFQUFFLEVBQUMsVUFBVSxFQUFFLE9BQU8sRUFBRSxJQUFJLENBQUMsRUFBRSxFQUFDLENBQUMsQ0FBQTtBQUNsRSxDQUFDLEVBQ0QsS0FBSyxFQUNILFlBQStELEVBQy9ELEVBQUMsU0FBUyxFQUFDLEVBQ1gsRUFBRTtJQUNGLElBQUksQ0FBQyxZQUFZO1FBQUUsT0FBTTtJQUN6QixNQUFNLEVBQUMsVUFBVSxFQUFFLE9BQU8sRUFBQyxHQUFHLFlBQVksQ0FBQTtJQUUxQyxNQUFNLGFBQWEsR0FBeUIsU0FBUyxDQUFDLE9BQU8sQ0FBQyx3QkFBYyxDQUFDLENBQUE7SUFFN0UsTUFBTSxhQUFhLENBQUMsY0FBYyxDQUFDLEVBQUMsRUFBRSxFQUFFLFVBQVUsRUFBRSxPQUFPLEVBQUUsSUFBSSxFQUFDLENBQUMsQ0FBQTtJQUNuRSxNQUFNLElBQUEscUNBQWdCLEVBQUMsU0FBUyxFQUFFLE9BQU8sQ0FBQyxDQUFBO0FBQzVDLENBQUMsQ0FDRixDQUFBIn0=
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.uploadInvoicePdfWorkflow = void 0;
|
|
4
|
+
const workflows_sdk_1 = require("@medusajs/framework/workflows-sdk");
|
|
5
|
+
const replace_invoice_pdf_step_1 = require("./steps/replace-invoice-pdf-step");
|
|
6
|
+
/**
|
|
7
|
+
* Replaces the PDF of an existing invoice with an externally provided file
|
|
8
|
+
* (e.g. a manually uploaded invoice document).
|
|
9
|
+
*/
|
|
10
|
+
exports.uploadInvoicePdfWorkflow = (0, workflows_sdk_1.createWorkflow)("upload-invoice-pdf", function (input) {
|
|
11
|
+
const fileId = (0, replace_invoice_pdf_step_1.replaceInvoicePdfStep)(input);
|
|
12
|
+
return new workflows_sdk_1.WorkflowResponse({ file_id: fileId });
|
|
13
|
+
});
|
|
14
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidXBsb2FkLWludm9pY2UtcGRmLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL3dvcmtmbG93cy91cGxvYWQtaW52b2ljZS1wZGYudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEscUVBRzBDO0FBQzFDLCtFQUFzRTtBQVd0RTs7O0dBR0c7QUFDVSxRQUFBLHdCQUF3QixHQUFHLElBQUEsOEJBQWMsRUFDcEQsb0JBQW9CLEVBQ3BCLFVBQVUsS0FBb0M7SUFDNUMsTUFBTSxNQUFNLEdBQUcsSUFBQSxnREFBcUIsRUFBQyxLQUFLLENBQUMsQ0FBQTtJQUUzQyxPQUFPLElBQUksZ0NBQWdCLENBQUMsRUFBQyxPQUFPLEVBQUUsTUFBTSxFQUFDLENBQUMsQ0FBQTtBQUNoRCxDQUFDLENBQ0YsQ0FBQSJ9
|
package/README.md
CHANGED
|
@@ -15,36 +15,70 @@ pnpm add @developerx12/invoices-medusa
|
|
|
15
15
|
|
|
16
16
|
## Configuration
|
|
17
17
|
|
|
18
|
-
Register the plugin in `medusa-config.ts
|
|
18
|
+
Register the plugin in `medusa-config.ts`. Every company value falls back
|
|
19
|
+
to an environment variable, so the minimal setup is:
|
|
19
20
|
|
|
20
21
|
```ts
|
|
21
22
|
import { defineConfig } from "@medusajs/framework/utils"
|
|
22
23
|
|
|
24
|
+
export default defineConfig({
|
|
25
|
+
plugins: [
|
|
26
|
+
{
|
|
27
|
+
resolve: "@developerx12/invoices-medusa",
|
|
28
|
+
options: {
|
|
29
|
+
// Optional: accent colors used in table headers
|
|
30
|
+
colors: {
|
|
31
|
+
background: "#004534", // header cell fill (default: #000)
|
|
32
|
+
text: "#ffffff", // header cell text (default: #fff)
|
|
33
|
+
},
|
|
34
|
+
},
|
|
35
|
+
},
|
|
36
|
+
],
|
|
37
|
+
})
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Explicit options always override the environment. To override a value, pass
|
|
41
|
+
it as before:
|
|
42
|
+
|
|
43
|
+
```ts
|
|
23
44
|
export default defineConfig({
|
|
24
45
|
plugins: [
|
|
25
46
|
{
|
|
26
47
|
resolve: "@developerx12/invoices-medusa",
|
|
27
48
|
options: {
|
|
28
49
|
// Optional: locale to fall back to when order.metadata.locale is absent
|
|
29
|
-
// or not a supported value. Defaults to "
|
|
50
|
+
// or not a supported value. Defaults to "en".
|
|
51
|
+
// Env fallback: INVOICE_DEFAULT_LOCALE
|
|
30
52
|
defaultLocale: "en",
|
|
31
53
|
|
|
32
54
|
addressInfo: {
|
|
33
|
-
// Optional: SVG string or base64 data URL
|
|
55
|
+
// Optional: inline SVG string or base64 data URL rendered as the
|
|
56
|
+
// default page header when `header` is not provided.
|
|
57
|
+
// Env fallback: COMPANY_LOGO
|
|
34
58
|
companyLogo: "<svg>...</svg>",
|
|
35
59
|
// Optional: rendered width of the logo in points (default: 110)
|
|
60
|
+
// Env fallback: COMPANY_LOGO_WIDTH
|
|
36
61
|
companyLogoWidth: 110,
|
|
37
62
|
|
|
63
|
+
// Env fallback: COMPANY_NAME
|
|
38
64
|
companyName: "Acme B.V.",
|
|
39
65
|
|
|
40
66
|
// Receives the i18n countries object for the resolved locale so you
|
|
41
67
|
// can include a translated country name in the address block.
|
|
68
|
+
// Default: built from COMPANY_ADDRESS_LINE_1, COMPANY_ADDRESS_LINE_2,
|
|
69
|
+
// COMPANY_POSTAL_CODE and COMPANY_CITY.
|
|
42
70
|
address: (countries) =>
|
|
43
71
|
`Streetname 1\n1234 AB Amsterdam, ${countries.nl}`,
|
|
44
72
|
|
|
73
|
+
// Optional (e.g. not used in India).
|
|
74
|
+
// Env fallback: COMPANY_COC_NUMBER
|
|
45
75
|
cocNumber: "12345678",
|
|
76
|
+
// Env fallback: COMPANY_GSTIN
|
|
46
77
|
vatNumber: "NL123456789B01",
|
|
78
|
+
// Optional: only shown on tax-exclusive orders.
|
|
79
|
+
// Env fallback: COMPANY_IBAN
|
|
47
80
|
iban: "NL00BANK0123456789",
|
|
81
|
+
// Env fallback: COMPANY_EMAIL
|
|
48
82
|
email: "billing@example.com",
|
|
49
83
|
},
|
|
50
84
|
|
|
@@ -82,15 +116,15 @@ export default defineConfig({
|
|
|
82
116
|
|
|
83
117
|
| Option | Type | Required | Description |
|
|
84
118
|
|---|---|---|---|
|
|
85
|
-
| `defaultLocale` | `Locale` | No | Fallback locale when `order.metadata.locale` is absent or invalid. Defaults to `"
|
|
86
|
-
| `addressInfo.companyName` | `string` |
|
|
87
|
-
| `addressInfo.address` | `(countries: Record<string, string>) => string` |
|
|
88
|
-
| `addressInfo.cocNumber` | `string` |
|
|
89
|
-
| `addressInfo.vatNumber` | `string` |
|
|
90
|
-
| `addressInfo.iban` | `string` |
|
|
91
|
-
| `addressInfo.email` | `string` |
|
|
92
|
-
| `addressInfo.companyLogo` | `string` | No | SVG string or data URL
|
|
93
|
-
| `addressInfo.companyLogoWidth` | `number` | No | Rendered logo width in points. |
|
|
119
|
+
| `defaultLocale` | `Locale` | No | Fallback locale when `order.metadata.locale` is absent or invalid. Env: `INVOICE_DEFAULT_LOCALE`. Defaults to `"en"`. |
|
|
120
|
+
| `addressInfo.companyName` | `string` | No | Company name shown on the invoice. Env: `COMPANY_NAME`. |
|
|
121
|
+
| `addressInfo.address` | `(countries: Record<string, string>) => string` | No | Function returning the company address. Receives the i18n country name map for the resolved locale. Default: built from `COMPANY_ADDRESS_LINE_1`, `COMPANY_ADDRESS_LINE_2`, `COMPANY_POSTAL_CODE`, `COMPANY_CITY`. |
|
|
122
|
+
| `addressInfo.cocNumber` | `string` | No | Chamber of Commerce number. Env: `COMPANY_COC_NUMBER`. Omit/empty hides the row (e.g. India). |
|
|
123
|
+
| `addressInfo.vatNumber` | `string` | No | VAT registration number (GSTIN). Env: `COMPANY_GSTIN`. |
|
|
124
|
+
| `addressInfo.iban` | `string` | No | Bank account number, shown on tax-exclusive orders only. Env: `COMPANY_IBAN`. |
|
|
125
|
+
| `addressInfo.email` | `string` | No | Billing contact e-mail. Env: `COMPANY_EMAIL`. |
|
|
126
|
+
| `addressInfo.companyLogo` | `string` | No | Inline SVG string or data URL rendered as the default page header when `header` is not set. Env: `COMPANY_LOGO`. Remote URLs are ignored. |
|
|
127
|
+
| `addressInfo.companyLogoWidth` | `number` | No | Rendered logo width in points. Env: `COMPANY_LOGO_WIDTH`. |
|
|
94
128
|
| `colors.background` | `string` | No | Table header fill color (CSS hex). |
|
|
95
129
|
| `colors.text` | `string` | No | Table header text color (CSS hex). |
|
|
96
130
|
| `header` | `Content` | No | pdfmake content block rendered as page header. Replaces the default logo header. |
|
|
@@ -151,6 +185,32 @@ POST /admin/orders/:id/invoice/:invoice_id
|
|
|
151
185
|
|
|
152
186
|
Requires admin authentication. Regenerates the invoice PDF.
|
|
153
187
|
|
|
188
|
+
```
|
|
189
|
+
POST /admin/orders/:id/invoice
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
Requires admin authentication. Manually creates a new (debit) invoice for the order, including the PDF. Useful when the automatic invoice creation is disabled or did not run. The invoice is created by the same `createInvoiceWorkflow` that the subscribers use. An order can only have one debit invoice, so the request is rejected when the order already has one.
|
|
193
|
+
|
|
194
|
+
```
|
|
195
|
+
POST /admin/orders/:id/credit-invoice
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
Requires admin authentication. Manually creates a (credit) invoice for the order. A credit invoice is always based on a refund:
|
|
199
|
+
|
|
200
|
+
- `refund_id` (optional): the refund to credit. When omitted, the most recent refund of the order is used.
|
|
201
|
+
- When the order has no debit invoice yet, one is created first so the credit invoice has a parent invoice to reference.
|
|
202
|
+
- Fails when a credit invoice already exists for the selected refund.
|
|
203
|
+
|
|
204
|
+
```json
|
|
205
|
+
{ "refund_id": "ref_123" }
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
```
|
|
209
|
+
POST /admin/orders/:id/invoice/:invoice_id/upload
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
Requires admin authentication. Uploads a PDF for an existing invoice. The uploaded file **replaces** the generated PDF of the invoice — nothing else about the invoice changes. The request must be `multipart/form-data` with a `file` field (PDF only, max 20MB). The file is stored as a private file in the file module, exactly like the generated PDFs.
|
|
213
|
+
|
|
154
214
|
### Store
|
|
155
215
|
|
|
156
216
|
```
|
|
@@ -173,7 +233,10 @@ The plugin includes an admin widget that displays on the order details page (`or
|
|
|
173
233
|
- Lists all invoices (debit and credit) for the order
|
|
174
234
|
- Shows invoice type with colored badges (gray for debit, green for credit)
|
|
175
235
|
- Download button fetches PDF via API and triggers browser download
|
|
176
|
-
- Refresh button regenerates the invoice PDF
|
|
236
|
+
- Refresh button regenerates the invoice PDF from the order
|
|
237
|
+
- Upload button replaces the PDF of an invoice with an uploaded PDF file
|
|
238
|
+
- **Generate invoice** button creates the invoice for the order manually. An order can only have one debit invoice, so the button is disabled when the order already has one.
|
|
239
|
+
- **Credit invoice** button creates a credit invoice for one of the refunds of the order
|
|
177
240
|
|
|
178
241
|
## Workflows
|
|
179
242
|
|
|
@@ -185,6 +248,7 @@ import {
|
|
|
185
248
|
createCreditInvoiceWorkflow,
|
|
186
249
|
generateInvoicePdfWorkflow,
|
|
187
250
|
refreshInvoicePdfWorkflow,
|
|
251
|
+
uploadInvoicePdfWorkflow,
|
|
188
252
|
} from "@developerx12/invoices-medusa/workflows"
|
|
189
253
|
```
|
|
190
254
|
|
|
@@ -243,6 +307,22 @@ const { result } = await refreshInvoicePdfWorkflow(container).run({
|
|
|
243
307
|
// result.file_id — the new file ID
|
|
244
308
|
```
|
|
245
309
|
|
|
310
|
+
### `uploadInvoicePdfWorkflow`
|
|
311
|
+
|
|
312
|
+
Replaces the PDF of an existing invoice with an externally provided file (e.g. a manually uploaded invoice document).
|
|
313
|
+
|
|
314
|
+
```ts
|
|
315
|
+
const { result } = await uploadInvoicePdfWorkflow(container).run({
|
|
316
|
+
input: {
|
|
317
|
+
invoice_id: "inv_01J...",
|
|
318
|
+
file_name: "invoice-42.pdf",
|
|
319
|
+
data: "<base64 encoded pdf>", // base64-encoded file content
|
|
320
|
+
},
|
|
321
|
+
})
|
|
322
|
+
|
|
323
|
+
// result.file_id — the new file ID
|
|
324
|
+
```
|
|
325
|
+
|
|
246
326
|
## Backfill script
|
|
247
327
|
|
|
248
328
|
To generate and upload PDFs for invoices created before file storage was introduced:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@developerx12/invoices-medusa",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.4",
|
|
4
4
|
"description": "Add invoices to Medusa v2",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"files": [
|
|
@@ -75,6 +75,7 @@
|
|
|
75
75
|
"@tanstack/react-query": "5.64.2",
|
|
76
76
|
"date-fns": "^4.1.0",
|
|
77
77
|
"lodash.merge": "^4.6.2",
|
|
78
|
+
"multer": "^2.1.1",
|
|
78
79
|
"dejavu-fonts-ttf": "^2.37.3",
|
|
79
80
|
"pdfmake": "^0.3.7",
|
|
80
81
|
"react-i18next": "^15.7.4"
|