@roomwise/calc-engine 0.5.0 → 0.6.0

package/README.md

@@ -47,7 +47,7 @@ Lines are produced in this order: base cost, object rules (by `sortOrder`), mate
 - Base cost: `OBJECT` rules with `baseComponent: true`, one `BASE` line each. Only in `FULL`; a line that is `OK` with a zero amount is left out.
 - Object rules: the other `OBJECT` level rules, one line each.
 - Materials: for every room selection with a product, the `MATERIAL_TYPE` rule for the category and the product's material type is used if one exists, otherwise the `CATEGORY` rule. Without either, the line is `NOT_CALCULATED` (`RULE_NOT_FOUND`). Unknown or unavailable products give `UNAVAILABLE`. Each line carries [components](#line-components).
-- Engineering and additional: package items marked `includedInBase` become `INCLUDED` lines with a zero amount, and are skipped in `PARTIAL`. Options are priced by unit (`PIECE`, `ROOM_SQM`, `ROOM`, `PROJECT`). An option with `priceCoefficientKeys` is priced by the sum of those coefficients in dollars instead of `priceCents`; a missing coefficient gives an `ERROR` line (`UNKNOWN_COEFFICIENT`). An option whose `scopes` do not include the configuration scope is `UNAVAILABLE` with `OPTION_SCOPE_NOT_ALLOWED`.
+- Engineering and additional: package items marked `includedInBase` become `INCLUDED` lines with a zero amount, and are skipped in `PARTIAL`. Options are priced by unit (`PIECE`, `ROOM_SQM`, `ROOM`, `PROJECT`). An option has exactly one price source: `priceCents` with no `priceCoefficientKeys`, or `priceCents: null` with keys, in which case the unit price is the sum of those coefficients in dollars (`PricingDataSchema` rejects both and neither; read the price from the line's `unitPriceCents`). A missing coefficient gives an `ERROR` line (`UNKNOWN_COEFFICIENT`). An option whose `scopes` do not include the configuration scope is `UNAVAILABLE` with `OPTION_SCOPE_NOT_ALLOWED`.
 
 Result fields:
 
@@ -197,7 +197,7 @@ Every schema is a zod schema with an inferred type of the same name without the
 | `totalArea` variable | `totalAreaSqm` | `roomsFloorArea` |
 | Area warnings | `ROOMS_AREA_EXCEEDS_TOTAL`, `ROOMS_AREA_BELOW_TOTAL` | none |
 
-The base cost has no per-area rate table. It is built from rules whose formulas use the volumes of the rooms (`roomsFloorArea`, `roomsWallArea`, `roomsPerimeter`, `wetRoomsCount`) together with `finishLevel`, `scope` and coefficients.
+The base cost has no per-area rate table. It is built from rules whose formulas use the volumes of the rooms (`roomsFloorArea`, `roomsWallArea`, `roomsPuttyWallArea`, `roomsPerimeter`, `wetRoomsCount`) together with `finishLevel`, `scope` and coefficients.
 
 ### Line components
 
@@ -241,18 +241,20 @@ roomType == 'KITCHEN' ? ceil(floorArea / 2) : 0
 | object | `totalArea`, `balconyArea` | number; `totalArea` is `roomsFloorArea` in `PARTIAL` |
 | object | `scope` | `FULL`, `PARTIAL` |
 | object | `roomsFloorArea`, `roomsWallArea`, `roomsPerimeter` | number: sums over all rooms of `floorArea`, `wallArea` and `perimeter` |
+| object | `roomsPuttyWallArea` | number: sum of `wallArea` over rooms whose wall selections need putty (rooms without wall selections count) |
 | object | `wetRoomsCount` | number (bathrooms, kitchens and kitchen-living rooms) |
 | object | `balconyTiles` | boolean |
 | object | `finishLevel` | `ROUGH`, `PRE_FINISH`, `LIVED_IN` |
 | object | `roomsCount`, `bathroomsCount` | number (living rooms, bedrooms and kitchen-living rooms count as rooms) |
 | `SURFACE` rules only | `surfaceArea` | number: the area of the surface being prepared |
+| `SURFACE` rules only | `puttyRequired` | boolean: `true` when no category is selected on the surface or at least one selected category has `requiresPutty` (default `true`), taken from the selections, not from line status; booleans do not coerce, write `puttyRequired ? a : 0` |
 | cost and labor formulas of `CATEGORY` and `MATERIAL_TYPE` rules | `quantity` | the result of the quantity formula |
 
 Availability by rule level:
 
 - `OBJECT`: object variables only. `quantity` is not available.
 - `CATEGORY` and `MATERIAL_TYPE`: room, product and object variables. `quantity` is available in cost and labor formulas, not in the quantity formula. `laborFormula` sees the same variables as `costFormula`.
-- `SURFACE`: room and object variables plus `surfaceArea`. `quantity` and the product variables are not available.
+- `SURFACE`: room and object variables plus `surfaceArea` and `puttyRequired`. `quantity` and the product variables are not available.
 
 Coefficients are read as `coef.<key>`; keys come from the pricing data. The cost and labor formulas receive `quantity` unrounded, while the line shows it rounded to 3 decimals.
 

package/dist/index.cjs

@@ -51,6 +51,12 @@ function toCents(dollars) {
 	return cents;
 }
 //#endregion
+//#region src/variables/putty.ts
+function puttyRequiredOn(room, surface, categories) {
+	const selected = categories.filter((category) => category.surface === surface && room.selections.some((selection) => selection.categoryId === category.id));
+	return selected.length === 0 || selected.some((category) => category.requiresPutty);
+}
+//#endregion
 //#region src/variables/room.ts
 function roomVariables(room) {
 	const perimeter = 2 * (room.lengthM + room.widthM);
@@ -80,7 +86,7 @@ const WET_ROOMS = [
 function totalAreaOf(scope, totalAreaSqm, roomsFloorArea) {
 	return scope === "PARTIAL" || totalAreaSqm === null ? roomsFloorArea : totalAreaSqm;
 }
-function objectVariables(configuration) {
+function objectVariables(configuration, categories) {
 	const rooms = configuration.rooms.map(roomVariables);
 	const sum = (pick) => rooms.reduce((total, room) => total + pick(room), 0);
 	const roomsFloorArea = sum((room) => room.floorArea);
@@ -94,6 +100,7 @@ function objectVariables(configuration) {
 		bathroomsCount: configuration.rooms.filter((room) => room.roomTypeCode === "BATHROOM").length,
 		roomsFloorArea,
 		roomsWallArea: sum((room) => room.wallArea),
+		roomsPuttyWallArea: configuration.rooms.reduce((total, room) => puttyRequiredOn(room, "WALLS", categories) ? total + roomVariables(room).wallArea : total, 0),
 		roomsPerimeter: sum((room) => room.perimeter),
 		wetRoomsCount: rooms.filter((room) => WET_ROOMS.includes(room.roomType)).length
 	};
@@ -733,8 +740,11 @@ function applySurfacePrep(data, room, lines, objectScope) {
 	};
 	const surfaces = /* @__PURE__ */ new Map();
 	lines.forEach((line, index) => {
-		const surface = data.categories.find((category) => category.id === line.categoryId)?.surface;
-		if (line.status === "OK" && surface !== void 0 && surface !== "NONE") surfaces.set(surface, [...surfaces.get(surface) ?? [], index]);
+		const category = data.categories.find((item) => item.id === line.categoryId);
+		if (line.status === "OK" && category !== void 0 && category.surface !== "NONE") {
+			const surface = category.surface;
+			surfaces.set(surface, [...surfaces.get(surface) ?? [], index]);
+		}
 	});
 	for (const [surface, indexes] of surfaces) {
 		const rule = surfaceRuleOf(data, surface);
@@ -742,7 +752,8 @@ function applySurfacePrep(data, room, lines, objectScope) {
 		const outcome = runNumericFormula(rule.costFormula, {
 			variables: {
 				...variables,
-				surfaceArea: areas[surface]
+				surfaceArea: areas[surface],
+				puttyRequired: puttyRequiredOn(room, surface, data.categories)
 			},
 			coefficients: data.coefficients
 		});
@@ -1077,7 +1088,8 @@ const PricingRoomTypeSchema = zod.z.object({
 const PricingCategorySchema = zod.z.object({
 	id: zod.z.string(),
 	wastePercent: zod.z.number().min(0),
-	surface: SurfaceKindSchema
+	surface: SurfaceKindSchema,
+	requiresPutty: zod.z.boolean().default(true)
 });
 const PricingMaterialTypeSchema = zod.z.object({
 	id: zod.z.string(),
@@ -1099,11 +1111,11 @@ const PricingPackageItemSchema = zod.z.object({
 	priceCents: CentsSchema.nullable(),
 	unit: OptionUnitSchema.nullable()
 });
-const PricingOptionSchema = zod.z.object({
+const PricingOptionObjectSchema = zod.z.object({
 	id: zod.z.string(),
 	code: OptionCodeSchema.nullable(),
 	kind: OptionKindSchema,
-	priceCents: CentsSchema,
+	priceCents: CentsSchema.nullable(),
 	unit: OptionUnitSchema,
 	roomTypeCodes: zod.z.array(zod.z.string()),
 	priceCoefficientKeys: zod.z.array(zod.z.string()),
@@ -1112,6 +1124,26 @@ const PricingOptionSchema = zod.z.object({
 	maxQuantity: zod.z.int().nullable(),
 	available: zod.z.boolean()
 });
+function findOptionPriceSourceViolation(priceCents, priceCoefficientKeys) {
+	const hasKeys = priceCoefficientKeys.length > 0;
+	if (priceCents !== null && hasKeys) return {
+		path: "priceCents",
+		message: "priceCents must be null when priceCoefficientKeys is set"
+	};
+	if (priceCents === null && !hasKeys) return {
+		path: "priceCoefficientKeys",
+		message: "priceCoefficientKeys is required when priceCents is null"
+	};
+	return null;
+}
+const PricingOptionSchema = PricingOptionObjectSchema.superRefine((option, context) => {
+	const violation = findOptionPriceSourceViolation(option.priceCents, option.priceCoefficientKeys);
+	if (violation !== null) context.addIssue({
+		code: "custom",
+		path: [violation.path],
+		message: violation.message
+	});
+});
 const PricingDataSchema = zod.z.object({
 	version: zod.z.string().regex(/^[0-9a-f]{16}$/),
 	exchangeRate: ExchangeRateSchema.nullable(),
@@ -1191,6 +1223,7 @@ const RuleSampleSchema = zod.z.object({
 		wastePercent: zod.z.number().min(0)
 	}).optional(),
 	surfaceArea: zod.z.number().min(0).optional(),
+	puttyRequired: zod.z.boolean().optional(),
 	object: zod.z.object({
 		scope: ScopeSchema,
 		totalAreaSqm: zod.z.number().positive().nullable(),
@@ -1201,6 +1234,7 @@ const RuleSampleSchema = zod.z.object({
 		bathroomsCount: zod.z.int().min(0),
 		roomsFloorArea: zod.z.number().min(0),
 		roomsWallArea: zod.z.number().min(0),
+		roomsPuttyWallArea: zod.z.number().min(0).optional(),
 		roomsPerimeter: zod.z.number().min(0),
 		wetRoomsCount: zod.z.int().min(0)
 	})
@@ -1285,7 +1319,7 @@ function withKopecks(line, rate) {
 }
 function estimate(configuration, data) {
 	const rate = data.exchangeRate?.rate ?? null;
-	const variables = objectVariables(configuration);
+	const variables = objectVariables(configuration, data.categories);
 	const lines = [
 		...objectRuleLines(configuration, data, "BASE", variables),
 		...objectRuleLines(configuration, data, "OBJECT", variables),
@@ -1381,6 +1415,7 @@ function objectScope({ object }) {
 		bathroomsCount: object.bathroomsCount,
 		roomsFloorArea: object.roomsFloorArea,
 		roomsWallArea: object.roomsWallArea,
+		roomsPuttyWallArea: object.roomsPuttyWallArea ?? object.roomsWallArea,
 		roomsPerimeter: object.roomsPerimeter,
 		wetRoomsCount: object.wetRoomsCount
 	};
@@ -1396,7 +1431,8 @@ function scopeOf(level, sample) {
 		return { scope: {
 			...roomVariables(room),
 			...objectScope(sample),
-			surfaceArea
+			surfaceArea,
+			puttyRequired: sample.puttyRequired ?? true
 		} };
 	}
 	if (room === void 0 || product === void 0) return { error: {
@@ -1538,12 +1574,14 @@ const FORMULA_SCOPE_VARIABLES = {
 		enumeration("scope", ScopeSchema.options),
 		number("roomsFloorArea"),
 		number("roomsWallArea"),
+		number("roomsPuttyWallArea"),
 		number("roomsPerimeter"),
 		number("wetRoomsCount")
 	]
 };
 const FORMULA_QUANTITY_VARIABLE = number("quantity");
 const FORMULA_SURFACE_AREA_VARIABLE = number("surfaceArea");
+const FORMULA_PUTTY_REQUIRED_VARIABLE = boolean("puttyRequired");
 const FORMULA_VARIABLES = {
 	OBJECT: FORMULA_SCOPE_VARIABLES.object,
 	CATEGORY: [
@@ -1559,7 +1597,8 @@ const FORMULA_VARIABLES = {
 	SURFACE: [
 		...FORMULA_SCOPE_VARIABLES.room,
 		...FORMULA_SCOPE_VARIABLES.object,
-		FORMULA_SURFACE_AREA_VARIABLE
+		FORMULA_SURFACE_AREA_VARIABLE,
+		FORMULA_PUTTY_REQUIRED_VARIABLE
 	]
 };
 const ALL_VARIABLE_NAMES = new Set([...FORMULA_VARIABLES.CATEGORY, ...FORMULA_VARIABLES.SURFACE].map((variable) => variable.name));
@@ -1787,6 +1826,7 @@ exports.ExchangeRateSchema = ExchangeRateSchema;
 exports.FORMULA_FUNCTIONS = FORMULA_FUNCTIONS;
 exports.FORMULA_FUNCTION_TABLE = FORMULA_FUNCTION_TABLE;
 exports.FORMULA_LIMITS = FORMULA_LIMITS;
+exports.FORMULA_PUTTY_REQUIRED_VARIABLE = FORMULA_PUTTY_REQUIRED_VARIABLE;
 exports.FORMULA_QUANTITY_VARIABLE = FORMULA_QUANTITY_VARIABLE;
 exports.FORMULA_SCOPE_VARIABLES = FORMULA_SCOPE_VARIABLES;
 exports.FORMULA_SURFACE_AREA_VARIABLE = FORMULA_SURFACE_AREA_VARIABLE;
@@ -1826,12 +1866,14 @@ exports.checkLimits = checkLimits;
 exports.convertCentsToKopecks = convertCentsToKopecks;
 exports.estimate = estimate;
 exports.evaluate = evaluate;
+exports.findOptionPriceSourceViolation = findOptionPriceSourceViolation;
 exports.levenshtein = levenshtein;
 exports.objectVariables = objectVariables;
 exports.parse = parse;
 exports.previewRule = previewRule;
 exports.productVariables = productVariables;
 exports.productVariablesOf = productVariablesOf;
+exports.puttyRequiredOn = puttyRequiredOn;
 exports.roomVariables = roomVariables;
 exports.suggestNearest = suggestNearest;
 exports.toCents = toCents;

package/dist/index.d.cts

@@ -382,6 +382,7 @@ export declare const RuleSampleSchema: z.ZodObject<{
     wastePercent: z.ZodNumber;
   }, z.core.$strip>>;
   surfaceArea: z.ZodOptional<z.ZodNumber>;
+  puttyRequired: z.ZodOptional<z.ZodBoolean>;
   object: z.ZodObject<{
     scope: z.ZodEnum<{
       FULL: "FULL";
@@ -399,6 +400,7 @@ export declare const RuleSampleSchema: z.ZodObject<{
     bathroomsCount: z.ZodInt;
     roomsFloorArea: z.ZodNumber;
     roomsWallArea: z.ZodNumber;
+    roomsPuttyWallArea: z.ZodOptional<z.ZodNumber>;
     roomsPerimeter: z.ZodNumber;
     wetRoomsCount: z.ZodInt;
   }, z.core.$strip>;
@@ -487,6 +489,7 @@ export declare const PricingCategorySchema: z.ZodObject<{
     CEILING: "CEILING";
     NONE: "NONE";
   }>;
+  requiresPutty: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strip>;
 export type PricingCategory = z.infer<typeof PricingCategorySchema>;
 export declare const PricingMaterialTypeSchema: z.ZodObject<{
@@ -521,6 +524,10 @@ export declare const PricingPackageItemSchema: z.ZodObject<{
   }>>;
 }, z.core.$strip>;
 export type PricingPackageItem = z.infer<typeof PricingPackageItemSchema>;
+export declare function findOptionPriceSourceViolation(priceCents: number | null, priceCoefficientKeys: readonly string[]): {
+  path: 'priceCents' | 'priceCoefficientKeys';
+  message: string;
+} | null;
 export declare const PricingOptionSchema: z.ZodObject<{
   id: z.ZodString;
   code: z.ZodNullable<z.ZodEnum<{
@@ -530,7 +537,7 @@ export declare const PricingOptionSchema: z.ZodObject<{
     ENGINEERING: "ENGINEERING";
     ADDITIONAL: "ADDITIONAL";
   }>;
-  priceCents: z.ZodInt;
+  priceCents: z.ZodNullable<z.ZodInt>;
   unit: z.ZodEnum<{
     PIECE: "PIECE";
     ROOM_SQM: "ROOM_SQM";
@@ -616,6 +623,7 @@ export declare const PricingDataSchema: z.ZodObject<{
       CEILING: "CEILING";
       NONE: "NONE";
     }>;
+    requiresPutty: z.ZodDefault<z.ZodBoolean>;
   }, z.core.$strip>>;
   materialTypes: z.ZodArray<z.ZodObject<{
     id: z.ZodString;
@@ -655,7 +663,7 @@ export declare const PricingDataSchema: z.ZodObject<{
       ENGINEERING: "ENGINEERING";
       ADDITIONAL: "ADDITIONAL";
     }>;
-    priceCents: z.ZodInt;
+    priceCents: z.ZodNullable<z.ZodInt>;
     unit: z.ZodEnum<{
       PIECE: "PIECE";
       ROOM_SQM: "ROOM_SQM";
@@ -812,6 +820,7 @@ export interface FormulaVariable {
 export declare const FORMULA_SCOPE_VARIABLES: Record<FormulaScope, readonly FormulaVariable[]>;
 export declare const FORMULA_QUANTITY_VARIABLE: FormulaVariable;
 export declare const FORMULA_SURFACE_AREA_VARIABLE: FormulaVariable;
+export declare const FORMULA_PUTTY_REQUIRED_VARIABLE: FormulaVariable;
 export declare const FORMULA_VARIABLES: Record<RuleLevel, readonly FormulaVariable[]>;
 export interface ValidateFormulaInput {
   readonly level: RuleLevel;
@@ -843,11 +852,12 @@ export interface ObjectVariables {
   readonly bathroomsCount: number;
   readonly roomsFloorArea: number;
   readonly roomsWallArea: number;
+  readonly roomsPuttyWallArea: number;
   readonly roomsPerimeter: number;
   readonly wetRoomsCount: number;
 }
 export declare function totalAreaOf(scope: Scope, totalAreaSqm: number | null, roomsFloorArea: number): number;
-export declare function objectVariables(configuration: Configuration): ObjectVariables;
+export declare function objectVariables(configuration: Configuration, categories: readonly PricingCategory[]): ObjectVariables;
 //#endregion
 //#region src/variables/product.d.ts
 export interface ProductVariables {
@@ -858,6 +868,9 @@ export interface ProductVariables {
 export declare function productVariablesOf(product: Pick<PricingProduct, 'priceCents' | 'unit'>, wastePercent: number): ProductVariables;
 export declare function productVariables(product: PricingProduct, category: PricingCategory): ProductVariables;
 //#endregion
+//#region src/variables/putty.d.ts
+export declare function puttyRequiredOn(room: RoomConfiguration, surface: PricingCategory['surface'], categories: readonly PricingCategory[]): boolean;
+//#endregion
 //#region src/variables/room.d.ts
 export interface RoomVariables {
   readonly length: number;

package/dist/index.d.ts

@@ -382,6 +382,7 @@ export declare const RuleSampleSchema: z.ZodObject<{
     wastePercent: z.ZodNumber;
   }, z.core.$strip>>;
   surfaceArea: z.ZodOptional<z.ZodNumber>;
+  puttyRequired: z.ZodOptional<z.ZodBoolean>;
   object: z.ZodObject<{
     scope: z.ZodEnum<{
       FULL: "FULL";
@@ -399,6 +400,7 @@ export declare const RuleSampleSchema: z.ZodObject<{
     bathroomsCount: z.ZodInt;
     roomsFloorArea: z.ZodNumber;
     roomsWallArea: z.ZodNumber;
+    roomsPuttyWallArea: z.ZodOptional<z.ZodNumber>;
     roomsPerimeter: z.ZodNumber;
     wetRoomsCount: z.ZodInt;
   }, z.core.$strip>;
@@ -487,6 +489,7 @@ export declare const PricingCategorySchema: z.ZodObject<{
     CEILING: "CEILING";
     NONE: "NONE";
   }>;
+  requiresPutty: z.ZodDefault<z.ZodBoolean>;
 }, z.core.$strip>;
 export type PricingCategory = z.infer<typeof PricingCategorySchema>;
 export declare const PricingMaterialTypeSchema: z.ZodObject<{
@@ -521,6 +524,10 @@ export declare const PricingPackageItemSchema: z.ZodObject<{
   }>>;
 }, z.core.$strip>;
 export type PricingPackageItem = z.infer<typeof PricingPackageItemSchema>;
+export declare function findOptionPriceSourceViolation(priceCents: number | null, priceCoefficientKeys: readonly string[]): {
+  path: 'priceCents' | 'priceCoefficientKeys';
+  message: string;
+} | null;
 export declare const PricingOptionSchema: z.ZodObject<{
   id: z.ZodString;
   code: z.ZodNullable<z.ZodEnum<{
@@ -530,7 +537,7 @@ export declare const PricingOptionSchema: z.ZodObject<{
     ENGINEERING: "ENGINEERING";
     ADDITIONAL: "ADDITIONAL";
   }>;
-  priceCents: z.ZodInt;
+  priceCents: z.ZodNullable<z.ZodInt>;
   unit: z.ZodEnum<{
     PIECE: "PIECE";
     ROOM_SQM: "ROOM_SQM";
@@ -616,6 +623,7 @@ export declare const PricingDataSchema: z.ZodObject<{
       CEILING: "CEILING";
       NONE: "NONE";
     }>;
+    requiresPutty: z.ZodDefault<z.ZodBoolean>;
   }, z.core.$strip>>;
   materialTypes: z.ZodArray<z.ZodObject<{
     id: z.ZodString;
@@ -655,7 +663,7 @@ export declare const PricingDataSchema: z.ZodObject<{
       ENGINEERING: "ENGINEERING";
       ADDITIONAL: "ADDITIONAL";
     }>;
-    priceCents: z.ZodInt;
+    priceCents: z.ZodNullable<z.ZodInt>;
     unit: z.ZodEnum<{
       PIECE: "PIECE";
       ROOM_SQM: "ROOM_SQM";
@@ -812,6 +820,7 @@ export interface FormulaVariable {
 export declare const FORMULA_SCOPE_VARIABLES: Record<FormulaScope, readonly FormulaVariable[]>;
 export declare const FORMULA_QUANTITY_VARIABLE: FormulaVariable;
 export declare const FORMULA_SURFACE_AREA_VARIABLE: FormulaVariable;
+export declare const FORMULA_PUTTY_REQUIRED_VARIABLE: FormulaVariable;
 export declare const FORMULA_VARIABLES: Record<RuleLevel, readonly FormulaVariable[]>;
 export interface ValidateFormulaInput {
   readonly level: RuleLevel;
@@ -843,11 +852,12 @@ export interface ObjectVariables {
   readonly bathroomsCount: number;
   readonly roomsFloorArea: number;
   readonly roomsWallArea: number;
+  readonly roomsPuttyWallArea: number;
   readonly roomsPerimeter: number;
   readonly wetRoomsCount: number;
 }
 export declare function totalAreaOf(scope: Scope, totalAreaSqm: number | null, roomsFloorArea: number): number;
-export declare function objectVariables(configuration: Configuration): ObjectVariables;
+export declare function objectVariables(configuration: Configuration, categories: readonly PricingCategory[]): ObjectVariables;
 //#endregion
 //#region src/variables/product.d.ts
 export interface ProductVariables {
@@ -858,6 +868,9 @@ export interface ProductVariables {
 export declare function productVariablesOf(product: Pick<PricingProduct, 'priceCents' | 'unit'>, wastePercent: number): ProductVariables;
 export declare function productVariables(product: PricingProduct, category: PricingCategory): ProductVariables;
 //#endregion
+//#region src/variables/putty.d.ts
+export declare function puttyRequiredOn(room: RoomConfiguration, surface: PricingCategory['surface'], categories: readonly PricingCategory[]): boolean;
+//#endregion
 //#region src/variables/room.d.ts
 export interface RoomVariables {
   readonly length: number;

package/dist/index.js

@@ -26,6 +26,12 @@ function toCents(dollars) {
 	return cents;
 }
 //#endregion
+//#region src/variables/putty.ts
+function puttyRequiredOn(room, surface, categories) {
+	const selected = categories.filter((category) => category.surface === surface && room.selections.some((selection) => selection.categoryId === category.id));
+	return selected.length === 0 || selected.some((category) => category.requiresPutty);
+}
+//#endregion
 //#region src/variables/room.ts
 function roomVariables(room) {
 	const perimeter = 2 * (room.lengthM + room.widthM);
@@ -55,7 +61,7 @@ const WET_ROOMS = [
 function totalAreaOf(scope, totalAreaSqm, roomsFloorArea) {
 	return scope === "PARTIAL" || totalAreaSqm === null ? roomsFloorArea : totalAreaSqm;
 }
-function objectVariables(configuration) {
+function objectVariables(configuration, categories) {
 	const rooms = configuration.rooms.map(roomVariables);
 	const sum = (pick) => rooms.reduce((total, room) => total + pick(room), 0);
 	const roomsFloorArea = sum((room) => room.floorArea);
@@ -69,6 +75,7 @@ function objectVariables(configuration) {
 		bathroomsCount: configuration.rooms.filter((room) => room.roomTypeCode === "BATHROOM").length,
 		roomsFloorArea,
 		roomsWallArea: sum((room) => room.wallArea),
+		roomsPuttyWallArea: configuration.rooms.reduce((total, room) => puttyRequiredOn(room, "WALLS", categories) ? total + roomVariables(room).wallArea : total, 0),
 		roomsPerimeter: sum((room) => room.perimeter),
 		wetRoomsCount: rooms.filter((room) => WET_ROOMS.includes(room.roomType)).length
 	};
@@ -708,8 +715,11 @@ function applySurfacePrep(data, room, lines, objectScope) {
 	};
 	const surfaces = /* @__PURE__ */ new Map();
 	lines.forEach((line, index) => {
-		const surface = data.categories.find((category) => category.id === line.categoryId)?.surface;
-		if (line.status === "OK" && surface !== void 0 && surface !== "NONE") surfaces.set(surface, [...surfaces.get(surface) ?? [], index]);
+		const category = data.categories.find((item) => item.id === line.categoryId);
+		if (line.status === "OK" && category !== void 0 && category.surface !== "NONE") {
+			const surface = category.surface;
+			surfaces.set(surface, [...surfaces.get(surface) ?? [], index]);
+		}
 	});
 	for (const [surface, indexes] of surfaces) {
 		const rule = surfaceRuleOf(data, surface);
@@ -717,7 +727,8 @@ function applySurfacePrep(data, room, lines, objectScope) {
 		const outcome = runNumericFormula(rule.costFormula, {
 			variables: {
 				...variables,
-				surfaceArea: areas[surface]
+				surfaceArea: areas[surface],
+				puttyRequired: puttyRequiredOn(room, surface, data.categories)
 			},
 			coefficients: data.coefficients
 		});
@@ -1052,7 +1063,8 @@ const PricingRoomTypeSchema = z.object({
 const PricingCategorySchema = z.object({
 	id: z.string(),
 	wastePercent: z.number().min(0),
-	surface: SurfaceKindSchema
+	surface: SurfaceKindSchema,
+	requiresPutty: z.boolean().default(true)
 });
 const PricingMaterialTypeSchema = z.object({
 	id: z.string(),
@@ -1074,11 +1086,11 @@ const PricingPackageItemSchema = z.object({
 	priceCents: CentsSchema.nullable(),
 	unit: OptionUnitSchema.nullable()
 });
-const PricingOptionSchema = z.object({
+const PricingOptionObjectSchema = z.object({
 	id: z.string(),
 	code: OptionCodeSchema.nullable(),
 	kind: OptionKindSchema,
-	priceCents: CentsSchema,
+	priceCents: CentsSchema.nullable(),
 	unit: OptionUnitSchema,
 	roomTypeCodes: z.array(z.string()),
 	priceCoefficientKeys: z.array(z.string()),
@@ -1087,6 +1099,26 @@ const PricingOptionSchema = z.object({
 	maxQuantity: z.int().nullable(),
 	available: z.boolean()
 });
+function findOptionPriceSourceViolation(priceCents, priceCoefficientKeys) {
+	const hasKeys = priceCoefficientKeys.length > 0;
+	if (priceCents !== null && hasKeys) return {
+		path: "priceCents",
+		message: "priceCents must be null when priceCoefficientKeys is set"
+	};
+	if (priceCents === null && !hasKeys) return {
+		path: "priceCoefficientKeys",
+		message: "priceCoefficientKeys is required when priceCents is null"
+	};
+	return null;
+}
+const PricingOptionSchema = PricingOptionObjectSchema.superRefine((option, context) => {
+	const violation = findOptionPriceSourceViolation(option.priceCents, option.priceCoefficientKeys);
+	if (violation !== null) context.addIssue({
+		code: "custom",
+		path: [violation.path],
+		message: violation.message
+	});
+});
 const PricingDataSchema = z.object({
 	version: z.string().regex(/^[0-9a-f]{16}$/),
 	exchangeRate: ExchangeRateSchema.nullable(),
@@ -1166,6 +1198,7 @@ const RuleSampleSchema = z.object({
 		wastePercent: z.number().min(0)
 	}).optional(),
 	surfaceArea: z.number().min(0).optional(),
+	puttyRequired: z.boolean().optional(),
 	object: z.object({
 		scope: ScopeSchema,
 		totalAreaSqm: z.number().positive().nullable(),
@@ -1176,6 +1209,7 @@ const RuleSampleSchema = z.object({
 		bathroomsCount: z.int().min(0),
 		roomsFloorArea: z.number().min(0),
 		roomsWallArea: z.number().min(0),
+		roomsPuttyWallArea: z.number().min(0).optional(),
 		roomsPerimeter: z.number().min(0),
 		wetRoomsCount: z.int().min(0)
 	})
@@ -1260,7 +1294,7 @@ function withKopecks(line, rate) {
 }
 function estimate(configuration, data) {
 	const rate = data.exchangeRate?.rate ?? null;
-	const variables = objectVariables(configuration);
+	const variables = objectVariables(configuration, data.categories);
 	const lines = [
 		...objectRuleLines(configuration, data, "BASE", variables),
 		...objectRuleLines(configuration, data, "OBJECT", variables),
@@ -1356,6 +1390,7 @@ function objectScope({ object }) {
 		bathroomsCount: object.bathroomsCount,
 		roomsFloorArea: object.roomsFloorArea,
 		roomsWallArea: object.roomsWallArea,
+		roomsPuttyWallArea: object.roomsPuttyWallArea ?? object.roomsWallArea,
 		roomsPerimeter: object.roomsPerimeter,
 		wetRoomsCount: object.wetRoomsCount
 	};
@@ -1371,7 +1406,8 @@ function scopeOf(level, sample) {
 		return { scope: {
 			...roomVariables(room),
 			...objectScope(sample),
-			surfaceArea
+			surfaceArea,
+			puttyRequired: sample.puttyRequired ?? true
 		} };
 	}
 	if (room === void 0 || product === void 0) return { error: {
@@ -1513,12 +1549,14 @@ const FORMULA_SCOPE_VARIABLES = {
 		enumeration("scope", ScopeSchema.options),
 		number("roomsFloorArea"),
 		number("roomsWallArea"),
+		number("roomsPuttyWallArea"),
 		number("roomsPerimeter"),
 		number("wetRoomsCount")
 	]
 };
 const FORMULA_QUANTITY_VARIABLE = number("quantity");
 const FORMULA_SURFACE_AREA_VARIABLE = number("surfaceArea");
+const FORMULA_PUTTY_REQUIRED_VARIABLE = boolean("puttyRequired");
 const FORMULA_VARIABLES = {
 	OBJECT: FORMULA_SCOPE_VARIABLES.object,
 	CATEGORY: [
@@ -1534,7 +1572,8 @@ const FORMULA_VARIABLES = {
 	SURFACE: [
 		...FORMULA_SCOPE_VARIABLES.room,
 		...FORMULA_SCOPE_VARIABLES.object,
-		FORMULA_SURFACE_AREA_VARIABLE
+		FORMULA_SURFACE_AREA_VARIABLE,
+		FORMULA_PUTTY_REQUIRED_VARIABLE
 	]
 };
 const ALL_VARIABLE_NAMES = new Set([...FORMULA_VARIABLES.CATEGORY, ...FORMULA_VARIABLES.SURFACE].map((variable) => variable.name));
@@ -1749,4 +1788,4 @@ function validateFormula(input) {
 	};
 }
 //#endregion
-export { COEFFICIENT_NAMESPACE, CentsSchema, ConfigurationSchema, CurrencySchema, EstimateLineSchema, EstimateMessageSchema, EstimateSchema, EstimateTotalsSchema, EstimateWarningSchema, ExchangeRateSchema, FORMULA_FUNCTIONS, FORMULA_FUNCTION_TABLE, FORMULA_LIMITS, FORMULA_QUANTITY_VARIABLE, FORMULA_SCOPE_VARIABLES, FORMULA_SURFACE_AREA_VARIABLE, FORMULA_VARIABLES, FinishLevelSchema, LineComponentKindSchema, LineComponentSchema, LineStatusSchema, LocalizedTextSchema, OptionCodeSchema, OptionKindSchema, OptionSelectionSchema, OptionUnitSchema, PricingCategorySchema, PricingDataSchema, PricingLimitsSchema, PricingMaterialTypeSchema, PricingOptionSchema, PricingPackageItemSchema, PricingProductSchema, PricingRoomTypeSchema, PricingRuleSchema, ProductUnitSchema, RangeSchema, RateSourceSchema, RoomConfigurationSchema, RoomSelectionSchema, RoomTypeCodeSchema, RuleLevelSchema, RulePreviewSchema, RuleSampleSchema, ScopeSchema, SectionSchema, SectionTotalSchema, SurfaceKindSchema, checkLimits, convertCentsToKopecks, estimate, evaluate, levenshtein, objectVariables, parse, previewRule, productVariables, productVariablesOf, roomVariables, suggestNearest, toCents, totalAreaOf, validateFormula };
+export { COEFFICIENT_NAMESPACE, CentsSchema, ConfigurationSchema, CurrencySchema, EstimateLineSchema, EstimateMessageSchema, EstimateSchema, EstimateTotalsSchema, EstimateWarningSchema, ExchangeRateSchema, FORMULA_FUNCTIONS, FORMULA_FUNCTION_TABLE, FORMULA_LIMITS, FORMULA_PUTTY_REQUIRED_VARIABLE, FORMULA_QUANTITY_VARIABLE, FORMULA_SCOPE_VARIABLES, FORMULA_SURFACE_AREA_VARIABLE, FORMULA_VARIABLES, FinishLevelSchema, LineComponentKindSchema, LineComponentSchema, LineStatusSchema, LocalizedTextSchema, OptionCodeSchema, OptionKindSchema, OptionSelectionSchema, OptionUnitSchema, PricingCategorySchema, PricingDataSchema, PricingLimitsSchema, PricingMaterialTypeSchema, PricingOptionSchema, PricingPackageItemSchema, PricingProductSchema, PricingRoomTypeSchema, PricingRuleSchema, ProductUnitSchema, RangeSchema, RateSourceSchema, RoomConfigurationSchema, RoomSelectionSchema, RoomTypeCodeSchema, RuleLevelSchema, RulePreviewSchema, RuleSampleSchema, ScopeSchema, SectionSchema, SectionTotalSchema, SurfaceKindSchema, checkLimits, convertCentsToKopecks, estimate, evaluate, findOptionPriceSourceViolation, levenshtein, objectVariables, parse, previewRule, productVariables, productVariablesOf, puttyRequiredOn, roomVariables, suggestNearest, toCents, totalAreaOf, validateFormula };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@roomwise/calc-engine",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",