@roomwise/calc-engine 0.6.0 → 0.8.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 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`.
+- Engineering and additional: package items marked `includedInBase` become `INCLUDED` lines with a zero amount. In `PARTIAL` no package items are priced at all; the section holds only options. 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:
 
@@ -193,7 +193,7 @@ Every schema is a zod schema with an inferred type of the same name without the
 | `totalAreaSqm` | required | `null` |
 | `BASE` section | `OBJECT` rules with `baseComponent: true`, one line each | none |
 | Material lines | `MATERIAL` component only | `MATERIAL`, `LABOR` and `PREP` components |
-| Package items with `includedInBase` | `INCLUDED` lines | skipped |
+| Engineering package items | priced, `INCLUDED` with `includedInBase` | none |
 | `totalArea` variable | `totalAreaSqm` | `roomsFloorArea` |
 | Area warnings | `ROOMS_AREA_EXCEEDS_TOTAL`, `ROOMS_AREA_BELOW_TOTAL` | none |
 

package/dist/index.cjs

@@ -51,13 +51,10 @@ 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 surfaceAreaOf(variables, surface) {
+	return surface === "WALLS" ? variables.wallArea : variables.floorArea;
+}
 function roomVariables(room) {
 	const perimeter = 2 * (room.lengthM + room.widthM);
 	return {
@@ -72,6 +69,63 @@ function roomVariables(room) {
 	};
 }
 //#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/share.ts
+function isShareSurface(surface) {
+	return surface === "WALLS" || surface === "FLOOR";
+}
+function surfaceShares(room, surface, categories) {
+	const selections = room.selections.filter((selection) => selection.productId !== null && categories.some((category) => category.id === selection.categoryId && category.surface === surface));
+	return {
+		selections,
+		shared: selections.some((selection) => selection.areaShare !== void 0),
+		complete: selections.every((selection) => selection.areaShare !== void 0),
+		totalPercent: selections.reduce((sum, selection) => sum + (selection.areaShare ?? 0), 0)
+	};
+}
+function areaShareOf(selection) {
+	return selection.areaShare === void 0 ? 1 : selection.areaShare / 100;
+}
+function areaShareError(room, selection, categories) {
+	const category = categories.find((item) => item.id === selection.categoryId);
+	if (category === void 0) return null;
+	if (!isShareSurface(category.surface)) return selection.areaShare === void 0 ? null : {
+		code: "AREA_SHARE_NOT_ALLOWED",
+		params: {
+			categoryId: category.id,
+			surface: category.surface
+		}
+	};
+	const shares = surfaceShares(room, category.surface, categories);
+	const params = {
+		roomClientId: room.clientId,
+		surface: category.surface
+	};
+	if (shares.shared && !shares.complete) return {
+		code: "AREA_SHARE_MISSING",
+		params
+	};
+	if (shares.totalPercent > 100) return {
+		code: "AREA_SHARE_EXCEEDS_SURFACE",
+		params: {
+			...params,
+			percent: shares.totalPercent
+		}
+	};
+	return null;
+}
+function puttyShareOn(room, surface, categories) {
+	const shares = surface === "WALLS" ? surfaceShares(room, surface, categories) : null;
+	if (shares === null || !shares.shared) return puttyRequiredOn(room, surface, categories) ? 1 : 0;
+	const needing = shares.selections.filter((selection) => categories.find((category) => category.id === selection.categoryId)?.requiresPutty);
+	return Math.min(1, needing.reduce((sum, selection) => sum + areaShareOf(selection), 0));
+}
+//#endregion
 //#region src/variables/object.ts
 const COUNTED_AS_ROOMS = [
 	"LIVING_ROOM",
@@ -100,7 +154,7 @@ function objectVariables(configuration, categories) {
 		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),
+		roomsPuttyWallArea: configuration.rooms.reduce((total, room) => total + roomVariables(room).wallArea * puttyShareOn(room, "WALLS", categories), 0),
 		roomsPerimeter: sum((room) => room.perimeter),
 		wetRoomsCount: rooms.filter((room) => WET_ROOMS.includes(room.roomType)).length
 	};
@@ -268,7 +322,9 @@ function packageLine(configuration, item) {
 	}, item.priceCents / 100 * quantity);
 }
 function engineeringLines(configuration, data) {
-	return [...(configuration.scope === "PARTIAL" ? data.packageItems.filter((item) => !item.includedInBase) : data.packageItems).map((item) => packageLine(configuration, item)), ...optionLines(configuration, data, "ENGINEERING")];
+	const options = optionLines(configuration, data, "ENGINEERING");
+	if (configuration.scope === "PARTIAL") return options;
+	return [...data.packageItems.map((item) => packageLine(configuration, item)), ...options];
 }
 //#endregion
 //#region src/formula/language.ts
@@ -733,11 +789,6 @@ function applySurfacePrep(data, room, lines, objectScope) {
 		...roomVariables(room),
 		...objectScope
 	};
-	const areas = {
-		FLOOR: variables.floorArea,
-		CEILING: variables.floorArea,
-		WALLS: variables.wallArea
-	};
 	const surfaces = /* @__PURE__ */ new Map();
 	lines.forEach((line, index) => {
 		const category = data.categories.find((item) => item.id === line.categoryId);
@@ -749,11 +800,14 @@ function applySurfacePrep(data, room, lines, objectScope) {
 	for (const [surface, indexes] of surfaces) {
 		const rule = surfaceRuleOf(data, surface);
 		if (rule === void 0) continue;
+		const surfaceArea = surfaceAreaOf(variables, surface);
+		const puttyShare = puttyShareOn(room, surface, data.categories);
 		const outcome = runNumericFormula(rule.costFormula, {
 			variables: {
 				...variables,
-				surfaceArea: areas[surface],
-				puttyRequired: puttyRequiredOn(room, surface, data.categories)
+				surfaceArea,
+				puttyRequired: puttyShare > 0,
+				puttyArea: surfaceArea * puttyShare
 			},
 			coefficients: data.coefficients
 		});
@@ -786,7 +840,9 @@ function selectRule(data, categoryId, materialTypeId) {
 	const rules = data.rules.filter(isMaterialRule);
 	return rules.find((rule) => rule.level === "MATERIAL_TYPE" && rule.categoryId === categoryId && rule.materialTypeId === materialTypeId) ?? rules.find((rule) => rule.level === "CATEGORY" && rule.categoryId === categoryId);
 }
-function materialLine(configuration, data, room, categoryId, productId, objectScope) {
+function materialLine(configuration, data, room, selection, objectScope) {
+	const { categoryId } = selection;
+	const productId = selection.productId;
 	const init = {
 		id: lineId("MATERIALS", room.clientId, categoryId),
 		section: "MATERIALS",
@@ -794,6 +850,8 @@ function materialLine(configuration, data, room, categoryId, productId, objectSc
 		categoryId,
 		productId
 	};
+	const shareError = areaShareError(room, selection, data.categories);
+	if (shareError !== null) return failedLine(init, "ERROR", shareError);
 	const category = data.categories.find((item) => item.id === categoryId);
 	const product = data.products.find((item) => item.id === productId && item.categoryId === categoryId);
 	if (product === void 0 || category === void 0 || !product.available) return failedLine(init, "UNAVAILABLE", {
@@ -815,8 +873,12 @@ function materialLine(configuration, data, room, categoryId, productId, objectSc
 			materialTypeId: product.materialTypeId
 		}
 	});
+	const base = roomVariables(room);
+	const share = areaShareOf(selection);
 	const variables = {
-		...roomVariables(room),
+		...base,
+		wallArea: category.surface === "WALLS" ? base.wallArea * share : base.wallArea,
+		floorArea: category.surface === "FLOOR" ? base.floorArea * share : base.floorArea,
 		...productVariables(product, category),
 		...objectScope
 	};
@@ -886,7 +948,7 @@ function materialLine(configuration, data, room, categoryId, productId, objectSc
 }
 function materialLines(configuration, data, objectScope) {
 	return configuration.rooms.flatMap((room) => {
-		const lines = room.selections.flatMap(({ categoryId, productId }) => productId === null ? [] : [materialLine(configuration, data, room, categoryId, productId, objectScope)]);
+		const lines = room.selections.flatMap((selection) => selection.productId === null ? [] : [materialLine(configuration, data, room, selection, objectScope)]);
 		return configuration.scope === "PARTIAL" ? applySurfacePrep(data, room, lines, objectScope) : lines;
 	});
 }
@@ -984,7 +1046,8 @@ const RangeSchema = zod.z.object({
 //#region src/schemas/configuration.ts
 const RoomSelectionSchema = zod.z.object({
 	categoryId: zod.z.string(),
-	productId: zod.z.string().nullable()
+	productId: zod.z.string().nullable(),
+	areaShare: zod.z.int().min(1).max(100).optional()
 });
 const RoomConfigurationSchema = zod.z.object({
 	clientId: zod.z.string(),
@@ -1224,6 +1287,7 @@ const RuleSampleSchema = zod.z.object({
 	}).optional(),
 	surfaceArea: zod.z.number().min(0).optional(),
 	puttyRequired: zod.z.boolean().optional(),
+	puttyArea: zod.z.number().min(0).optional(),
 	object: zod.z.object({
 		scope: ScopeSchema,
 		totalAreaSqm: zod.z.number().positive().nullable(),
@@ -1302,10 +1366,32 @@ function roomsAreaWarnings(configuration, limits) {
 		params: { missingSqm }
 	}] : [];
 }
-function estimateWarnings(lines, configuration, rate, limits) {
+const SHARE_SURFACES = ["WALLS", "FLOOR"];
+function areaShareWarnings(configuration, categories) {
+	return configuration.rooms.flatMap((room) => {
+		const variables = roomVariables(room);
+		return SHARE_SURFACES.flatMap((surface) => {
+			const shares = surfaceShares(room, surface, categories);
+			if (!shares.shared || !shares.complete || shares.totalPercent >= 100) return [];
+			const percent = 100 - shares.totalPercent;
+			const area = surfaceAreaOf(variables, surface);
+			return [{
+				code: "AREA_SHARE_UNALLOCATED",
+				params: {
+					roomClientId: room.clientId,
+					surface,
+					percent,
+					sqm: roundArea(area * percent / 100)
+				}
+			}];
+		});
+	});
+}
+function estimateWarnings(lines, configuration, rate, data) {
 	return [
 		...collectWarnings(lines),
-		...roomsAreaWarnings(configuration, limits),
+		...roomsAreaWarnings(configuration, data.limits),
+		...areaShareWarnings(configuration, data.categories),
 		...configuration.currency === "UAH" && rate === null ? [{ code: "EXCHANGE_RATE_UNAVAILABLE" }] : []
 	];
 }
@@ -1333,7 +1419,7 @@ function estimate(configuration, data) {
 		exchangeRate: data.exchangeRate,
 		lines,
 		totals: computeTotals(lines, rate !== null),
-		warnings: estimateWarnings(lines, configuration, rate, data.limits),
+		warnings: estimateWarnings(lines, configuration, rate, data),
 		incomplete: isIncomplete(lines)
 	};
 }
@@ -1428,11 +1514,13 @@ function scopeOf(level, sample) {
 			code: "SAMPLE_INCOMPLETE",
 			params: { missing: room === void 0 ? "room" : "surfaceArea" }
 		} };
+		const puttyRequired = sample.puttyRequired ?? true;
 		return { scope: {
 			...roomVariables(room),
 			...objectScope(sample),
 			surfaceArea,
-			puttyRequired: sample.puttyRequired ?? true
+			puttyRequired,
+			puttyArea: sample.puttyArea ?? (puttyRequired ? surfaceArea : 0)
 		} };
 	}
 	if (room === void 0 || product === void 0) return { error: {
@@ -1581,6 +1669,7 @@ const FORMULA_SCOPE_VARIABLES = {
 };
 const FORMULA_QUANTITY_VARIABLE = number("quantity");
 const FORMULA_SURFACE_AREA_VARIABLE = number("surfaceArea");
+const FORMULA_PUTTY_AREA_VARIABLE = number("puttyArea");
 const FORMULA_PUTTY_REQUIRED_VARIABLE = boolean("puttyRequired");
 const FORMULA_VARIABLES = {
 	OBJECT: FORMULA_SCOPE_VARIABLES.object,
@@ -1598,7 +1687,8 @@ const FORMULA_VARIABLES = {
 		...FORMULA_SCOPE_VARIABLES.room,
 		...FORMULA_SCOPE_VARIABLES.object,
 		FORMULA_SURFACE_AREA_VARIABLE,
-		FORMULA_PUTTY_REQUIRED_VARIABLE
+		FORMULA_PUTTY_REQUIRED_VARIABLE,
+		FORMULA_PUTTY_AREA_VARIABLE
 	]
 };
 const ALL_VARIABLE_NAMES = new Set([...FORMULA_VARIABLES.CATEGORY, ...FORMULA_VARIABLES.SURFACE].map((variable) => variable.name));
@@ -1826,6 +1916,7 @@ exports.ExchangeRateSchema = ExchangeRateSchema;
 exports.FORMULA_FUNCTIONS = FORMULA_FUNCTIONS;
 exports.FORMULA_FUNCTION_TABLE = FORMULA_FUNCTION_TABLE;
 exports.FORMULA_LIMITS = FORMULA_LIMITS;
+exports.FORMULA_PUTTY_AREA_VARIABLE = FORMULA_PUTTY_AREA_VARIABLE;
 exports.FORMULA_PUTTY_REQUIRED_VARIABLE = FORMULA_PUTTY_REQUIRED_VARIABLE;
 exports.FORMULA_QUANTITY_VARIABLE = FORMULA_QUANTITY_VARIABLE;
 exports.FORMULA_SCOPE_VARIABLES = FORMULA_SCOPE_VARIABLES;
@@ -1862,11 +1953,14 @@ exports.ScopeSchema = ScopeSchema;
 exports.SectionSchema = SectionSchema;
 exports.SectionTotalSchema = SectionTotalSchema;
 exports.SurfaceKindSchema = SurfaceKindSchema;
+exports.areaShareError = areaShareError;
+exports.areaShareOf = areaShareOf;
 exports.checkLimits = checkLimits;
 exports.convertCentsToKopecks = convertCentsToKopecks;
 exports.estimate = estimate;
 exports.evaluate = evaluate;
 exports.findOptionPriceSourceViolation = findOptionPriceSourceViolation;
+exports.isShareSurface = isShareSurface;
 exports.levenshtein = levenshtein;
 exports.objectVariables = objectVariables;
 exports.parse = parse;
@@ -1874,8 +1968,11 @@ exports.previewRule = previewRule;
 exports.productVariables = productVariables;
 exports.productVariablesOf = productVariablesOf;
 exports.puttyRequiredOn = puttyRequiredOn;
+exports.puttyShareOn = puttyShareOn;
 exports.roomVariables = roomVariables;
 exports.suggestNearest = suggestNearest;
+exports.surfaceAreaOf = surfaceAreaOf;
+exports.surfaceShares = surfaceShares;
 exports.toCents = toCents;
 exports.totalAreaOf = totalAreaOf;
 exports.validateFormula = validateFormula;

package/dist/index.d.cts

@@ -106,6 +106,7 @@ export type Range = z.infer<typeof RangeSchema>;
 export declare const RoomSelectionSchema: z.ZodObject<{
   categoryId: z.ZodString;
   productId: z.ZodNullable<z.ZodString>;
+  areaShare: z.ZodOptional<z.ZodInt>;
 }, z.core.$strip>;
 export type RoomSelection = z.infer<typeof RoomSelectionSchema>;
 export declare const RoomConfigurationSchema: z.ZodObject<{
@@ -127,6 +128,7 @@ export declare const RoomConfigurationSchema: z.ZodObject<{
   selections: z.ZodArray<z.ZodObject<{
     categoryId: z.ZodString;
     productId: z.ZodNullable<z.ZodString>;
+    areaShare: z.ZodOptional<z.ZodInt>;
   }, z.core.$strip>>;
 }, z.core.$strip>;
 export type RoomConfiguration = z.infer<typeof RoomConfigurationSchema>;
@@ -168,6 +170,7 @@ export declare const ConfigurationSchema: z.ZodObject<{
     selections: z.ZodArray<z.ZodObject<{
       categoryId: z.ZodString;
       productId: z.ZodNullable<z.ZodString>;
+      areaShare: z.ZodOptional<z.ZodInt>;
     }, z.core.$strip>>;
   }, z.core.$strip>>;
   options: z.ZodArray<z.ZodObject<{
@@ -383,6 +386,7 @@ export declare const RuleSampleSchema: z.ZodObject<{
   }, z.core.$strip>>;
   surfaceArea: z.ZodOptional<z.ZodNumber>;
   puttyRequired: z.ZodOptional<z.ZodBoolean>;
+  puttyArea: z.ZodOptional<z.ZodNumber>;
   object: z.ZodObject<{
     scope: z.ZodEnum<{
       FULL: "FULL";
@@ -820,6 +824,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_AREA_VARIABLE: FormulaVariable;
 export declare const FORMULA_PUTTY_REQUIRED_VARIABLE: FormulaVariable;
 export declare const FORMULA_VARIABLES: Record<RuleLevel, readonly FormulaVariable[]>;
 export interface ValidateFormulaInput {
@@ -882,6 +887,22 @@ export interface RoomVariables {
   readonly heatedFloor: boolean;
   readonly roomType: RoomTypeCode;
 }
+export type MeasuredSurface = 'FLOOR' | 'WALLS' | 'CEILING';
+export declare function surfaceAreaOf(variables: Pick<RoomVariables, 'floorArea' | 'wallArea'>, surface: MeasuredSurface): number;
 export type RoomDimensions = Pick<RoomConfiguration, 'roomTypeCode' | 'lengthM' | 'widthM' | 'heightM' | 'heatedFloor'>;
 export declare function roomVariables(room: RoomDimensions): RoomVariables;
+//#endregion
+//#region src/variables/share.d.ts
+export type ShareSurface = 'WALLS' | 'FLOOR';
+export interface SurfaceShares {
+  readonly selections: readonly RoomSelection[];
+  readonly shared: boolean;
+  readonly complete: boolean;
+  readonly totalPercent: number;
+}
+export declare function isShareSurface(surface: PricingCategory['surface']): surface is ShareSurface;
+export declare function surfaceShares(room: RoomConfiguration, surface: ShareSurface, categories: readonly PricingCategory[]): SurfaceShares;
+export declare function areaShareOf(selection: RoomSelection): number;
+export declare function areaShareError(room: RoomConfiguration, selection: RoomSelection, categories: readonly PricingCategory[]): EstimateMessage | null;
+export declare function puttyShareOn(room: RoomConfiguration, surface: MeasuredSurface, categories: readonly PricingCategory[]): number;
 //#endregion

package/dist/index.d.ts

@@ -106,6 +106,7 @@ export type Range = z.infer<typeof RangeSchema>;
 export declare const RoomSelectionSchema: z.ZodObject<{
   categoryId: z.ZodString;
   productId: z.ZodNullable<z.ZodString>;
+  areaShare: z.ZodOptional<z.ZodInt>;
 }, z.core.$strip>;
 export type RoomSelection = z.infer<typeof RoomSelectionSchema>;
 export declare const RoomConfigurationSchema: z.ZodObject<{
@@ -127,6 +128,7 @@ export declare const RoomConfigurationSchema: z.ZodObject<{
   selections: z.ZodArray<z.ZodObject<{
     categoryId: z.ZodString;
     productId: z.ZodNullable<z.ZodString>;
+    areaShare: z.ZodOptional<z.ZodInt>;
   }, z.core.$strip>>;
 }, z.core.$strip>;
 export type RoomConfiguration = z.infer<typeof RoomConfigurationSchema>;
@@ -168,6 +170,7 @@ export declare const ConfigurationSchema: z.ZodObject<{
     selections: z.ZodArray<z.ZodObject<{
       categoryId: z.ZodString;
       productId: z.ZodNullable<z.ZodString>;
+      areaShare: z.ZodOptional<z.ZodInt>;
     }, z.core.$strip>>;
   }, z.core.$strip>>;
   options: z.ZodArray<z.ZodObject<{
@@ -383,6 +386,7 @@ export declare const RuleSampleSchema: z.ZodObject<{
   }, z.core.$strip>>;
   surfaceArea: z.ZodOptional<z.ZodNumber>;
   puttyRequired: z.ZodOptional<z.ZodBoolean>;
+  puttyArea: z.ZodOptional<z.ZodNumber>;
   object: z.ZodObject<{
     scope: z.ZodEnum<{
       FULL: "FULL";
@@ -820,6 +824,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_AREA_VARIABLE: FormulaVariable;
 export declare const FORMULA_PUTTY_REQUIRED_VARIABLE: FormulaVariable;
 export declare const FORMULA_VARIABLES: Record<RuleLevel, readonly FormulaVariable[]>;
 export interface ValidateFormulaInput {
@@ -882,6 +887,22 @@ export interface RoomVariables {
   readonly heatedFloor: boolean;
   readonly roomType: RoomTypeCode;
 }
+export type MeasuredSurface = 'FLOOR' | 'WALLS' | 'CEILING';
+export declare function surfaceAreaOf(variables: Pick<RoomVariables, 'floorArea' | 'wallArea'>, surface: MeasuredSurface): number;
 export type RoomDimensions = Pick<RoomConfiguration, 'roomTypeCode' | 'lengthM' | 'widthM' | 'heightM' | 'heatedFloor'>;
 export declare function roomVariables(room: RoomDimensions): RoomVariables;
+//#endregion
+//#region src/variables/share.d.ts
+export type ShareSurface = 'WALLS' | 'FLOOR';
+export interface SurfaceShares {
+  readonly selections: readonly RoomSelection[];
+  readonly shared: boolean;
+  readonly complete: boolean;
+  readonly totalPercent: number;
+}
+export declare function isShareSurface(surface: PricingCategory['surface']): surface is ShareSurface;
+export declare function surfaceShares(room: RoomConfiguration, surface: ShareSurface, categories: readonly PricingCategory[]): SurfaceShares;
+export declare function areaShareOf(selection: RoomSelection): number;
+export declare function areaShareError(room: RoomConfiguration, selection: RoomSelection, categories: readonly PricingCategory[]): EstimateMessage | null;
+export declare function puttyShareOn(room: RoomConfiguration, surface: MeasuredSurface, categories: readonly PricingCategory[]): number;
 //#endregion

package/dist/index.js

@@ -26,13 +26,10 @@ 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 surfaceAreaOf(variables, surface) {
+	return surface === "WALLS" ? variables.wallArea : variables.floorArea;
+}
 function roomVariables(room) {
 	const perimeter = 2 * (room.lengthM + room.widthM);
 	return {
@@ -47,6 +44,63 @@ function roomVariables(room) {
 	};
 }
 //#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/share.ts
+function isShareSurface(surface) {
+	return surface === "WALLS" || surface === "FLOOR";
+}
+function surfaceShares(room, surface, categories) {
+	const selections = room.selections.filter((selection) => selection.productId !== null && categories.some((category) => category.id === selection.categoryId && category.surface === surface));
+	return {
+		selections,
+		shared: selections.some((selection) => selection.areaShare !== void 0),
+		complete: selections.every((selection) => selection.areaShare !== void 0),
+		totalPercent: selections.reduce((sum, selection) => sum + (selection.areaShare ?? 0), 0)
+	};
+}
+function areaShareOf(selection) {
+	return selection.areaShare === void 0 ? 1 : selection.areaShare / 100;
+}
+function areaShareError(room, selection, categories) {
+	const category = categories.find((item) => item.id === selection.categoryId);
+	if (category === void 0) return null;
+	if (!isShareSurface(category.surface)) return selection.areaShare === void 0 ? null : {
+		code: "AREA_SHARE_NOT_ALLOWED",
+		params: {
+			categoryId: category.id,
+			surface: category.surface
+		}
+	};
+	const shares = surfaceShares(room, category.surface, categories);
+	const params = {
+		roomClientId: room.clientId,
+		surface: category.surface
+	};
+	if (shares.shared && !shares.complete) return {
+		code: "AREA_SHARE_MISSING",
+		params
+	};
+	if (shares.totalPercent > 100) return {
+		code: "AREA_SHARE_EXCEEDS_SURFACE",
+		params: {
+			...params,
+			percent: shares.totalPercent
+		}
+	};
+	return null;
+}
+function puttyShareOn(room, surface, categories) {
+	const shares = surface === "WALLS" ? surfaceShares(room, surface, categories) : null;
+	if (shares === null || !shares.shared) return puttyRequiredOn(room, surface, categories) ? 1 : 0;
+	const needing = shares.selections.filter((selection) => categories.find((category) => category.id === selection.categoryId)?.requiresPutty);
+	return Math.min(1, needing.reduce((sum, selection) => sum + areaShareOf(selection), 0));
+}
+//#endregion
 //#region src/variables/object.ts
 const COUNTED_AS_ROOMS = [
 	"LIVING_ROOM",
@@ -75,7 +129,7 @@ function objectVariables(configuration, categories) {
 		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),
+		roomsPuttyWallArea: configuration.rooms.reduce((total, room) => total + roomVariables(room).wallArea * puttyShareOn(room, "WALLS", categories), 0),
 		roomsPerimeter: sum((room) => room.perimeter),
 		wetRoomsCount: rooms.filter((room) => WET_ROOMS.includes(room.roomType)).length
 	};
@@ -243,7 +297,9 @@ function packageLine(configuration, item) {
 	}, item.priceCents / 100 * quantity);
 }
 function engineeringLines(configuration, data) {
-	return [...(configuration.scope === "PARTIAL" ? data.packageItems.filter((item) => !item.includedInBase) : data.packageItems).map((item) => packageLine(configuration, item)), ...optionLines(configuration, data, "ENGINEERING")];
+	const options = optionLines(configuration, data, "ENGINEERING");
+	if (configuration.scope === "PARTIAL") return options;
+	return [...data.packageItems.map((item) => packageLine(configuration, item)), ...options];
 }
 //#endregion
 //#region src/formula/language.ts
@@ -708,11 +764,6 @@ function applySurfacePrep(data, room, lines, objectScope) {
 		...roomVariables(room),
 		...objectScope
 	};
-	const areas = {
-		FLOOR: variables.floorArea,
-		CEILING: variables.floorArea,
-		WALLS: variables.wallArea
-	};
 	const surfaces = /* @__PURE__ */ new Map();
 	lines.forEach((line, index) => {
 		const category = data.categories.find((item) => item.id === line.categoryId);
@@ -724,11 +775,14 @@ function applySurfacePrep(data, room, lines, objectScope) {
 	for (const [surface, indexes] of surfaces) {
 		const rule = surfaceRuleOf(data, surface);
 		if (rule === void 0) continue;
+		const surfaceArea = surfaceAreaOf(variables, surface);
+		const puttyShare = puttyShareOn(room, surface, data.categories);
 		const outcome = runNumericFormula(rule.costFormula, {
 			variables: {
 				...variables,
-				surfaceArea: areas[surface],
-				puttyRequired: puttyRequiredOn(room, surface, data.categories)
+				surfaceArea,
+				puttyRequired: puttyShare > 0,
+				puttyArea: surfaceArea * puttyShare
 			},
 			coefficients: data.coefficients
 		});
@@ -761,7 +815,9 @@ function selectRule(data, categoryId, materialTypeId) {
 	const rules = data.rules.filter(isMaterialRule);
 	return rules.find((rule) => rule.level === "MATERIAL_TYPE" && rule.categoryId === categoryId && rule.materialTypeId === materialTypeId) ?? rules.find((rule) => rule.level === "CATEGORY" && rule.categoryId === categoryId);
 }
-function materialLine(configuration, data, room, categoryId, productId, objectScope) {
+function materialLine(configuration, data, room, selection, objectScope) {
+	const { categoryId } = selection;
+	const productId = selection.productId;
 	const init = {
 		id: lineId("MATERIALS", room.clientId, categoryId),
 		section: "MATERIALS",
@@ -769,6 +825,8 @@ function materialLine(configuration, data, room, categoryId, productId, objectSc
 		categoryId,
 		productId
 	};
+	const shareError = areaShareError(room, selection, data.categories);
+	if (shareError !== null) return failedLine(init, "ERROR", shareError);
 	const category = data.categories.find((item) => item.id === categoryId);
 	const product = data.products.find((item) => item.id === productId && item.categoryId === categoryId);
 	if (product === void 0 || category === void 0 || !product.available) return failedLine(init, "UNAVAILABLE", {
@@ -790,8 +848,12 @@ function materialLine(configuration, data, room, categoryId, productId, objectSc
 			materialTypeId: product.materialTypeId
 		}
 	});
+	const base = roomVariables(room);
+	const share = areaShareOf(selection);
 	const variables = {
-		...roomVariables(room),
+		...base,
+		wallArea: category.surface === "WALLS" ? base.wallArea * share : base.wallArea,
+		floorArea: category.surface === "FLOOR" ? base.floorArea * share : base.floorArea,
 		...productVariables(product, category),
 		...objectScope
 	};
@@ -861,7 +923,7 @@ function materialLine(configuration, data, room, categoryId, productId, objectSc
 }
 function materialLines(configuration, data, objectScope) {
 	return configuration.rooms.flatMap((room) => {
-		const lines = room.selections.flatMap(({ categoryId, productId }) => productId === null ? [] : [materialLine(configuration, data, room, categoryId, productId, objectScope)]);
+		const lines = room.selections.flatMap((selection) => selection.productId === null ? [] : [materialLine(configuration, data, room, selection, objectScope)]);
 		return configuration.scope === "PARTIAL" ? applySurfacePrep(data, room, lines, objectScope) : lines;
 	});
 }
@@ -959,7 +1021,8 @@ const RangeSchema = z.object({
 //#region src/schemas/configuration.ts
 const RoomSelectionSchema = z.object({
 	categoryId: z.string(),
-	productId: z.string().nullable()
+	productId: z.string().nullable(),
+	areaShare: z.int().min(1).max(100).optional()
 });
 const RoomConfigurationSchema = z.object({
 	clientId: z.string(),
@@ -1199,6 +1262,7 @@ const RuleSampleSchema = z.object({
 	}).optional(),
 	surfaceArea: z.number().min(0).optional(),
 	puttyRequired: z.boolean().optional(),
+	puttyArea: z.number().min(0).optional(),
 	object: z.object({
 		scope: ScopeSchema,
 		totalAreaSqm: z.number().positive().nullable(),
@@ -1277,10 +1341,32 @@ function roomsAreaWarnings(configuration, limits) {
 		params: { missingSqm }
 	}] : [];
 }
-function estimateWarnings(lines, configuration, rate, limits) {
+const SHARE_SURFACES = ["WALLS", "FLOOR"];
+function areaShareWarnings(configuration, categories) {
+	return configuration.rooms.flatMap((room) => {
+		const variables = roomVariables(room);
+		return SHARE_SURFACES.flatMap((surface) => {
+			const shares = surfaceShares(room, surface, categories);
+			if (!shares.shared || !shares.complete || shares.totalPercent >= 100) return [];
+			const percent = 100 - shares.totalPercent;
+			const area = surfaceAreaOf(variables, surface);
+			return [{
+				code: "AREA_SHARE_UNALLOCATED",
+				params: {
+					roomClientId: room.clientId,
+					surface,
+					percent,
+					sqm: roundArea(area * percent / 100)
+				}
+			}];
+		});
+	});
+}
+function estimateWarnings(lines, configuration, rate, data) {
 	return [
 		...collectWarnings(lines),
-		...roomsAreaWarnings(configuration, limits),
+		...roomsAreaWarnings(configuration, data.limits),
+		...areaShareWarnings(configuration, data.categories),
 		...configuration.currency === "UAH" && rate === null ? [{ code: "EXCHANGE_RATE_UNAVAILABLE" }] : []
 	];
 }
@@ -1308,7 +1394,7 @@ function estimate(configuration, data) {
 		exchangeRate: data.exchangeRate,
 		lines,
 		totals: computeTotals(lines, rate !== null),
-		warnings: estimateWarnings(lines, configuration, rate, data.limits),
+		warnings: estimateWarnings(lines, configuration, rate, data),
 		incomplete: isIncomplete(lines)
 	};
 }
@@ -1403,11 +1489,13 @@ function scopeOf(level, sample) {
 			code: "SAMPLE_INCOMPLETE",
 			params: { missing: room === void 0 ? "room" : "surfaceArea" }
 		} };
+		const puttyRequired = sample.puttyRequired ?? true;
 		return { scope: {
 			...roomVariables(room),
 			...objectScope(sample),
 			surfaceArea,
-			puttyRequired: sample.puttyRequired ?? true
+			puttyRequired,
+			puttyArea: sample.puttyArea ?? (puttyRequired ? surfaceArea : 0)
 		} };
 	}
 	if (room === void 0 || product === void 0) return { error: {
@@ -1556,6 +1644,7 @@ const FORMULA_SCOPE_VARIABLES = {
 };
 const FORMULA_QUANTITY_VARIABLE = number("quantity");
 const FORMULA_SURFACE_AREA_VARIABLE = number("surfaceArea");
+const FORMULA_PUTTY_AREA_VARIABLE = number("puttyArea");
 const FORMULA_PUTTY_REQUIRED_VARIABLE = boolean("puttyRequired");
 const FORMULA_VARIABLES = {
 	OBJECT: FORMULA_SCOPE_VARIABLES.object,
@@ -1573,7 +1662,8 @@ const FORMULA_VARIABLES = {
 		...FORMULA_SCOPE_VARIABLES.room,
 		...FORMULA_SCOPE_VARIABLES.object,
 		FORMULA_SURFACE_AREA_VARIABLE,
-		FORMULA_PUTTY_REQUIRED_VARIABLE
+		FORMULA_PUTTY_REQUIRED_VARIABLE,
+		FORMULA_PUTTY_AREA_VARIABLE
 	]
 };
 const ALL_VARIABLE_NAMES = new Set([...FORMULA_VARIABLES.CATEGORY, ...FORMULA_VARIABLES.SURFACE].map((variable) => variable.name));
@@ -1788,4 +1878,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_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 };
+export { COEFFICIENT_NAMESPACE, CentsSchema, ConfigurationSchema, CurrencySchema, EstimateLineSchema, EstimateMessageSchema, EstimateSchema, EstimateTotalsSchema, EstimateWarningSchema, ExchangeRateSchema, FORMULA_FUNCTIONS, FORMULA_FUNCTION_TABLE, FORMULA_LIMITS, FORMULA_PUTTY_AREA_VARIABLE, 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, areaShareError, areaShareOf, checkLimits, convertCentsToKopecks, estimate, evaluate, findOptionPriceSourceViolation, isShareSurface, levenshtein, objectVariables, parse, previewRule, productVariables, productVariablesOf, puttyRequiredOn, puttyShareOn, roomVariables, suggestNearest, surfaceAreaOf, surfaceShares, toCents, totalAreaOf, validateFormula };

package/package.json

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