@driveflux/pdf 1.0.1 → 1.0.2

package/dist/cjs/templates/QuotationPdf/index.js

@@ -0,0 +1,208 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "generateQuotationPdf", {
+    enumerable: true,
+    get: function() {
+        return generateQuotationPdf;
+    }
+});
+var _jsxruntime = require("react/jsx-runtime");
+var _renderer = require("@react-pdf/renderer");
+var _react = require("react");
+var _utils = require("../../utils.js");
+var _CustomerSubscriptionSection = /*#__PURE__*/ _interop_require_default(require("./CustomerSubscriptionSection.js"));
+var _GFV = /*#__PURE__*/ _interop_require_default(require("./GFV.js"));
+var _Pricing = /*#__PURE__*/ _interop_require_default(require("./Pricing.js"));
+var _QuotationPdfPage = /*#__PURE__*/ _interop_require_default(require("./QuotationPdfPage.js"));
+var _TermsSection = /*#__PURE__*/ _interop_require_default(require("./TermsSection.js"));
+var _translations = require("./translations.js");
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _async_to_generator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _interop_require_default(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function _ts_generator(thisArg, body) {
+    var f, y, t, g, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    };
+    return g = {
+        next: verb(0),
+        "throw": verb(1),
+        "return": verb(2)
+    }, typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(_)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+}
+var generateQuotationPdf = function() {
+    var _ref = _async_to_generator(function(param, fileName) {
+        var _param_locale, locale, quotation;
+        return _ts_generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    _param_locale = param.locale, locale = _param_locale === void 0 ? 'en' : _param_locale, quotation = param.quotation;
+                    return [
+                        4,
+                        (0, _utils.toPdf)(/*#__PURE__*/ (0, _jsxruntime.jsx)(QuotationPDF, {
+                            locale: locale,
+                            quotation: quotation
+                        }), fileName)
+                    ];
+                case 1:
+                    return [
+                        2,
+                        _state.sent()
+                    ];
+            }
+        });
+    });
+    return function generateQuotationPdf(_, fileName) {
+        return _ref.apply(this, arguments);
+    };
+}();
+var QuotationPDF = function(param) {
+    var _param_locale = param.locale, locale = _param_locale === void 0 ? 'en' : _param_locale, quotation = param.quotation;
+    var pageProps = (0, _react.useMemo)(function() {
+        return {
+            t: (0, _translations.useTranslations)(locale),
+            quotation: quotation
+        };
+    }, []);
+    var t = pageProps.t;
+    return /*#__PURE__*/ (0, _jsxruntime.jsx)(_renderer.Document, {
+        language: locale,
+        children: /*#__PURE__*/ (0, _jsxruntime.jsxs)(_QuotationPdfPage.default, {
+            quotation: quotation,
+            children: [
+                /*#__PURE__*/ (0, _jsxruntime.jsx)(_CustomerSubscriptionSection.default, {
+                    quotation: quotation,
+                    t: t
+                }),
+                /*#__PURE__*/ (0, _jsxruntime.jsx)(_Pricing.default, {
+                    quotation: quotation,
+                    t: t.pricing
+                }),
+                quotation.fees.gfv && /*#__PURE__*/ (0, _jsxruntime.jsx)(_GFV.default, {
+                    quotation: quotation,
+                    t: t.pricing
+                }),
+                /*#__PURE__*/ (0, _jsxruntime.jsx)(_TermsSection.default, {
+                    t: t.terms
+                })
+            ]
+        })
+    });
+};

package/dist/cjs/templates/QuotationPdf/translations.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "useTranslations", {
+    enumerable: true,
+    get: function() {
+        return useTranslations;
+    }
+});
+var enTranslation = {
+    quotation: "Quotation",
+    date: 'Date',
+    customer: {
+        title: "Customer",
+        name: "Name",
+        email: "Email",
+        address: "Address"
+    },
+    subscription: {
+        title: "Subscription",
+        vehicleName: "Vehicle",
+        plan: "Subscription Plan",
+        mileagePackage: "Mileage Package"
+    },
+    subIncludes: {
+        title: "What's Included:",
+        content: [
+            "Comprehensive insurance",
+            "Road tax",
+            "Regularly scheduled maintenance",
+            "Selective wear & tear",
+            "Ability to swap vehicles",
+            "Doorstep delivery",
+            "24/7 nationwide roadside assistance",
+            "Theft recovery services",
+            "Independently rated vehicle inspection",
+            "Option to purchase the vehicle at the end of the subscription"
+        ]
+    },
+    pricing: {
+        title: "Pricing",
+        fees: {
+            upfront: {
+                title: "Upfront Fees",
+                content: [
+                    {
+                        title: "Booking Fee",
+                        key: 'reservationFee'
+                    },
+                    {
+                        title: "Activation Fee",
+                        key: 'startFee'
+                    },
+                    {
+                        title: "Refundable Deposit",
+                        key: 'deposit'
+                    }
+                ]
+            },
+            monthly: {
+                title: "Monthly Fees",
+                content: [
+                    {
+                        title: "Subscription Fee",
+                        key: 'subscriptionFee'
+                    }
+                ]
+            },
+            dueToday: {
+                title: "Due Today",
+                description: "Grand Total is due before your subscription start. Monthly fee is due on the first day of every cycle period.",
+                subTotal: "Upfront Fees + Monthly Fee",
+                serviceFee: "Service Fee (8%)",
+                grandTotal: "Grand Total"
+            },
+            extraCharge: "Extra Charge",
+            promo: "Promo",
+            gfv: {
+                title: "Guaranteed Future Value (GFV)"
+            }
+        }
+    },
+    terms: {
+        title: "Terms",
+        content: [
+            "This quotation is valid for 7 days.",
+            "All vehicles proposed are unique and are available to our customers on a first come first served basis.",
+            "The Mileage Package is the monthly mileage cap for the vehicle. If you exceed this cap for any given month, excess mileage charges will be incurred.",
+            "Initial payment to be made within 7 days of the invoice date.",
+            "Subscription starts on the date of the car delivery.",
+            "The upfront fees are billed one-time per subscription, before the subscription starts.",
+            "All monthly recurring fees are billed on the same date as the delivery of the vehicle.",
+            "Scheduling delivery will only commence Grand Total is fully paid, 7 - 30+ days after payment and subject to vehicle availability."
+        ]
+    }
+};
+var useTranslations = function(locale) {
+    var translation = {
+        en: enTranslation
+    };
+    return translation[locale];
+};

package/dist/cjs/templates/QuotationPdf/utils.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    formatAddress: function() {
+        return formatAddress;
+    },
+    getMileagePackageTranslation: function() {
+        return getMileagePackageTranslation;
+    },
+    getSimplifiedPlanTranslation: function() {
+        return getSimplifiedPlanTranslation;
+    }
+});
+function _object_without_properties(source, excluded) {
+    if (source == null) return {};
+    var target = _object_without_properties_loose(source, excluded);
+    var key, i;
+    if (Object.getOwnPropertySymbols) {
+        var sourceSymbolKeys = Object.getOwnPropertySymbols(source);
+        for(i = 0; i < sourceSymbolKeys.length; i++){
+            key = sourceSymbolKeys[i];
+            if (excluded.indexOf(key) >= 0) continue;
+            if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue;
+            target[key] = source[key];
+        }
+    }
+    return target;
+}
+function _object_without_properties_loose(source, excluded) {
+    if (source == null) return {};
+    var target = {};
+    var sourceKeys = Object.keys(source);
+    var key, i;
+    for(i = 0; i < sourceKeys.length; i++){
+        key = sourceKeys[i];
+        if (excluded.indexOf(key) >= 0) continue;
+        target[key] = source[key];
+    }
+    return target;
+}
+var formatAddress = function(originalAddress) {
+    var coordinates = originalAddress.coordinates, metadata = originalAddress.metadata, address = _object_without_properties(originalAddress, [
+        "coordinates",
+        "metadata"
+    ]);
+    return Object.keys(address).filter(function(key) {
+        return key !== 'name' && !!address[key];
+    }).map(function(a) {
+        return address[a];
+    }).join(', ');
+};
+var getSimplifiedPlanTranslation = function(plan) {
+    switch(plan){
+        case 'plan60':
+            return "60 Months";
+        case 'plan36':
+            return "36 Months";
+        case 'plan24':
+            return "24 Months";
+        case 'plan12':
+            return "12 Months";
+        case 'plan1':
+            return "Monthly";
+        case 'planWeekly':
+            return "Weekly";
+        default:
+            return "Unknown Plan";
+    }
+};
+var getMileagePackageTranslation = function(mileagePackage) {
+    switch(mileagePackage){
+        case 'lite':
+            return "Lite";
+        case 'standard':
+            return "Standard";
+        case 'plus':
+            return "Plus";
+        case 'unlimited':
+            return "Unlimited";
+        default:
+            return "Unknown Mileage Package";
+    }
+};

package/dist/cjs/templates/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
+_export_star(require("./QuotationPdf/index.js"), exports);
 _export_star(require("./SubscriptionAgreement/index.js"), exports);
 function _export_star(from, to) {
     Object.keys(from).forEach(function(k) {

package/dist/debug.js

@@ -123,8 +123,10 @@ function _ts_generator(thisArg, body) {
     }
 }
 import { loadAllEnv } from '@driveflux/env';
+import { quotation } from './__mocks__/quotation.js';
 import { subscription } from './__mocks__/subscription.js';
 import { generateSubscriptionAgreementPdf } from './templates/SubscriptionAgreement/index.js';
+import { generateQuotationPdf } from './templates/index.js';
 var debugSubscriptionAgreement = function() {
     var _ref = _async_to_generator(function() {
         return _ts_generator(this, function(_state) {
@@ -154,9 +156,39 @@ var debugSubscriptionAgreement = function() {
         return _ref.apply(this, arguments);
     };
 }();
+var debugQuotation = function() {
+    var _ref = _async_to_generator(function() {
+        return _ts_generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    if (!quotation) {
+                        console.error('no such quotation');
+                        return [
+                            2
+                        ];
+                    }
+                    return [
+                        4,
+                        generateQuotationPdf({
+                            quotation: quotation
+                        }, "".concat(process.cwd(), "/output/quotation.pdf"))
+                    ];
+                case 1:
+                    _state.sent();
+                    return [
+                        2
+                    ];
+            }
+        });
+    });
+    return function debugQuotation() {
+        return _ref.apply(this, arguments);
+    };
+}();
 //! put all the debugging functions here
 var debugCases = [
-    debugSubscriptionAgreement()
+    debugSubscriptionAgreement(),
+    debugQuotation()
 ];
 var debug = function() {
     var _ref = _async_to_generator(function() {

package/dist/templates/QuotationPdf/CustomerSubscriptionSection.d.ts

@@ -0,0 +1,10 @@
+import { Quotation } from '@driveflux/db';
+import { FC } from 'react';
+import { QuotationPdfTranslation } from './translations.js';
+type Props = {
+    quotation: Quotation;
+    t: QuotationPdfTranslation;
+};
+declare const CustomerSubscriptionSection: FC<Props>;
+export default CustomerSubscriptionSection;
+//# sourceMappingURL=CustomerSubscriptionSection.d.ts.map

package/dist/templates/QuotationPdf/CustomerSubscriptionSection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomerSubscriptionSection.d.ts","sourceRoot":"","sources":["../../../src/templates/QuotationPdf/CustomerSubscriptionSection.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAGzC,OAAO,EAAE,EAAE,EAAE,MAAM,OAAO,CAAA;AAG1B,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAA;AAG3D,KAAK,KAAK,GAAG;IACX,SAAS,EAAE,SAAS,CAAA;IACpB,CAAC,EAAE,uBAAuB,CAAA;CAC3B,CAAA;AAED,QAAA,MAAM,2BAA2B,EAAE,EAAE,CAAC,KAAK,CAgD1C,CAAA;AAED,eAAe,2BAA2B,CAAA"}

package/dist/templates/QuotationPdf/CustomerSubscriptionSection.js

@@ -0,0 +1,132 @@
+import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
+import { Text, View } from '@react-pdf/renderer';
+import { colors } from '../../theme/colors.js';
+import SectionBoxNew from './SectionBoxNew.js';
+import { formatAddress, getMileagePackageTranslation, getSimplifiedPlanTranslation } from './utils.js';
+var CustomerSubscriptionSection = function(param) {
+    var quotation = param.quotation, t = param.t;
+    var displayContent = function(label, value) {
+        var labelColor = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : colors.black, valueColor = arguments.length > 3 && arguments[3] !== void 0 ? arguments[3] : colors.primary3;
+        return /*#__PURE__*/ _jsxs(View, {
+            style: {
+                gap: 4
+            },
+            children: [
+                /*#__PURE__*/ _jsx(Text, {
+                    style: {
+                        color: labelColor,
+                        letterSpacing: 1
+                    },
+                    children: label
+                }),
+                /*#__PURE__*/ _jsx(Text, {
+                    style: {
+                        color: valueColor,
+                        letterSpacing: 1
+                    },
+                    children: value
+                })
+            ]
+        });
+    };
+    return /*#__PURE__*/ _jsx(View, {
+        children: /*#__PURE__*/ _jsx(SectionBoxNew, {
+            topContent: /*#__PURE__*/ _jsxs(_Fragment, {
+                children: [
+                    /*#__PURE__*/ _jsx(Text, {
+                        style: {
+                            textTransform: 'uppercase',
+                            fontSize: 12,
+                            fontWeight: 'bold'
+                        },
+                        children: t.customer.title
+                    }),
+                    /*#__PURE__*/ _jsxs(View, {
+                        style: {
+                            flexDirection: 'row',
+                            justifyContent: 'space-between'
+                        },
+                        children: [
+                            displayContent(t.customer.name, quotation.customerName),
+                            quotation.customer.email && displayContent(t.customer.email, quotation.customer.email)
+                        ]
+                    }),
+                    quotation.customer.address && displayContent(t.customer.address, formatAddress(quotation.customer.address))
+                ]
+            }),
+            bottomContent: /*#__PURE__*/ _jsxs(_Fragment, {
+                children: [
+                    /*#__PURE__*/ _jsx(Text, {
+                        style: {
+                            textTransform: 'uppercase',
+                            fontSize: 12,
+                            fontWeight: 'bold'
+                        },
+                        children: t.subscription.title
+                    }),
+                    /*#__PURE__*/ _jsxs(View, {
+                        style: {
+                            flexDirection: 'row',
+                            justifyContent: 'space-between',
+                            gap: 4
+                        },
+                        children: [
+                            displayContent(t.subscription.vehicleName, quotation.vehicleName),
+                            /*#__PURE__*/ _jsxs(View, {
+                                style: {
+                                    justifyContent: 'space-between',
+                                    flexDirection: 'row',
+                                    gap: 16
+                                },
+                                children: [
+                                    displayContent(t.subscription.plan, getSimplifiedPlanTranslation(quotation.plan)),
+                                    displayContent(t.subscription.mileagePackage, getMileagePackageTranslation(quotation.mileagePackage))
+                                ]
+                            })
+                        ]
+                    }),
+                    /*#__PURE__*/ _jsxs(View, {
+                        style: {
+                            rowGap: 8
+                        },
+                        children: [
+                            /*#__PURE__*/ _jsx(Text, {
+                                style: {
+                                    color: colors.primary3,
+                                    fontWeight: 'bold',
+                                    letterSpacing: 1
+                                },
+                                children: t.subIncludes.title
+                            }),
+                            t.subIncludes.content.map(function(line, i) {
+                                return /*#__PURE__*/ _jsxs(View, {
+                                    style: {
+                                        flexDirection: 'row',
+                                        alignItems: 'flex-start',
+                                        rowGap: 8
+                                    },
+                                    children: [
+                                        /*#__PURE__*/ _jsx(Text, {
+                                            style: {
+                                                marginRight: 4
+                                            },
+                                            children: "•"
+                                        }),
+                                        /*#__PURE__*/ _jsx(Text, {
+                                            style: {
+                                                color: colors.primary3,
+                                                letterSpacing: 1
+                                            },
+                                            children: line
+                                        })
+                                    ]
+                                }, i);
+                            })
+                        ]
+                    })
+                ]
+            })
+        })
+    });
+};
+export default CustomerSubscriptionSection;

package/dist/templates/QuotationPdf/GFV.d.ts

@@ -0,0 +1,10 @@
+import { Quotation } from '@driveflux/db';
+import { FC } from 'react';
+import { QuotationPdfTranslation } from './translations';
+type Props = {
+    quotation: Quotation;
+    t?: QuotationPdfTranslation['pricing'];
+};
+declare const GFV: FC<Props>;
+export default GFV;
+//# sourceMappingURL=GFV.d.ts.map

package/dist/templates/QuotationPdf/GFV.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GFV.d.ts","sourceRoot":"","sources":["../../../src/templates/QuotationPdf/GFV.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAGzC,OAAO,EAAE,EAAE,EAAE,MAAM,OAAO,CAAA;AAE1B,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAA;AAExD,KAAK,KAAK,GAAG;IACX,SAAS,EAAE,SAAS,CAAA;IACpB,CAAC,CAAC,EAAE,uBAAuB,CAAC,SAAS,CAAC,CAAA;CACvC,CAAA;AAED,QAAA,MAAM,GAAG,EAAE,EAAE,CAAC,KAAK,CAclB,CAAA;AAED,eAAe,GAAG,CAAA"}

package/dist/templates/QuotationPdf/GFV.js

@@ -0,0 +1,47 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { formatMoney } from '@driveflux/format-money';
+import { Text, View } from '@react-pdf/renderer';
+import { colors } from '../../theme/colors.js';
+var GFV = function(param) {
+    var quotation = param.quotation, t = param.t;
+    if (!quotation.fees.gfv) return;
+    return /*#__PURE__*/ _jsxs(View, {
+        style: {
+            border: "1px solid ".concat(colors.primary2),
+            padding: 16,
+            rowGap: 16
+        },
+        children: [
+            /*#__PURE__*/ _jsx(Text, {
+                style: {
+                    color: colors.primary3,
+                    fontWeight: 'bold',
+                    letterSpacing: 1,
+                    textTransform: 'uppercase'
+                },
+                children: t === null || t === void 0 ? void 0 : t.fees.gfv.title
+            }),
+            /*#__PURE__*/ _jsxs(Text, {
+                style: {
+                    color: colors.primary3,
+                    letterSpacing: 1
+                },
+                children: [
+                    "You have the option to purchase this vehicle with GFV amount of",
+                    /*#__PURE__*/ _jsxs(Text, {
+                        style: {
+                            fontWeight: 'bold'
+                        },
+                        children: [
+                            " ",
+                            formatMoney(quotation.fees.gfv),
+                            " "
+                        ]
+                    }),
+                    "at the end of your subscription."
+                ]
+            })
+        ]
+    });
+};
+export default GFV;

package/dist/templates/QuotationPdf/Header.d.ts

@@ -0,0 +1,9 @@
+import { FC } from 'react';
+type Props = {
+    tTitle: string;
+    quotationId: string;
+    quotationDate: string;
+};
+declare const Header: FC<Props>;
+export default Header;
+//# sourceMappingURL=Header.d.ts.map

package/dist/templates/QuotationPdf/Header.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Header.d.ts","sourceRoot":"","sources":["../../../src/templates/QuotationPdf/Header.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,OAAO,CAAA;AAI1B,KAAK,KAAK,GAAG;IACX,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AACD,QAAA,MAAM,MAAM,EAAE,EAAE,CAAC,KAAK,CAkBrB,CAAA;AAED,eAAe,MAAM,CAAA"}