storemw-core-client 1.0.1

package/src/services/rate/RateService.ts

@@ -0,0 +1,570 @@
+import { ApiService, ApiServiceType } from '@/lib';
+
+import {
+    buildApiListUrl,
+    BuildApiListParamsProps,
+    buildApiGetUrl,
+    BuildApiGetParamsProps,
+    filterOperatorTypes
+} from '@/lib';
+
+export const rateTypes = {
+    shippingRate: "shipping_rate",
+    shippingRateItem: "shipping_rate_item",
+    shippingRule: "shipping_rule",
+    taxRate: "tax_rate"
+} as const
+
+type RateTypeValue = (typeof rateTypes)[keyof typeof rateTypes]
+
+export const rateTargetTypes = {
+    shippingRate: "shipping_rate",
+    shippingRateItem: "shipping_rate",
+    shippingRule: "shipping_rule",
+    taxRate: "tax_rate"
+} as const
+
+
+export const rateCalculationTypes = [
+    { id: "fixed", display: "Fixed" },
+    { id: "tier", display: "Tier" }
+]
+
+export type RateType = typeof rateTypes[keyof typeof rateTypes] // keyof typeof rateTypes
+export type RateTargetType = typeof rateTargetTypes[keyof typeof rateTargetTypes]
+export type RegionTargetKey = keyof typeof rateTargetTypes
+
+export type RateServiceProps = ApiServiceType & {
+    rateTargetType?: RateTargetType
+    rateType?: RateType
+};
+
+export type ListRateProps = BuildApiListParamsProps & {
+    // rateType?: RateType
+    // rateType?: Omit<RateType, "shippingRateItem"> // skip this type
+    rateType?: Exclude<RateType, "shippingRateItem"> // skip this type
+}
+
+export type GetRateProps = BuildApiGetParamsProps & {
+    id: number | string
+    // rateType?: RateType
+    // rateType?: Omit<RateType, "shippingRateItem"> // skip this type
+    rateType?: Exclude<RateType, "shippingRateItem"> // skip this type
+}
+
+type ScopeType = "area" | "location"
+type MeasureType = "weight" | "cbm" | "m3" | "unit"
+type ChargeMethodType = "item_rate_multiply_input_value" | "item_rate_only"
+type CalculateItemConditionType = "highest" | "sum"
+
+type RateShipping = {
+    rateName: string
+    scopeId: number
+    scopeType: ScopeType
+    description: string
+    status: boolean
+}
+
+type RateShippingItem = {
+    scopeType: string
+    scopeId: number
+    ruleIds: number[]
+    toLocationId: number
+    measureType: MeasureType
+}
+
+type RateShippingRuleItem = {
+    minValue: number
+    maxValue: number
+    itemRate: number
+}
+
+type RateShippingRule = {
+    ruleName: string
+    calculationType: "fixed" | "tier"
+    chargeAmount: number
+    description: string
+    measureType: MeasureType
+    chargeMethod: ChargeMethodType
+    customerGroupIds: number[]
+    status: boolean
+}
+
+type RateTax = {
+    rateName: string
+    taxPercentage: number
+    description: string
+    status: boolean
+}
+
+export type CreateRateProps = {
+    rateTargetType?: RateTargetType
+    rateType?: RateType
+    // rateType?: Omit<RateType, "shippingRateItem"> // skip this type
+    data:
+    // for Shipping Rate
+    {
+        shippingRate: {
+            rate: RateShipping,
+        }
+    } |
+    // for Shipping Rate Rule
+    {
+        shippingRateRule: {
+            rule: RateShippingRule,
+            items: RateShippingRuleItem[]
+        }
+    } |
+    // for Tax Rate
+    {
+        taxRate: {
+            rate: RateTax
+        }
+    }
+}
+
+export type UpdateRateProps = {
+    id: number
+    rateTargetType?: RateTargetType
+    rateType?: RateType
+    data:
+    // for Shipping Rate
+    {
+        shippingRate: {
+            rate: Omit<RateShipping, "scopeId" | "scopeType">
+        }
+    } |
+    // for Shipping Rate Item
+    {
+        shippingRateItem: {
+            items: RateShippingItem[]
+        }
+    } |
+    // for Shipping Rate Rule
+    {
+        shippingRateRule: {
+            rule: RateShippingRule,
+            items: RateShippingRuleItem[]
+        }
+    } |
+    // for Tax Rate
+    {
+        taxRate: {
+            rate: RateTax,
+            props: {
+                taxPercentage: number
+            }
+        }
+    }
+}
+
+export type CalculateRateProps = {
+    id: number
+    rateTargetType?: Extract<RateTargetType, "shipping_rate" | "tax_rate"> // only this 
+    rateType?: Extract<RateType, "shippingRate" | "taxRate"> // only this 
+    data:
+    // only for Shipping Rate
+    {
+        calculateShippingRate: {
+            items: ({
+                itemKey: string
+                rateId: number
+                toScopeType: ScopeType
+                toScopeId: number
+                userId: number
+                measureWeightValue: number
+                measureCbmValue: number
+                measureUnitValue: number
+                calculateItems: ({
+                    calculateKey: string
+                    measureTypes: MeasureType[],
+                    condition: CalculateItemConditionType
+                })[]
+            })[]
+        }
+    } &
+    // only for Tax Rate
+    {
+        calculateTaxRate: {
+            items: ({
+                itemKey: string
+                rateId: number
+                measureAmountValue: number
+            })[]
+        }
+    }
+}
+
+export type RemoveRateProps = {
+    rateTargetType?: RateTargetType
+    ids: number[]
+}
+
+export type RemoveRateItemProps = {
+    rateTargetType?: Extract<RateTargetType, "shipping_rate">  // only this 
+    ids: number[]
+}
+
+export type GetDataTypeRateProps = {
+    rateType?: RateType
+}
+
+// rateType: Omit<RateType, "shippingRateItem">
+const getCreatePayload = (rateType: RateType, data: CreateRateProps["data"]) => {
+
+    if (rateType === "shipping_rate" && "shippingRate" in data) {
+        return {
+            rate: {
+                rate_name: data.shippingRate.rate.rateName,
+                scope_id: data.shippingRate.rate.scopeId,
+                scope_type: data.shippingRate.rate.scopeType,
+                description: data.shippingRate.rate.description,
+                status: (data.shippingRate.rate.status === true) ? 1 : 0
+            }
+        }
+    }
+
+    if (rateType === "shipping_rule" && "shippingRateRule" in data) {
+        return {
+            rule: {
+                ruleName: data.shippingRateRule.rule.ruleName,
+                calculationType: data.shippingRateRule.rule.calculationType,
+                description: data.shippingRateRule.rule.description,
+                base_fee: data.shippingRateRule.rule.chargeAmount,
+                status: (data.shippingRateRule.rule.status === true) ? 1 : 0
+            },
+            props: {
+                measure_type: data.shippingRateRule.rule.measureType,
+                charge_method: data.shippingRateRule.rule.chargeMethod,
+                customer_groups: data.shippingRateRule.rule.customerGroupIds
+            },
+            items: data.shippingRateRule.items.map(i => ({
+                min_value: i.minValue,
+                max_value: i.maxValue,
+                item_rate: i.itemRate
+            }))
+        }
+    }
+
+    if (rateType === "tax_rate" && "taxRate" in data) {
+        return {
+            rate: {
+                rate_name: data.taxRate.rate.rateName,
+                description: data.taxRate.rate.description,
+                status: (data.taxRate.rate.status === true) ? 1 : 0
+            },
+            props: {
+                tax_percentage: data.taxRate.rate.taxPercentage
+            }
+        }
+    }
+
+}
+
+const getUpdatePayload = (rateType: RateType, data: UpdateRateProps["data"]) => {
+
+    if (rateType === "shipping_rate" && "shippingRate" in data) {
+        return {
+            rate: {
+                rate_name: data.shippingRate.rate.rateName,
+                description: data.shippingRate.rate.description,
+                status: (data.shippingRate.rate.status === true) ? 1 : 0
+            }
+        }
+    }
+
+    if (rateType === "shipping_rate_item" && "shippingRateItem" in data) {
+        return {
+            items: data.shippingRateItem.items.map(i => ({
+                scopeType: i.scopeType,
+                scopeId: i.scopeId,
+                props: {
+                    rule_id: i.ruleIds,
+                    to_location_id: i.toLocationId,
+                    measure_type: i.measureType
+                }
+            }))
+        }
+    }
+
+    if (rateType === "shipping_rule" && "shippingRateRule" in data) {
+        return {
+            rule: {
+                ruleName: data.shippingRateRule.rule.ruleName,
+                calculationType: data.shippingRateRule.rule.calculationType,
+                description: data.shippingRateRule.rule.description,
+                base_fee: data.shippingRateRule.rule.chargeAmount,
+                status: (data.shippingRateRule.rule.status === true) ? 1 : 0
+            },
+            props: {
+                measure_type: data.shippingRateRule.rule.measureType,
+                charge_method: data.shippingRateRule.rule.chargeMethod,
+                customer_groups: data.shippingRateRule.rule.customerGroupIds
+            },
+            items: data.shippingRateRule.items.map(i => ({
+                min_value: i.minValue,
+                max_value: i.maxValue,
+                item_rate: i.itemRate
+            }))
+        }
+    }
+
+    if (rateType === "tax_rate" && "taxRate" in data) {
+        return {
+            rate: {
+                rate_name: data.taxRate.rate.rateName,
+                description: data.taxRate.rate.description,
+                status: (data.taxRate.rate.status === true) ? 1 : 0
+            },
+            props: {
+                tax_percentage: data.taxRate.rate.taxPercentage
+            }
+        }
+    }
+}
+
+const getCalculatePayload = (rateType: Extract<RateType, "shippingRate" | "taxRate">, data: CalculateRateProps["data"]) => {
+
+    if (rateType === "shippingRate") {
+        return {
+            items: data.calculateShippingRate.items.map(i => ({
+                item_key: i.itemKey,
+                rate: {
+                    rate_id: i.rateId,
+                    to_scope_type: i.toScopeType,
+                    to_scope_id: i.toScopeId,
+                    user_id: i.userId
+                },
+                measure_values: {
+                    weight: i.measureWeightValue,
+                    cbm: i.measureCbmValue,
+                    unit: i.measureUnitValue
+                },
+                calculate_items: i.calculateItems.map(i2 => ({
+                    calculate_key: i2.calculateKey,
+                    measure_types: i2.measureTypes,
+                    condition: i2.condition
+                }))
+            }))
+        }
+    }
+
+    if (rateType === "taxRate") {
+        return {
+            items: data.calculateTaxRate.items.map(i => ({
+                item_key: i.itemKey,
+                rate: {
+                    rate_id: i.rateId
+                },
+                measure_values: {
+                    amount: i.measureAmountValue
+                }
+            }))
+        }
+    }
+}
+
+export const RateService = (props?: RateServiceProps) => {
+
+    const { rateType = "tax_rate", rateTargetType, ...rest } = props ?? {};
+
+    // const rateType: RateTypeValue = _rateType ? rateTypes[_rateType] : "tax_rate"
+
+    const { makeCall } = ApiService(rest?.customToken ? { customToken: rest.customToken } : {})
+
+    const endpoint1 = "rate";
+    const endpoint2 = "rates"
+
+    const list = async (props: ListRateProps) => {
+
+        const { rateType: overrideRateType } = props;
+
+        // const overrideRateType: RateTypeValue = _overrideRateType ? rateTypes[_overrideRateType] : "tax_rate"
+
+        const url = buildApiListUrl(
+            `${endpoint2}/${overrideRateType || rateType}`,
+            props
+        );
+
+        const response = await makeCall({
+            url,
+            method: "get",
+            payload: {},
+            // configuration
+        });
+
+        return response;
+
+    }
+
+    const get = async (props: GetRateProps) => {
+
+        const { id, rateType: overrideRateType } = props;
+
+        // const overrideRateType ? rateTypes[_overrideRateType] : "tax_rate"
+
+        const url = buildApiGetUrl(
+            `${endpoint1}/${overrideRateType || rateType}/${id}`,
+            props
+        );
+
+        const response = await makeCall({
+            url,
+            method: "get",
+            payload: {},
+            // configuration
+        });
+
+        return response;
+
+    }
+
+    const create = async ({ data, rateType: overrideRateType, rateTargetType: overrideRateTargetType }: CreateRateProps) => {
+
+        let _rateType = overrideRateType || rateType
+
+        let payload: any = getCreatePayload(_rateType, data)
+
+        let url = `${endpoint1}`;
+
+        let postData = {
+            scope: {
+                target: overrideRateTargetType || rateTargetType,
+                action: "",
+            },
+            payload
+        }
+
+        const response = await makeCall({
+            url,
+            method: "post",
+            payload: postData
+        });
+
+        return response;
+
+    }
+
+    const update = async ({ id, data, rateType: overrideRateType, rateTargetType: overrideRateTargetType }: UpdateRateProps) => {
+
+        let url = `${endpoint1}/${id}`
+
+        let _rateType = overrideRateType || rateType
+
+        let payload: any = getUpdatePayload(_rateType, data)
+
+        const postData = {
+            scope: {
+                target: overrideRateTargetType || rateTargetType,
+                action: "",
+            },
+            payload
+        }
+
+        const response = await makeCall({
+            url,
+            method: "put",
+            payload: postData
+        });
+
+        return response;
+
+    }
+
+    const remove = async ({ ids, rateTargetType: overrideRateTargetType }: RemoveRateProps) => {
+
+        let url = `${endpoint2}/delete`
+
+        const postData = {
+            scope: {
+                target: overrideRateTargetType || rateTargetType,
+            },
+            payload: {
+                ids
+            }
+        }
+
+        const response = await makeCall({
+            url,
+            method: "post",
+            payload: postData
+        });
+
+        return response;
+    }
+
+    const removeItem = async ({ ids, rateTargetType: overrideRateTargetType }: RemoveRateItemProps) => {
+
+        let url = `${endpoint2}/delete_item`
+
+        const postData = {
+            scope: {
+                target: overrideRateTargetType || rateTargetType,
+            },
+            payload: {
+                ids
+            }
+        }
+
+        const response = await makeCall({
+            url,
+            method: "post",
+            payload: postData
+        });
+
+        return response;
+
+    }
+
+    const getDataTypes = async ({ rateType: overrideRateType }: GetDataTypeRateProps) => {
+
+        let url = `${endpoint1}/data_types/${overrideRateType || rateType}`
+
+        const response = await makeCall({
+            url,
+            method: "get",
+        });
+
+        return response;
+
+    }
+
+    const calculateRate = async ({ data, rateType: overrideRateType, rateTargetType: overrideRateTargetType }: CalculateRateProps) => {
+
+        let url = `${endpoint1}/calculate_rate`
+
+        let payload: any
+
+        if (overrideRateType) {
+            payload = getCalculatePayload(overrideRateType, data)
+        }
+
+        const postData = {
+            scope: {
+                target: overrideRateTargetType || rateTargetType,
+                action: "",
+            },
+            payload
+        }
+
+        const response = await makeCall({
+            url,
+            method: "put",
+            payload: postData
+        });
+
+        return response;
+
+    }
+
+    return {
+        list,
+        get,
+        create,
+        update,
+        remove,
+        removeItem,
+        getDataTypes,
+        calculateRate
+    };
+}