@parv0888/scheme-engine 0.1.1 → 0.1.2

package/dist/types/scheme.d.ts

@@ -0,0 +1,172 @@
+import { SchemeCategory, SchemePayoutType, SchemeBudgetType, AdditionalCalculationLogic, ThirdQualifierType, type SchemeConstraintTypeValue, type SchemeSchemeOnValue, type SchemePayoutInValue } from "./enums";
+export interface OutletConstraints {
+    /** Allowed/required shop types for this scheme (outlet eligibility). */
+    requiredShopTypes?: any;
+    /** Allowed/required outlet segmentations for this scheme (outlet eligibility). */
+    requiredSegmentations?: any;
+    /** Whether scheme requires the outlet to be marked as focused. */
+    requiredIsFocused?: any;
+    /** Allowed/required channels for this scheme (GT/MT/etc.). */
+    requiredChannels?: any;
+}
+export interface FilterConstraints {
+    /** If provided, scheme applies only for items with MRP exactly in this list. */
+    mrp?: number[];
+    /** If provided, scheme applies only for items whose attribute text 1 matches one of these. */
+    attribute1?: string[];
+    /** If provided, scheme applies only for items whose attribute text 2 matches one of these. */
+    attribute2?: string[];
+    /** If provided, scheme applies only for items whose alternate category matches one of these. */
+    altCategory?: string[];
+    /** If provided, scheme applies only for manufacturing batch numbers in this list. */
+    manufacturingBatchNumbers?: string[];
+}
+export interface FirstQualifier {
+    /** The type of entity to qualify on (product/category/attribute). */
+    entityType: number;
+    /** The entity identifier/value (e.g. productId, categoryId, attributeText). */
+    entity: number | string;
+    /** Optional batch identifier constraint (MRP batch) for qualifier matching. */
+    batch: number | string | null;
+    /** Minimum required quantity for this qualifier to be satisfied. */
+    quantity: number;
+    /** Whether the matching items must be saleable/must-sell for qualifier to pass. */
+    isMustSell: boolean;
+}
+export interface BasketSlab {
+    /** Basket-slab identifier (row id). */
+    id: number;
+    /** Product id tied to this basket requirement (optional in some DB shapes). */
+    productId: number | null;
+    /** Required quantity/value threshold for this basket component. */
+    quantity: number;
+    /** Basket identifier this component belongs to. */
+    basketId: number;
+    /** Whether this basket component is mandatory to qualify for the slab. */
+    isBasketMandatory: boolean;
+    /** The parent scheme slab id this basket component is attached to. */
+    schemeSlabId: number;
+}
+export interface Basket {
+    /** Basket identifier. */
+    id: number;
+    /** Product IDs that constitute the basket group. */
+    productIds: number[];
+}
+export interface Slab {
+    /** Slab identifier. */
+    id: number;
+    /** Minimum threshold to qualify for this slab (qty/amount/units depending on scheme.constraintType). */
+    constraint: number;
+    /** Optional maximum threshold for the slab (used for range-based slabs). */
+    maxConstraint?: number;
+    /** Payout configured for PTR/ex-tax flows (percent/value depending on payout type). */
+    payout: number;
+    /** Payout configured for MRP billing flows (used when scheme is evaluated on MRP billing price). */
+    mrpPayout: number;
+    /** Priority/order among slabs (when multiple could match). */
+    priority: number;
+    /** Human-readable slab description (used for UI/printing). */
+    payoutDescription: string;
+    /** Product id to add/grant for PRODUCT/COUPON style payouts (DB can store any type). */
+    productId?: any;
+    /** Secondary qualifier value used for category/qualifier gating (legacy scheme model). */
+    secondQualifier: number;
+    /** Master batch id for payout product or scheme batch scoping (pricing batch). */
+    masterBatchId: string;
+    /** Basket invoice payout percent (used by basket schemes as discount percent). */
+    basketInvoicePayout: number;
+    /** Basket constraint type (qty vs amount) used in basket qualification. */
+    basketConstraintType: number;
+    /** Secondary qualifier type (e.g. LPC) describing how secondQualifier should be interpreted. */
+    secondQualifierType: number | null;
+    /** First-qualifier rules that must be satisfied for this slab to apply. */
+    firstQualifier: FirstQualifier[];
+    /** Basket qualifiers attached to this slab (mandatory/optional baskets). */
+    qualifierSchemeSlabs: BasketSlab[];
+    /** For step-multiplier schemes: the increment size above the base constraint. */
+    multiplierStepSize?: number | null;
+    /** Third qualifier values (often used for amount/quantity gating beyond second qualifier). */
+    thirdQualifier: number[] | null;
+    /** Type for the third qualifier (value vs quantity). */
+    thirdQualifierType: ThirdQualifierType | null;
+}
+export interface Scheme {
+    /** Scheme identifier. */
+    id: number;
+    /** Scheme name/code shown to users. */
+    name: string;
+    /** Scheme category: Primary vs Secondary (discount bucket). */
+    category: SchemeCategory | string;
+    /** The metric used to qualify slabs (Amount, Quantity, StdUnit, etc.). */
+    constraintType: SchemeConstraintTypeValue | string;
+    /** Business payout mechanic (Discount, FOC, Product, MRP%, etc.). */
+    payoutType: SchemePayoutType | string;
+    /** Calculation type for slabs (step/continuous/stepmultiplier/prorata). */
+    payoutCalculationType: string;
+    /** Field that indicates what discount is “on” (DB legacy; often used by client/UI). */
+    payoutOn: string;
+    /** Payout unit (quantity/standard unit) used for some payout types. */
+    payoutIn: SchemePayoutInValue | string;
+    /** True when payout should be interpreted as a range rather than discrete slabs. */
+    payoutAsRange?: boolean;
+    /** What entity the scheme is configured on (product/category/group/all/master batch). */
+    schemeOn: SchemeSchemeOnValue | string;
+    /** Scheme subtype used for extendable/non-extendable behaviors (and GST claim identification). */
+    schemeSubType: string;
+    /** Secondary subtype (e.g. claimable/non-claimable) for special flows like GST claim. */
+    schemeSubType2?: string;
+    /** Step size/step metadata from DB (used in some UIs and some step logic). */
+    schemeStep: number;
+    /** DB-provided block ids; meaning depends on schemeOn (legacy structure). */
+    schemeBlockArray: number[];
+    /** Selected product ids this scheme targets (product-level schemes). */
+    selectedProductBlockArray: number[];
+    /** Slab definitions (thresholds and payouts) for this scheme. */
+    slabs: Slab[];
+    /** Outlet-level constraints (who can avail the scheme). */
+    outletConstraints: OutletConstraints;
+    /** Item-level filter constraints (MRP, attributes, manufacturing batch numbers, etc.). */
+    filterConstraints?: FilterConstraints;
+    /** Long textual description for display/audit. */
+    stringDescription: string;
+    /** Whether the scheme is applied individually per line vs pooled across lines. */
+    isIndividual: boolean;
+    /** Whether the company is using MRP billing for this scheme evaluation. */
+    ismrpBilling?: boolean;
+    /** Whether this scheme is a markup-type scheme. */
+    isMarkup?: boolean;
+    /** Whether the scheme is marked preferred (used in conflict resolution). */
+    isPreferred?: boolean | null;
+    /** Budget amount for this scheme (if budgeted). */
+    schemeBudget: number | null;
+    /** Budget type (value vs quantity). */
+    schemeBudgetType: SchemeBudgetType | null;
+    /** Remaining budget specific to employee/user context (used for budget capping). */
+    employeeWiseRemainingBudget?: number;
+    /** Optional attribute text associated with scheme (used for tagging/reporting). */
+    attributeText: string | null;
+    /** Additional calculation logic modifier (e.g. discount value subtracted from price). */
+    additionalCalculationLogic?: AdditionalCalculationLogic | null;
+    /** When true, caller expects rounding/complete-number behavior for calculations. */
+    calculationOnCompleteNumber?: boolean;
+    /** UI hint: whether qty details should be shown for this scheme. */
+    showQtyDetails?: boolean;
+    /** Optional application sequence when multiple schemes exist. */
+    schemeSequence?: number | null;
+    /** If true, prevent other schemes from being applied once this scheme is applied. */
+    restrictProductsWithSchemeApplied?: boolean | null;
+    /** Additional applicability scope marker (legacy DB field). */
+    applicableOn?: number | null;
+    /** Alternate scheme link used for master-batch schemes and fallbacks. */
+    alternateSchemeId?: number | null;
+    /** Variant label/type (e.g. MasterBatch variant). */
+    schemeVariant?: string;
+    /** Discount-on type (e.g. group scheme) affecting qualifier checks. */
+    discountOn?: number | null;
+    /** ERP identifier for scheme, if synced from ERP. */
+    erpId?: any;
+    /** Distributor scoping for scheme (who is eligible to see/apply). */
+    distributors?: any;
+}
+//# sourceMappingURL=scheme.d.ts.map

package/dist/types/scheme.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheme.d.ts","sourceRoot":"","sources":["../../src/types/scheme.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,0BAA0B,EAC1B,kBAAkB,EAClB,KAAK,yBAAyB,EAC9B,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACzB,MAAM,SAAS,CAAC;AAGjB,MAAM,WAAW,iBAAiB;IAChC,wEAAwE;IACxE,iBAAiB,CAAC,EAAE,GAAG,CAAC;IACxB,kFAAkF;IAClF,qBAAqB,CAAC,EAAE,GAAG,CAAC;IAC5B,kEAAkE;IAClE,iBAAiB,CAAC,EAAE,GAAG,CAAC;IACxB,8DAA8D;IAC9D,gBAAgB,CAAC,EAAE,GAAG,CAAC;CACxB;AAGD,MAAM,WAAW,iBAAiB;IAChC,gFAAgF;IAChF,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,8FAA8F;IAC9F,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,8FAA8F;IAC9F,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,gGAAgG;IAChG,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,qFAAqF;IACrF,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;CACtC;AAGD,MAAM,WAAW,cAAc;IAC7B,qEAAqE;IACrE,UAAU,EAAE,MAAM,CAAC;IACnB,+EAA+E;IAC/E,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,+EAA+E;IAC/E,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAC9B,oEAAoE;IACpE,QAAQ,EAAE,MAAM,CAAC;IACjB,mFAAmF;IACnF,UAAU,EAAE,OAAO,CAAC;CACrB;AAGD,MAAM,WAAW,UAAU;IACzB,uCAAuC;IACvC,EAAE,EAAE,MAAM,CAAC;IACX,+EAA+E;IAC/E,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,mEAAmE;IACnE,QAAQ,EAAE,MAAM,CAAC;IACjB,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAC;IACjB,0EAA0E;IAC1E,iBAAiB,EAAE,OAAO,CAAC;IAC3B,sEAAsE;IACtE,YAAY,EAAE,MAAM,CAAC;CACtB;AAGD,MAAM,WAAW,MAAM;IACrB,yBAAyB;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,oDAAoD;IACpD,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAGD,MAAM,WAAW,IAAI;IACnB,uBAAuB;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,wGAAwG;IACxG,UAAU,EAAE,MAAM,CAAC;IACnB,4EAA4E;IAC5E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uFAAuF;IACvF,MAAM,EAAE,MAAM,CAAC;IACf,oGAAoG;IACpG,SAAS,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,CAAC;IACjB,8DAA8D;IAC9D,iBAAiB,EAAE,MAAM,CAAC;IAC1B,wFAAwF;IACxF,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,0FAA0F;IAC1F,eAAe,EAAE,MAAM,CAAC;IACxB,kFAAkF;IAClF,aAAa,EAAE,MAAM,CAAC;IACtB,kFAAkF;IAClF,mBAAmB,EAAE,MAAM,CAAC;IAC5B,2EAA2E;IAC3E,oBAAoB,EAAE,MAAM,CAAC;IAC7B,gGAAgG;IAChG,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,2EAA2E;IAC3E,cAAc,EAAE,cAAc,EAAE,CAAC;IACjC,4EAA4E;IAC5E,oBAAoB,EAAE,UAAU,EAAE,CAAC;IACnC,iFAAiF;IACjF,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,8FAA8F;IAC9F,cAAc,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAChC,wDAAwD;IACxD,kBAAkB,EAAE,kBAAkB,GAAG,IAAI,CAAC;CAC/C;AAGD,MAAM,WAAW,MAAM;IACrB,yBAAyB;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,+DAA+D;IAC/D,QAAQ,EAAE,cAAc,GAAG,MAAM,CAAC;IAClC,0EAA0E;IAC1E,cAAc,EAAE,yBAAyB,GAAG,MAAM,CAAC;IACnD,qEAAqE;IACrE,UAAU,EAAE,gBAAgB,GAAG,MAAM,CAAC;IACtC,2EAA2E;IAC3E,qBAAqB,EAAE,MAAM,CAAC;IAC9B,uFAAuF;IACvF,QAAQ,EAAE,MAAM,CAAC;IACjB,uEAAuE;IACvE,QAAQ,EAAE,mBAAmB,GAAG,MAAM,CAAC;IACvC,oFAAoF;IACpF,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,yFAAyF;IACzF,QAAQ,EAAE,mBAAmB,GAAG,MAAM,CAAC;IACvC,kGAAkG;IAClG,aAAa,EAAE,MAAM,CAAC;IACtB,yFAAyF;IACzF,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,8EAA8E;IAC9E,UAAU,EAAE,MAAM,CAAC;IACnB,6EAA6E;IAC7E,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,wEAAwE;IACxE,yBAAyB,EAAE,MAAM,EAAE,CAAC;IACpC,iEAAiE;IACjE,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,2DAA2D;IAC3D,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,0FAA0F;IAC1F,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,kDAAkD;IAClD,iBAAiB,EAAE,MAAM,CAAC;IAE1B,kFAAkF;IAClF,YAAY,EAAE,OAAO,CAAC;IACtB,2EAA2E;IAC3E,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,mDAAmD;IACnD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,4EAA4E;IAC5E,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAE7B,mDAAmD;IACnD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,uCAAuC;IACvC,gBAAgB,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC1C,oFAAoF;IACpF,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC,mFAAmF;IACnF,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,yFAAyF;IACzF,0BAA0B,CAAC,EAAE,0BAA0B,GAAG,IAAI,CAAC;IAC/D,oFAAoF;IACpF,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,oEAAoE;IACpE,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,iEAAiE;IACjE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,qFAAqF;IACrF,iCAAiC,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IACnD,+DAA+D;IAC/D,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,yEAAyE;IACzE,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,qDAAqD;IACrD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uEAAuE;IACvE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B,qDAAqD;IACrD,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,qEAAqE;IACrE,YAAY,CAAC,EAAE,GAAG,CAAC;CACpB"}

package/dist/types/scheme.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=scheme.js.map

package/dist/types/scheme.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheme.js","sourceRoot":"","sources":["../../src/types/scheme.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parv0888/scheme-engine",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Pure-function scheme calculation engine for FieldAssist DMS",
   "main": "dist/index.js",
   "module": "dist/esm/index.js",
@@ -9,7 +9,8 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsc && tsc -p tsconfig.esm.json",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo",
+    "build": "npm run clean && tsc && tsc -p tsconfig.esm.json",
     "test": "jest",
     "prepublishOnly": "npm run build && npm test",
     "db:download:secondary-discount-diffs": "node scripts/download_secondary_discount_diffs.js",