@roomwise/calc-engine 0.4.0 → 0.6.0

package/dist/index.d.ts

@@ -5,15 +5,22 @@ export declare const LocalizedTextSchema: z.ZodObject<{
   uk: z.ZodString;
 }, z.core.$strip>;
 export type LocalizedText = z.infer<typeof LocalizedTextSchema>;
+export declare const ScopeSchema: z.ZodEnum<{
+  FULL: "FULL";
+  PARTIAL: "PARTIAL";
+}>;
+export type Scope = z.infer<typeof ScopeSchema>;
 export declare const FinishLevelSchema: z.ZodEnum<{
   ROUGH: "ROUGH";
   PRE_FINISH: "PRE_FINISH";
+  LIVED_IN: "LIVED_IN";
 }>;
 export type FinishLevel = z.infer<typeof FinishLevelSchema>;
 export declare const RuleLevelSchema: z.ZodEnum<{
   OBJECT: "OBJECT";
   CATEGORY: "CATEGORY";
   MATERIAL_TYPE: "MATERIAL_TYPE";
+  SURFACE: "SURFACE";
 }>;
 export type RuleLevel = z.infer<typeof RuleLevelSchema>;
 export declare const RateSourceSchema: z.ZodEnum<{
@@ -22,10 +29,10 @@ export declare const RateSourceSchema: z.ZodEnum<{
 }>;
 export type RateSource = z.infer<typeof RateSourceSchema>;
 export declare const SurfaceKindSchema: z.ZodEnum<{
-  NONE: "NONE";
   FLOOR: "FLOOR";
   WALLS: "WALLS";
   CEILING: "CEILING";
+  NONE: "NONE";
 }>;
 export type SurfaceKind = z.infer<typeof SurfaceKindSchema>;
 export declare const ProductUnitSchema: z.ZodEnum<{
@@ -56,6 +63,8 @@ export declare const RoomTypeCodeSchema: z.ZodEnum<{
   KITCHEN: "KITCHEN";
   KITCHEN_LIVING: "KITCHEN_LIVING";
   BATHROOM: "BATHROOM";
+  HALLWAY: "HALLWAY";
+  STORAGE: "STORAGE";
 }>;
 export type RoomTypeCode = z.infer<typeof RoomTypeCodeSchema>;
 export declare const CurrencySchema: z.ZodEnum<{
@@ -71,6 +80,12 @@ export declare const SectionSchema: z.ZodEnum<{
   MATERIALS: "MATERIALS";
 }>;
 export type Section = z.infer<typeof SectionSchema>;
+export declare const LineComponentKindSchema: z.ZodEnum<{
+  MATERIAL: "MATERIAL";
+  LABOR: "LABOR";
+  PREP: "PREP";
+}>;
+export type LineComponentKind = z.infer<typeof LineComponentKindSchema>;
 export declare const LineStatusSchema: z.ZodEnum<{
   OK: "OK";
   INCLUDED: "INCLUDED";
@@ -102,6 +117,8 @@ export declare const RoomConfigurationSchema: z.ZodObject<{
     KITCHEN: "KITCHEN";
     KITCHEN_LIVING: "KITCHEN_LIVING";
     BATHROOM: "BATHROOM";
+    HALLWAY: "HALLWAY";
+    STORAGE: "STORAGE";
   }>;
   lengthM: z.ZodNumber;
   widthM: z.ZodNumber;
@@ -120,11 +137,16 @@ export declare const OptionSelectionSchema: z.ZodObject<{
 }, z.core.$strip>;
 export type OptionSelection = z.infer<typeof OptionSelectionSchema>;
 export declare const ConfigurationSchema: z.ZodObject<{
+  scope: z.ZodDefault<z.ZodEnum<{
+    FULL: "FULL";
+    PARTIAL: "PARTIAL";
+  }>>;
   finishLevel: z.ZodEnum<{
     ROUGH: "ROUGH";
     PRE_FINISH: "PRE_FINISH";
+    LIVED_IN: "LIVED_IN";
   }>;
-  totalAreaSqm: z.ZodNumber;
+  totalAreaSqm: z.ZodNullable<z.ZodNumber>;
   balconyAreaSqm: z.ZodNumber;
   balconyTiles: z.ZodBoolean;
   rooms: z.ZodArray<z.ZodObject<{
@@ -136,6 +158,8 @@ export declare const ConfigurationSchema: z.ZodObject<{
       KITCHEN: "KITCHEN";
       KITCHEN_LIVING: "KITCHEN_LIVING";
       BATHROOM: "BATHROOM";
+      HALLWAY: "HALLWAY";
+      STORAGE: "STORAGE";
     }>;
     lengthM: z.ZodNumber;
     widthM: z.ZodNumber;
@@ -164,6 +188,17 @@ export declare const EstimateMessageSchema: z.ZodObject<{
   params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, z.core.$strip>;
 export type EstimateMessage = z.infer<typeof EstimateMessageSchema>;
+export declare const LineComponentSchema: z.ZodObject<{
+  kind: z.ZodEnum<{
+    MATERIAL: "MATERIAL";
+    LABOR: "LABOR";
+    PREP: "PREP";
+  }>;
+  ruleId: z.ZodString;
+  amountCents: z.ZodNumber;
+  sharedWithCategoryId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type LineComponent = z.infer<typeof LineComponentSchema>;
 export declare const EstimateLineSchema: z.ZodObject<{
   id: z.ZodString;
   section: z.ZodEnum<{
@@ -191,6 +226,16 @@ export declare const EstimateLineSchema: z.ZodObject<{
   unitPriceCents: z.ZodNullable<z.ZodInt>;
   amountCents: z.ZodInt;
   amountUahKopecks: z.ZodNullable<z.ZodInt>;
+  components: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    kind: z.ZodEnum<{
+      MATERIAL: "MATERIAL";
+      LABOR: "LABOR";
+      PREP: "PREP";
+    }>;
+    ruleId: z.ZodString;
+    amountCents: z.ZodNumber;
+    sharedWithCategoryId: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>>;
   warnings: z.ZodArray<z.ZodObject<{
     code: z.ZodString;
     params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
@@ -268,6 +313,16 @@ export declare const EstimateSchema: z.ZodObject<{
     unitPriceCents: z.ZodNullable<z.ZodInt>;
     amountCents: z.ZodInt;
     amountUahKopecks: z.ZodNullable<z.ZodInt>;
+    components: z.ZodOptional<z.ZodArray<z.ZodObject<{
+      kind: z.ZodEnum<{
+        MATERIAL: "MATERIAL";
+        LABOR: "LABOR";
+        PREP: "PREP";
+      }>;
+      ruleId: z.ZodString;
+      amountCents: z.ZodNumber;
+      sharedWithCategoryId: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
     warnings: z.ZodArray<z.ZodObject<{
       code: z.ZodString;
       params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
@@ -309,6 +364,8 @@ export declare const RuleSampleSchema: z.ZodObject<{
       KITCHEN: "KITCHEN";
       KITCHEN_LIVING: "KITCHEN_LIVING";
       BATHROOM: "BATHROOM";
+      HALLWAY: "HALLWAY";
+      STORAGE: "STORAGE";
     }>;
     lengthM: z.ZodNumber;
     widthM: z.ZodNumber;
@@ -324,22 +381,35 @@ 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<{
-    totalAreaSqm: z.ZodNumber;
+    scope: z.ZodEnum<{
+      FULL: "FULL";
+      PARTIAL: "PARTIAL";
+    }>;
+    totalAreaSqm: z.ZodNullable<z.ZodNumber>;
     balconyAreaSqm: z.ZodNumber;
     balconyTiles: z.ZodBoolean;
     finishLevel: z.ZodEnum<{
       ROUGH: "ROUGH";
       PRE_FINISH: "PRE_FINISH";
+      LIVED_IN: "LIVED_IN";
     }>;
     roomsCount: z.ZodInt;
     bathroomsCount: z.ZodInt;
+    roomsFloorArea: z.ZodNumber;
+    roomsWallArea: z.ZodNumber;
+    roomsPuttyWallArea: z.ZodOptional<z.ZodNumber>;
+    roomsPerimeter: z.ZodNumber;
+    wetRoomsCount: z.ZodInt;
   }, z.core.$strip>;
 }, z.core.$strip>;
 export type RuleSample = z.infer<typeof RuleSampleSchema>;
 export declare const RulePreviewSchema: z.ZodObject<{
   quantity: z.ZodNullable<z.ZodNumber>;
   amountCents: z.ZodNullable<z.ZodInt>;
+  laborCents: z.ZodNullable<z.ZodInt>;
   variables: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodBoolean, z.ZodString]>>;
   coefficients: z.ZodRecord<z.ZodString, z.ZodNumber>;
   error: z.ZodNullable<z.ZodObject<{
@@ -376,24 +446,16 @@ export declare const PricingLimitsSchema: z.ZodObject<{
     min: z.ZodNumber;
     max: z.ZodNumber;
   }, z.core.$strip>;
+  missingAreaHintSqm: z.ZodNumber;
 }, z.core.$strip>;
 export type PricingLimits = z.infer<typeof PricingLimitsSchema>;
-export declare const BaseRateSchema: z.ZodObject<{
-  finishLevel: z.ZodEnum<{
-    ROUGH: "ROUGH";
-    PRE_FINISH: "PRE_FINISH";
-  }>;
-  areaFromSqm: z.ZodNumber;
-  areaToSqm: z.ZodNumber;
-  rateCentsPerSqm: z.ZodInt;
-}, z.core.$strip>;
-export type BaseRate = z.infer<typeof BaseRateSchema>;
 export declare const PricingRuleSchema: z.ZodObject<{
   id: z.ZodString;
   level: z.ZodEnum<{
     OBJECT: "OBJECT";
     CATEGORY: "CATEGORY";
     MATERIAL_TYPE: "MATERIAL_TYPE";
+    SURFACE: "SURFACE";
   }>;
   categoryId: z.ZodNullable<z.ZodString>;
   materialTypeId: z.ZodNullable<z.ZodString>;
@@ -402,7 +464,14 @@ export declare const PricingRuleSchema: z.ZodObject<{
     uk: z.ZodString;
   }, z.core.$strip>;
   quantityFormula: z.ZodNullable<z.ZodString>;
+  surface: z.ZodNullable<z.ZodEnum<{
+    FLOOR: "FLOOR";
+    WALLS: "WALLS";
+    CEILING: "CEILING";
+  }>>;
+  baseComponent: z.ZodBoolean;
   costFormula: z.ZodString;
+  laborFormula: z.ZodNullable<z.ZodString>;
   sortOrder: z.ZodInt;
 }, z.core.$strip>;
 export type PricingRule = z.infer<typeof PricingRuleSchema>;
@@ -415,11 +484,12 @@ export declare const PricingCategorySchema: z.ZodObject<{
   id: z.ZodString;
   wastePercent: z.ZodNumber;
   surface: z.ZodEnum<{
-    NONE: "NONE";
     FLOOR: "FLOOR";
     WALLS: "WALLS";
     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<{
@@ -454,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<{
@@ -463,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";
@@ -471,6 +545,11 @@ export declare const PricingOptionSchema: z.ZodObject<{
     PROJECT: "PROJECT";
   }>;
   roomTypeCodes: z.ZodArray<z.ZodString>;
+  priceCoefficientKeys: z.ZodArray<z.ZodString>;
+  scopes: z.ZodArray<z.ZodEnum<{
+    FULL: "FULL";
+    PARTIAL: "PARTIAL";
+  }>>;
   minQuantity: z.ZodNullable<z.ZodInt>;
   maxQuantity: z.ZodNullable<z.ZodInt>;
   available: z.ZodBoolean;
@@ -503,16 +582,8 @@ export declare const PricingDataSchema: z.ZodObject<{
       min: z.ZodNumber;
       max: z.ZodNumber;
     }, z.core.$strip>;
+    missingAreaHintSqm: z.ZodNumber;
   }, z.core.$strip>;
-  baseRates: z.ZodArray<z.ZodObject<{
-    finishLevel: z.ZodEnum<{
-      ROUGH: "ROUGH";
-      PRE_FINISH: "PRE_FINISH";
-    }>;
-    areaFromSqm: z.ZodNumber;
-    areaToSqm: z.ZodNumber;
-    rateCentsPerSqm: z.ZodInt;
-  }, z.core.$strip>>;
   coefficients: z.ZodRecord<z.ZodString, z.ZodNumber>;
   rules: z.ZodArray<z.ZodObject<{
     id: z.ZodString;
@@ -520,6 +591,7 @@ export declare const PricingDataSchema: z.ZodObject<{
       OBJECT: "OBJECT";
       CATEGORY: "CATEGORY";
       MATERIAL_TYPE: "MATERIAL_TYPE";
+      SURFACE: "SURFACE";
     }>;
     categoryId: z.ZodNullable<z.ZodString>;
     materialTypeId: z.ZodNullable<z.ZodString>;
@@ -528,7 +600,14 @@ export declare const PricingDataSchema: z.ZodObject<{
       uk: z.ZodString;
     }, z.core.$strip>;
     quantityFormula: z.ZodNullable<z.ZodString>;
+    surface: z.ZodNullable<z.ZodEnum<{
+      FLOOR: "FLOOR";
+      WALLS: "WALLS";
+      CEILING: "CEILING";
+    }>>;
+    baseComponent: z.ZodBoolean;
     costFormula: z.ZodString;
+    laborFormula: z.ZodNullable<z.ZodString>;
     sortOrder: z.ZodInt;
   }, z.core.$strip>>;
   roomTypes: z.ZodArray<z.ZodObject<{
@@ -539,11 +618,12 @@ export declare const PricingDataSchema: z.ZodObject<{
     id: z.ZodString;
     wastePercent: z.ZodNumber;
     surface: z.ZodEnum<{
-      NONE: "NONE";
       FLOOR: "FLOOR";
       WALLS: "WALLS";
       CEILING: "CEILING";
+      NONE: "NONE";
     }>;
+    requiresPutty: z.ZodDefault<z.ZodBoolean>;
   }, z.core.$strip>>;
   materialTypes: z.ZodArray<z.ZodObject<{
     id: z.ZodString;
@@ -583,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";
@@ -591,6 +671,11 @@ export declare const PricingDataSchema: z.ZodObject<{
       PROJECT: "PROJECT";
     }>;
     roomTypeCodes: z.ZodArray<z.ZodString>;
+    priceCoefficientKeys: z.ZodArray<z.ZodString>;
+    scopes: z.ZodArray<z.ZodEnum<{
+      FULL: "FULL";
+      PARTIAL: "PARTIAL";
+    }>>;
     minQuantity: z.ZodNullable<z.ZodInt>;
     maxQuantity: z.ZodNullable<z.ZodInt>;
     available: z.ZodBoolean;
@@ -714,6 +799,7 @@ export interface PreviewRuleInput {
   readonly level: RuleLevel;
   readonly quantityFormula: string | null;
   readonly costFormula: string;
+  readonly laborFormula?: string | null;
   readonly coefficients: Readonly<Record<string, number>>;
   readonly sample: RuleSample;
 }
@@ -724,7 +810,7 @@ export declare function levenshtein(a: string, b: string): number;
 export declare function suggestNearest(name: string, candidates: readonly string[], maxDistance?: number): string | undefined;
 //#endregion
 //#region src/formula/validate.d.ts
-export type FormulaKind = 'quantity' | 'cost';
+export type FormulaKind = 'quantity' | 'cost' | 'labor';
 export type FormulaScope = 'room' | 'product' | 'object';
 export interface FormulaVariable {
   readonly name: string;
@@ -733,6 +819,8 @@ 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;
@@ -755,14 +843,21 @@ export declare function toCents(dollars: number): number;
 //#endregion
 //#region src/variables/object.d.ts
 export interface ObjectVariables {
+  readonly scope: Scope;
   readonly totalArea: number;
   readonly balconyArea: number;
   readonly balconyTiles: boolean;
   readonly finishLevel: FinishLevel;
   readonly roomsCount: number;
   readonly bathroomsCount: number;
+  readonly roomsFloorArea: number;
+  readonly roomsWallArea: number;
+  readonly roomsPuttyWallArea: number;
+  readonly roomsPerimeter: number;
+  readonly wetRoomsCount: number;
 }
-export declare function objectVariables(configuration: Configuration): ObjectVariables;
+export declare function totalAreaOf(scope: Scope, totalAreaSqm: number | null, roomsFloorArea: number): number;
+export declare function objectVariables(configuration: Configuration, categories: readonly PricingCategory[]): ObjectVariables;
 //#endregion
 //#region src/variables/product.d.ts
 export interface ProductVariables {
@@ -773,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;