@driveflux/pdf 1.0.1 → 1.0.2

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/templates/QuotationPdf/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAA;AAGzC,OAAO,EAAE,4BAA4B,EAAE,MAAM,gBAAgB,CAAA;AAc7D,KAAK,OAAO,GAAG;IACb,MAAM,CAAC,EAAE,4BAA4B,CAAA;IACrC,SAAS,EAAE,SAAS,CAAA;CACrB,CAAA;AAED,eAAO,MAAM,oBAAoB,0BAAwC,OAAO,YAAY,MAAM,kBAEjG,CAAA"}

package/dist/templates/QuotationPdf/index.js

@@ -0,0 +1,193 @@
+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 _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
+        };
+    }
+}
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { Document } from '@react-pdf/renderer';
+import { useMemo } from 'react';
+import { toPdf } from '../../utils.js';
+import CustomerSubscriptionSection from './CustomerSubscriptionSection.js';
+import GFV from './GFV.js';
+import Pricing from './Pricing.js';
+import QuotationPdfPage from './QuotationPdfPage.js';
+import TermsSection from './TermsSection.js';
+import { useTranslations } from './translations.js';
+export 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,
+                        toPdf(/*#__PURE__*/ _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 = useMemo(function() {
+        return {
+            t: useTranslations(locale),
+            quotation: quotation
+        };
+    }, []);
+    var t = pageProps.t;
+    return /*#__PURE__*/ _jsx(Document, {
+        language: locale,
+        children: /*#__PURE__*/ _jsxs(QuotationPdfPage, {
+            quotation: quotation,
+            children: [
+                /*#__PURE__*/ _jsx(CustomerSubscriptionSection, {
+                    quotation: quotation,
+                    t: t
+                }),
+                /*#__PURE__*/ _jsx(Pricing, {
+                    quotation: quotation,
+                    t: t.pricing
+                }),
+                quotation.fees.gfv && /*#__PURE__*/ _jsx(GFV, {
+                    quotation: quotation,
+                    t: t.pricing
+                }),
+                /*#__PURE__*/ _jsx(TermsSection, {
+                    t: t.terms
+                })
+            ]
+        })
+    });
+};

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

@@ -0,0 +1,59 @@
+declare const enTranslation: {
+    quotation: string;
+    date: string;
+    customer: {
+        title: string;
+        name: string;
+        email: string;
+        address: string;
+    };
+    subscription: {
+        title: string;
+        vehicleName: string;
+        plan: string;
+        mileagePackage: string;
+    };
+    subIncludes: {
+        title: string;
+        content: string[];
+    };
+    pricing: {
+        title: string;
+        fees: {
+            upfront: {
+                title: string;
+                content: {
+                    title: string;
+                    key: string;
+                }[];
+            };
+            monthly: {
+                title: string;
+                content: {
+                    title: string;
+                    key: string;
+                }[];
+            };
+            dueToday: {
+                title: string;
+                description: string;
+                subTotal: string;
+                serviceFee: string;
+                grandTotal: string;
+            };
+            extraCharge: string;
+            promo: string;
+            gfv: {
+                title: string;
+            };
+        };
+    };
+    terms: {
+        title: string;
+        content: string[];
+    };
+};
+export type QuotationPdfTranslation = typeof enTranslation;
+export declare const useTranslations: (locale: 'en') => QuotationPdfTranslation;
+export {};
+//# sourceMappingURL=translations.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"translations.d.ts","sourceRoot":"","sources":["../../../src/templates/QuotationPdf/translations.ts"],"names":[],"mappings":"AAAA,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwElB,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG,OAAO,aAAa,CAAA;AAE1D,eAAO,MAAM,eAAe,WAAY,IAAI,KAAG,uBAK9C,CAAA"}

package/dist/templates/QuotationPdf/translations.js

@@ -0,0 +1,93 @@
+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."
+        ]
+    }
+};
+export var useTranslations = function(locale) {
+    var translation = {
+        en: enTranslation
+    };
+    return translation[locale];
+};

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

@@ -0,0 +1,6 @@
+import { MileagePackage, PlanType } from '@driveflux/db';
+import { Address } from '@driveflux/db/types';
+export declare const formatAddress: (originalAddress: Address) => string;
+export declare const getSimplifiedPlanTranslation: (plan: PlanType) => "60 Months" | "36 Months" | "24 Months" | "12 Months" | "Monthly" | "Weekly" | "Unknown Plan";
+export declare const getMileagePackageTranslation: (mileagePackage?: MileagePackage) => "Lite" | "Standard" | "Plus" | "Unlimited" | "Unknown Mileage Package";
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/templates/QuotationPdf/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAE7C,eAAO,MAAM,aAAa,oBAAqB,OAAO,WAMrD,CAAA;AAED,eAAO,MAAM,4BAA4B,SAAU,QAAQ,kGAiB1D,CAAA;AAED,eAAO,MAAM,4BAA4B,oBAAqB,cAAc,2EAa3E,CAAA"}

package/dist/templates/QuotationPdf/utils.js

@@ -0,0 +1,70 @@
+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;
+}
+export 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(', ');
+};
+export 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";
+    }
+};
+export 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/templates/index.d.ts

@@ -1,2 +1,3 @@
+export * from './QuotationPdf/index.js';
 export * from './SubscriptionAgreement/index.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/templates/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/templates/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/templates/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,kCAAkC,CAAA"}

package/dist/templates/index.js

@@ -1 +1,2 @@
+export * from './QuotationPdf/index.js';
 export * from './SubscriptionAgreement/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@driveflux/pdf",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "type": "module",
   "main": "./dist/cjs/index.js",
   "module": "./dist/index.js",
@@ -13,7 +13,7 @@
     }
   },
   "dependencies": {
-    "@driveflux/db": "1.0.36",
+    "@driveflux/db": "1.0.37",
     "@driveflux/env": "1.0.6",
     "@driveflux/time": "4.0.5",
     "@react-pdf/renderer": "^3.4.4",

package/src/__mocks__/quotation.ts

@@ -0,0 +1,62 @@
+import { Quotation } from '@driveflux/db'
+
+export const quotation: Quotation = {
+  id: 'QUO_XZJLVSM8',
+  vehicleId: 'VBEXLQR',
+  plan: 'plan36',
+  mileagePackage: 'lite',
+  cycleFluxCoefficient: 'flux25',
+  customerName: 'Bubu Ahmad',
+  vehicleName: 'Volkswagen Polo 1.6 Sedan 2011',
+  createdById: 'U2R88JRVL',
+
+  createdAt: new Date('2024-05-27T02:26:36.070Z'),
+  updatedAt: new Date('2024-05-27T02:26:36.070Z'),
+  metadata: {},
+  customer: {
+    type: 'user',
+    name: 'Bubu Ahmad',
+    email: 'bubu@gmail.com',
+    address: {
+      street1: '15-2 Jalan Solaris',
+      city: 'Kuala Lumpur',
+      state: 'Johor',
+      postalCode: '12323',
+      country: 'MY'
+    }
+  },
+  fees: {
+    subscriptionFee: 800,
+    reservationFee: 0,
+    startFee: 498,
+    deposit: 1600,
+    depositMonths: 2,
+    extraCharges: [
+      {
+        type: 'upfront',
+        description: 'Spare Tyre',
+        amount: 2500.2
+      },
+      {
+        type: 'upfront',
+        description: 'Spare Tyre No 2',
+        amount: 3000.2
+      },
+      {
+        type: 'monthly',
+        description: 'Commitment ',
+        amount: 2
+      }
+    ],
+    amountBeforeTax: 8400.4,
+    taxAmount: 672.03,
+    amountAfterTax: 9072.43,
+    gfv: 0,
+    cycle: null,
+    couponCode: null,
+    discountAmount: null,
+    appliedDiscountId: null,
+    couponType: ''
+  },
+  quotationPdf: null
+}

package/src/debug.ts

@@ -1,6 +1,8 @@
 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'
 
 const debugSubscriptionAgreement = async () => {
   if (!subscription) {
@@ -11,10 +13,17 @@ const debugSubscriptionAgreement = async () => {
   await generateSubscriptionAgreementPdf({ subscription }, `${process.cwd()}/output/subscription-agreement.pdf`)
 }
 
+const debugQuotation = async () => {
+  if (!quotation) {
+    console.error('no such quotation')
+    return
+  }
+
+  await generateQuotationPdf({ quotation }, `${process.cwd()}/output/quotation.pdf`)
+}
+
 //! put all the debugging functions here
-const debugCases: Promise<any>[] = [
-  debugSubscriptionAgreement()
-]
+const debugCases: Promise<any>[] = [debugSubscriptionAgreement(), debugQuotation()]
 
 const debug = async () => {
   loadAllEnv()

package/src/templates/QuotationPdf/CustomerSubscriptionSection.tsx

@@ -0,0 +1,65 @@
+import { Quotation } from '@driveflux/db'
+import { Address } from '@driveflux/db/types/index.js'
+import { Text, View } from '@react-pdf/renderer'
+import { FC } from 'react'
+import { colors } from '../../theme/colors.js'
+import SectionBoxNew from './SectionBoxNew.js'
+import { QuotationPdfTranslation } from './translations.js'
+import { formatAddress, getMileagePackageTranslation, getSimplifiedPlanTranslation } from './utils.js'
+
+type Props = {
+  quotation: Quotation
+  t: QuotationPdfTranslation
+}
+
+const CustomerSubscriptionSection: FC<Props> = ({ quotation, t }) => {
+  const displayContent = (label: string, value: string, labelColor = colors.black, valueColor = colors.primary3) => (
+    <View style={{ gap: 4 }}>
+      <Text style={{ color: labelColor, letterSpacing: 1 }}>{label}</Text>
+      <Text style={{ color: valueColor, letterSpacing: 1 }}>{value}</Text>
+    </View>
+  )
+
+  return (
+    <View>
+      <SectionBoxNew
+        topContent={
+          <>
+            <Text style={{ textTransform: 'uppercase', fontSize: 12, fontWeight: 'bold' }}>{t.customer.title}</Text>
+            <View style={{ flexDirection: 'row', justifyContent: 'space-between' }}>
+              {displayContent(t.customer.name, quotation.customerName)}
+              {quotation.customer.email && displayContent(t.customer.email, quotation.customer.email)}
+            </View>
+            {quotation.customer.address &&
+              displayContent(t.customer.address, formatAddress(quotation.customer.address as Address))}
+          </>
+        }
+        bottomContent={
+          <>
+            <Text style={{ textTransform: 'uppercase', fontSize: 12, fontWeight: 'bold' }}>{t.subscription.title}</Text>
+            <View style={{ flexDirection: 'row', justifyContent: 'space-between', gap: 4 }}>
+              {displayContent(t.subscription.vehicleName, quotation.vehicleName)}
+              <View style={{ justifyContent: 'space-between', flexDirection: 'row', gap: 16 }}>
+                {displayContent(t.subscription.plan, getSimplifiedPlanTranslation(quotation.plan))}
+                {displayContent(t.subscription.mileagePackage, getMileagePackageTranslation(quotation.mileagePackage))}
+              </View>
+            </View>
+            <View style={{ rowGap: 8 }}>
+              <Text style={{ color: colors.primary3, fontWeight: 'bold', letterSpacing: 1 }}>
+                {t.subIncludes.title}
+              </Text>
+              {t.subIncludes.content.map((line, i) => (
+                <View key={i} style={{ flexDirection: 'row', alignItems: 'flex-start', rowGap: 8 }}>
+                  <Text style={{ marginRight: 4 }}>•</Text>
+                  <Text style={{ color: colors.primary3, letterSpacing: 1 }}>{line}</Text>
+                </View>
+              ))}
+            </View>
+          </>
+        }
+      />
+    </View>
+  )
+}
+
+export default CustomerSubscriptionSection

package/src/templates/QuotationPdf/GFV.tsx

@@ -0,0 +1,29 @@
+import { Quotation } from '@driveflux/db'
+import { formatMoney } from '@driveflux/format-money'
+import { Text, View } from '@react-pdf/renderer'
+import { FC } from 'react'
+import { colors } from '../../theme/colors.js'
+import { QuotationPdfTranslation } from './translations'
+
+type Props = {
+  quotation: Quotation
+  t?: QuotationPdfTranslation['pricing']
+}
+
+const GFV: FC<Props> = ({ quotation, t }) => {
+  if (!quotation.fees.gfv) return
+
+  return (
+    <View style={{ border: `1px solid ${colors.primary2}`, padding: 16, rowGap: 16 }}>
+      <Text style={{ color: colors.primary3, fontWeight: 'bold', letterSpacing: 1, textTransform: 'uppercase' }}>
+        {t?.fees.gfv.title}
+      </Text>
+      <Text style={{ color: colors.primary3, letterSpacing: 1 }}>
+        You have the option to purchase this vehicle with GFV amount of
+        <Text style={{ fontWeight: 'bold' }}> {formatMoney(quotation.fees.gfv)} </Text>at the end of your subscription.
+      </Text>
+    </View>
+  )
+}
+
+export default GFV