Open-source manufacturing ERP, MES and QMS. Quoting, MRP, inventory, shop floor, quality and lot/serial traceability on one Postgres schema, with a REST API and MCP server. Self-host or use Carbon Cloud.
TypeScript ai-agentsbill-of-materialserpinventory-managementleanmanufacturingmanufacturing-execution-systemmcp-servermesmrpopen-source-erppostgresqlproduction-planningqmsquality-management-systemreact-routerself-hostedsupabasetraceabilitytypescript
// SPDX-License-Identifier: AGPL-3.0-only
// Carbon (github.com/crbnos/carbon). Modified or adapted versions of this file,
// including ports, remain AGPLv3; serving them over a network requires releasing their source.
import type { TermId } from "@carbon/content/glossary";
import { useControlField, useField } from "@carbon/form";
import {
Button,
CommandTrigger,
cn,
FormControl,
FormErrorMessage,
FormHelperText,
FormLabel,
HStack,
LabelWithHelp,
Modal,
ModalBody,
ModalContent,
ModalFooter,
ModalTitle,
NumberDecrementStepper,
NumberField,
NumberIncrementStepper,
NumberInput,
NumberInputGroup,
NumberInputStepper,
VStack
} from "@carbon/react";
import { SCALE_FORMAT } from "@carbon/utils";
import { Trans, useLingui } from "@lingui/react/macro";
import type { ElementRef } from "react";
import { forwardRef, useEffect, useMemo, useRef, useState } from "react";
import {
LuArrowRightLeft,
LuChevronDown,
LuChevronUp,
LuLanguages
} from "react-icons/lu";
import { useQuantityFormatter } from "~/hooks";
import { useUnitOfMeasure } from "./UnitOfMeasure";
enum ConversionDirection {
PurchasedToInventory,
InventoryToPurchased
}
type ConversionFactorProps = {
name: string;
label?: string;
termId?: TermId;
inventoryCode?: string;
purchasingCode?: string;
isReadOnly?: boolean;
isRequired?: boolean;
helperText?: string;
value?: number;
onChange?: (newValue: number) => void;
};
const ConversionFactor = forwardRef<
ElementRef<typeof CommandTrigger>,
ConversionFactorProps
>(
(
{
name,
label = "Conversion Factor",
termId,
isRequired,
isReadOnly,
helperText,
value,
onChange,
purchasingCode,
inventoryCode
},
ref
) => {
const { t } = useLingui();
const {
getInputProps,
error,
defaultValue,
isOptional: fieldIsOptional
} = useField(name);
const [controlValue, setControlValue] = useControlField<number>(name);
const [open, setOpen] = useState(false);
const initialValue = useRef(defaultValue);
// A conversion factor is a RATE, not a settlement amount: inventoryQty =
// purchaseQty x factor, and the modal also shows its inverse. A bare
// NumberField falls to Intl's 3-digit decimal default, which stored 1/3 as
// 0.333 and 0.16455 as 0.165 — a permanent error on every receipt of that
// item, even though the columns are bare NUMERIC. SCALE_FORMAT is the
// storage scale, and react-aria commits parse(format(x)).
const [conversionFactor, setConversionFactor] = useState(
initialValue.current
);
useEffect(() => {
if (value) {
setControlValue(value);
setConversionFactor(value);
initialValue.current = value;
}
}, [setControlValue, value]);
const [conversionDirection, setConversionDirection] = useState(
ConversionDirection.InventoryToPurchased
);
const switchDirection = () => {
if (conversionDirection === ConversionDirection.InventoryToPurchased) {
setConversionDirection(ConversionDirection.PurchasedToInventory);
} else {
setConversionDirection(ConversionDirection.InventoryToPurchased);
}
};
const unitOfMeasureOptions = useUnitOfMeasure();
const formatQuantity = useQuantityFormatter();
const description = useMemo(() => {
const purchaseUnit =
unitOfMeasureOptions.find((option) => option.value === purchasingCode)
?.label ??
purchasingCode ??
"";
const inventoryUnit =
unitOfMeasureOptions.find((option) => option.value === inventoryCode)
?.label ??
inventoryCode ??
"";
const inverseOfConversion = 1 / conversionFactor;
if (purchasingCode === inventoryCode) return t`No conversion is required`;
if (conversionDirection === ConversionDirection.InventoryToPurchased) {
return (
<>
<span className={cn(Number.isNaN(conversionFactor) && "opacity-0")}>
{`There ${conversionFactor === 1 ? "is" : "are"} ${formatQuantity(
conversionFactor
)} ${inventoryUnit.toLocaleLowerCase()} in one `}
<span className="text-primary">
{purchaseUnit.toLocaleLowerCase()}
</span>
</span>
</>
);
}
return (
<>
<span>
{`There ${conversionFactor === 1 ? "is" : "are"} ${formatQuantity(
inverseOfConversion
)} `}
<span className="text-primary">
{purchaseUnit.toLocaleLowerCase()}
</span>
{` in one ${inventoryUnit.toLocaleLowerCase()}`}
</span>
</>
);
}, [
conversionDirection,
conversionFactor,
formatQuantity,
inventoryCode,
purchasingCode,
unitOfMeasureOptions,
t
]);
// Equal codes force the factor to 1 only when a unit of measure CHANGES
// into equality — never on mount, where the codes can already be equal
// and the stored factor must be displayed (and submitted) as stored.
const wasEqual = useRef(inventoryCode === purchasingCode);
useEffect(() => {
const isEqual = inventoryCode === purchasingCode;
if (isEqual && !wasEqual.current) {
setConversionFactor(1);
setControlValue(1);
initialValue.current = 1;
}
wasEqual.current = isEqual;
}, [inventoryCode, purchasingCode, setControlValue]);
const onPurchaseUnitChange = (v: number) => {
setConversionFactor(1 / v);
onChange?.(1 / v);
};
const onInventoryUnitChange = (v: number) => {
setConversionFactor(v);
onChange?.(v);
};
const onConfirm = () => {
setControlValue(conversionFactor);
setOpen(false);
initialValue.current = conversionFactor;
};
const onCancel = () => {
setConversionFactor(initialValue.current);
setOpen(false);
};
const resolvedIsOptional = isRequired ? false : (fieldIsOptional ?? false);
return (
<FormControl isInvalid={!!error} isRequired={isRequired}>
{label && (
<FormLabel htmlFor={name} isOptional={resolvedIsOptional}>
<LabelWithHelp termId={termId}>{label}</LabelWithHelp>
</FormLabel>
)}
<input
{...getInputProps({
id: name
})}
type="hidden"
name={name}
id={name}
value={controlValue}
/>
<Modal
open={open}
onOpenChange={(open) => {
if (!open) onCancel();
}}
>
<CommandTrigger
disabled={isReadOnly || inventoryCode === purchasingCode}
icon={<LuLanguages className="w-4 h-4 opacity-50" />}
ref={ref}
onClick={() => setOpen(true)}
>
{controlValue ? formatQuantity(controlValue) : "-"}
</CommandTrigger>
<ModalContent>
<ModalBody>
<VStack spacing={8}>
<VStack className="w-full text-center">
<ModalTitle className="w-full text-lg font-normal leading-normal">
{description}
</ModalTitle>
<div className="w-full">
<Button
onClick={switchDirection}
variant="secondary"
size="sm"
className="border-dashed"
>
<Trans>Switch</Trans>
<LuArrowRightLeft className="w-4 h-4 ml-1" />
</Button>
</div>
</VStack>
{conversionDirection ===
ConversionDirection.PurchasedToInventory ? (
<HStack className="w-full justify-around items-start">
<VStack spacing={1}>
<NumberField
value={1 / conversionFactor}
onChange={onPurchaseUnitChange}
formatOptions={SCALE_FORMAT}
>
<NumberInputGroup className="relative">
<NumberInput />
<NumberInputStepper>
<NumberIncrementStepper>
<LuChevronUp size="1em" strokeWidth="3" />
</NumberIncrementStepper>
<NumberDecrementStepper>
<LuChevronDown size="1em" strokeWidth="3" />
</NumberDecrementStepper>
</NumberInputStepper>
</NumberInputGroup>
</NumberField>
<span className="text-xs text-primary">
<Trans>Purchased</Trans>
</span>
</VStack>
<VStack className="w-auto pt-2">
<span className="font-mono text-xl">=</span>
</VStack>
<VStack spacing={1}>
<NumberField value={1}>
<NumberInputGroup className="relative">
<NumberInput isReadOnly />
</NumberInputGroup>
</NumberField>
<span className="text-xs text-muted-foreground ">
<Trans>Inventory</Trans>
</span>
</VStack>
</HStack>
) : (
<HStack className="w-full justify-around items-start">
<VStack spacing={1}>
<NumberField
value={conversionFactor}
onChange={onInventoryUnitChange}
formatOptions={SCALE_FORMAT}
>
<NumberInputGroup className="relative">
<NumberInput />
<NumberInputStepper>
<NumberIncrementStepper>
<LuChevronUp size="1em" strokeWidth="3" />
</NumberIncrementStepper>
<NumberDecrementStepper>
<LuChevronDown size="1em" strokeWidth="3" />
</NumberDecrementStepper>
</NumberInputStepper>
</NumberInputGroup>
</NumberField>
<span className="text-xs text-muted-foreground ">
<Trans>Inventory</Trans>
</span>
</VStack>
<VStack className="w-auto pt-2">
<span className="font-mono text-xl">=</span>
</VStack>
<VStack spacing={1}>
<NumberField value={1}>
<NumberInputGroup className="relative">
<NumberInput isReadOnly />
</NumberInputGroup>
</NumberField>
<span className="text-xs text-muted-foreground text-primary">
<Trans>Purchased</Trans>
</span>
</VStack>
</HStack>
)}
</VStack>
</ModalBody>
<ModalFooter>
<Button variant="secondary" onClick={onCancel}>
<Trans>Cancel</Trans>
</Button>
<Button onClick={onConfirm}>
<Trans>Confirm</Trans>
</Button>
</ModalFooter>
</ModalContent>
</Modal>
{helperText && <FormHelperText>{helperText}</FormHelperText>}
{error && <FormErrorMessage>{error}</FormErrorMessage>}
</FormControl>
);
}
);
ConversionFactor.displayName = "ConversionFactor";
export default ConversionFactor;