@uwmd/core 1.1.0

package/dist/packs/retail.js

@@ -0,0 +1,115 @@
+// Canonical retail calc pack.
+//
+// Single source of truth for the retail derived metrics. Consumed by the web
+// editor (via @uwmd/core/browser), the @uwmd/excel converter (via
+// emitExcelFormula), conformance tests, and any future asset-class viewer.
+// Add a metric here once and every tool picks it up.
+//
+// Each formula is a Tier-3 safe expression evaluable by `evaluateCalc()`
+// against a parsed .uw.md file. Field paths reference the canonical retail
+// schema (see UW_FORMAT_SPEC §4 and the Cactus Crossing example).
+//
+// Retail measures size in gross leasable area (`property.gross_leasable_area`)
+// and occupancy in GLA (`rent_roll.occupied_gla` / `total_gla`). It adds an
+// `expense_recovery_ratio` metric distinctive to NNN structures — the share of
+// operating expenses recovered from tenants via reimbursements.
+export const RETAIL_PACK = {
+    manifest_version: '1',
+    id: 'org.uwmd.pack.retail',
+    name: 'Retail Starter Pack',
+    version: '1.0.0',
+    description: 'Twelve derived metrics for retail underwriting: cap rate, LTV, LTC, DSCR, debt yield, $/sqft, loan/sqft, NOI/sqft, expense ratio, expense recovery ratio, cash-on-cash, occupancy.',
+    authors: ['UW Markdown Working Group'],
+    license: 'MIT',
+    requires_protocol: '^1.0.0',
+    requires_format: '^1.1.0',
+    requires_tier: 'tier-3-calc-host',
+    asset_classes: ['retail'],
+    calculations: [
+        {
+            id: 'cap_rate',
+            label: 'Cap Rate',
+            formula: 'noi_model.net_operating_income / valuation.purchase_price',
+            unit: '%',
+            deterministic: true,
+        },
+        {
+            id: 'ltv',
+            label: 'LTV',
+            formula: 'debt_structure.loan_amount / valuation.purchase_price',
+            unit: '%',
+            deterministic: true,
+        },
+        {
+            id: 'ltc',
+            label: 'LTC',
+            formula: 'debt_structure.loan_amount / sources_uses.uses.total',
+            unit: '%',
+            deterministic: true,
+        },
+        {
+            id: 'dscr',
+            label: 'DSCR',
+            formula: 'noi_model.net_operating_income / debt_structure.annual_debt_service',
+            unit: 'x',
+            deterministic: true,
+        },
+        {
+            id: 'debt_yield',
+            label: 'Debt Yield',
+            formula: 'noi_model.net_operating_income / debt_structure.loan_amount',
+            unit: '%',
+            deterministic: true,
+        },
+        {
+            id: 'price_per_sqft',
+            label: 'Price / SqFt',
+            formula: 'valuation.purchase_price / property.gross_leasable_area',
+            unit: '$',
+            deterministic: true,
+        },
+        {
+            id: 'loan_per_sqft',
+            label: 'Loan / SqFt',
+            formula: 'debt_structure.loan_amount / property.gross_leasable_area',
+            unit: '$',
+            deterministic: true,
+        },
+        {
+            id: 'noi_per_sqft',
+            label: 'NOI / SqFt',
+            formula: 'noi_model.net_operating_income / property.gross_leasable_area',
+            unit: '$',
+            deterministic: true,
+        },
+        {
+            id: 'expense_ratio',
+            label: 'Operating Expense Ratio',
+            formula: 'noi_model.expenses.total_operating_expenses / noi_model.income.effective_gross_income',
+            unit: '%',
+            deterministic: true,
+        },
+        {
+            id: 'expense_recovery_ratio',
+            label: 'Expense Recovery Ratio',
+            formula: 'noi_model.income.expense_reimbursements / noi_model.expenses.total_operating_expenses',
+            unit: '%',
+            deterministic: true,
+        },
+        {
+            id: 'cash_on_cash',
+            label: 'Cash-on-Cash',
+            formula: '(noi_model.net_operating_income - debt_structure.annual_debt_service) / sources_uses.sources.sponsor_equity',
+            unit: '%',
+            deterministic: true,
+        },
+        {
+            id: 'occupancy',
+            label: 'Occupancy',
+            formula: 'rent_roll.occupied_gla / rent_roll.total_gla',
+            unit: '%',
+            deterministic: true,
+        },
+    ],
+};
+//# sourceMappingURL=retail.js.map

package/dist/packs/retail.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retail.js","sourceRoot":"","sources":["../../src/packs/retail.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAC9B,EAAE;AACF,6EAA6E;AAC7E,kEAAkE;AAClE,2EAA2E;AAC3E,qDAAqD;AACrD,EAAE;AACF,yEAAyE;AACzE,2EAA2E;AAC3E,kEAAkE;AAClE,EAAE;AACF,+EAA+E;AAC/E,4EAA4E;AAC5E,+EAA+E;AAC/E,gEAAgE;AAIhE,MAAM,CAAC,MAAM,WAAW,GAAmB;IACzC,gBAAgB,EAAE,GAAG;IACrB,EAAE,EAAE,sBAAsB;IAC1B,IAAI,EAAE,qBAAqB;IAC3B,OAAO,EAAE,OAAO;IAChB,WAAW,EACT,oLAAoL;IACtL,OAAO,EAAE,CAAC,2BAA2B,CAAC;IACtC,OAAO,EAAE,KAAK;IACd,iBAAiB,EAAE,QAAQ;IAC3B,eAAe,EAAE,QAAQ;IACzB,aAAa,EAAE,kBAAkB;IACjC,aAAa,EAAE,CAAC,QAAQ,CAAC;IACzB,YAAY,EAAE;QACZ;YACE,EAAE,EAAE,UAAU;YACd,KAAK,EAAE,UAAU;YACjB,OAAO,EAAE,2DAA2D;YACpE,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,KAAK;YACT,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,uDAAuD;YAChE,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,KAAK;YACT,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,sDAAsD;YAC/D,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,MAAM;YACV,KAAK,EAAE,MAAM;YACb,OAAO,EAAE,qEAAqE;YAC9E,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,YAAY;YAChB,KAAK,EAAE,YAAY;YACnB,OAAO,EAAE,6DAA6D;YACtE,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,gBAAgB;YACpB,KAAK,EAAE,cAAc;YACrB,OAAO,EAAE,yDAAyD;YAClE,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,eAAe;YACnB,KAAK,EAAE,aAAa;YACpB,OAAO,EAAE,2DAA2D;YACpE,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,cAAc;YAClB,KAAK,EAAE,YAAY;YACnB,OAAO,EAAE,+DAA+D;YACxE,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,eAAe;YACnB,KAAK,EAAE,yBAAyB;YAChC,OAAO,EACL,uFAAuF;YACzF,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,wBAAwB;YAC5B,KAAK,EAAE,wBAAwB;YAC/B,OAAO,EACL,uFAAuF;YACzF,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,cAAc;YAClB,KAAK,EAAE,cAAc;YACrB,OAAO,EACL,6GAA6G;YAC/G,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,WAAW;YACf,KAAK,EAAE,WAAW;YAClB,OAAO,EAAE,8CAA8C;YACvD,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;KACF;CACF,CAAC"}

package/dist/packs/self-storage.d.ts

@@ -0,0 +1,3 @@
+import type { ModuleManifest } from '../protocol.js';
+export declare const SELF_STORAGE_PACK: ModuleManifest;
+//# sourceMappingURL=self-storage.d.ts.map

package/dist/packs/self-storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"self-storage.d.ts","sourceRoot":"","sources":["../../src/packs/self-storage.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAErD,eAAO,MAAM,iBAAiB,EAAE,cAqG/B,CAAC"}

package/dist/packs/self-storage.js

@@ -0,0 +1,105 @@
+// Canonical self-storage calc pack.
+//
+// Single source of truth for self-storage derived metrics. The class-specific
+// fields are net rentable square feet, rentable units, and both physical and
+// economic occupancy.
+export const SELF_STORAGE_PACK = {
+    manifest_version: '1',
+    id: 'org.uwmd.pack.self_storage',
+    name: 'Self-Storage Starter Pack',
+    version: '1.0.0',
+    description: 'Twelve derived metrics for self-storage underwriting: cap rate, LTV, LTC, DSCR, debt yield, $/NRSF, loan/NRSF, NOI/NRSF, expense ratio, cash-on-cash, physical occupancy, and economic occupancy.',
+    authors: ['UW Markdown Working Group'],
+    license: 'MIT',
+    requires_protocol: '^1.0.0',
+    requires_format: '^1.1.0',
+    requires_tier: 'tier-3-calc-host',
+    asset_classes: ['self_storage'],
+    calculations: [
+        {
+            id: 'cap_rate',
+            label: 'Cap Rate',
+            formula: 'noi_model.net_operating_income / valuation.purchase_price',
+            unit: '%',
+            deterministic: true,
+        },
+        {
+            id: 'ltv',
+            label: 'LTV',
+            formula: 'debt_structure.loan_amount / valuation.purchase_price',
+            unit: '%',
+            deterministic: true,
+        },
+        {
+            id: 'ltc',
+            label: 'LTC',
+            formula: 'debt_structure.loan_amount / sources_uses.uses.total',
+            unit: '%',
+            deterministic: true,
+        },
+        {
+            id: 'dscr',
+            label: 'DSCR',
+            formula: 'noi_model.net_operating_income / debt_structure.annual_debt_service',
+            unit: 'x',
+            deterministic: true,
+        },
+        {
+            id: 'debt_yield',
+            label: 'Debt Yield',
+            formula: 'noi_model.net_operating_income / debt_structure.loan_amount',
+            unit: '%',
+            deterministic: true,
+        },
+        {
+            id: 'price_per_nrsf',
+            label: 'Price / NRSF',
+            formula: 'valuation.purchase_price / property.net_rentable_square_feet',
+            unit: '$',
+            deterministic: true,
+        },
+        {
+            id: 'loan_per_nrsf',
+            label: 'Loan / NRSF',
+            formula: 'debt_structure.loan_amount / property.net_rentable_square_feet',
+            unit: '$',
+            deterministic: true,
+        },
+        {
+            id: 'noi_per_nrsf',
+            label: 'NOI / NRSF',
+            formula: 'noi_model.net_operating_income / property.net_rentable_square_feet',
+            unit: '$',
+            deterministic: true,
+        },
+        {
+            id: 'expense_ratio',
+            label: 'Operating Expense Ratio',
+            formula: 'noi_model.expenses.total_operating_expenses / noi_model.income.effective_gross_income',
+            unit: '%',
+            deterministic: true,
+        },
+        {
+            id: 'cash_on_cash',
+            label: 'Cash-on-Cash',
+            formula: '(noi_model.net_operating_income - debt_structure.annual_debt_service) / sources_uses.sources.sponsor_equity',
+            unit: '%',
+            deterministic: true,
+        },
+        {
+            id: 'physical_occupancy',
+            label: 'Physical Occupancy',
+            formula: 'rent_roll.occupied_units / property.rentable_units',
+            unit: '%',
+            deterministic: true,
+        },
+        {
+            id: 'economic_occupancy',
+            label: 'Economic Occupancy',
+            formula: 'noi_model.income.effective_gross_income / noi_model.income.gross_potential_rent',
+            unit: '%',
+            deterministic: true,
+        },
+    ],
+};
+//# sourceMappingURL=self-storage.js.map

package/dist/packs/self-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"self-storage.js","sourceRoot":"","sources":["../../src/packs/self-storage.ts"],"names":[],"mappings":"AAAA,oCAAoC;AACpC,EAAE;AACF,8EAA8E;AAC9E,6EAA6E;AAC7E,sBAAsB;AAItB,MAAM,CAAC,MAAM,iBAAiB,GAAmB;IAC/C,gBAAgB,EAAE,GAAG;IACrB,EAAE,EAAE,4BAA4B;IAChC,IAAI,EAAE,2BAA2B;IACjC,OAAO,EAAE,OAAO;IAChB,WAAW,EACT,mMAAmM;IACrM,OAAO,EAAE,CAAC,2BAA2B,CAAC;IACtC,OAAO,EAAE,KAAK;IACd,iBAAiB,EAAE,QAAQ;IAC3B,eAAe,EAAE,QAAQ;IACzB,aAAa,EAAE,kBAAkB;IACjC,aAAa,EAAE,CAAC,cAAc,CAAC;IAC/B,YAAY,EAAE;QACZ;YACE,EAAE,EAAE,UAAU;YACd,KAAK,EAAE,UAAU;YACjB,OAAO,EAAE,2DAA2D;YACpE,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,KAAK;YACT,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,uDAAuD;YAChE,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,KAAK;YACT,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,sDAAsD;YAC/D,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,MAAM;YACV,KAAK,EAAE,MAAM;YACb,OAAO,EAAE,qEAAqE;YAC9E,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,YAAY;YAChB,KAAK,EAAE,YAAY;YACnB,OAAO,EAAE,6DAA6D;YACtE,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,gBAAgB;YACpB,KAAK,EAAE,cAAc;YACrB,OAAO,EAAE,8DAA8D;YACvE,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,eAAe;YACnB,KAAK,EAAE,aAAa;YACpB,OAAO,EAAE,gEAAgE;YACzE,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,cAAc;YAClB,KAAK,EAAE,YAAY;YACnB,OAAO,EAAE,oEAAoE;YAC7E,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,eAAe;YACnB,KAAK,EAAE,yBAAyB;YAChC,OAAO,EACL,uFAAuF;YACzF,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,cAAc;YAClB,KAAK,EAAE,cAAc;YACrB,OAAO,EACL,6GAA6G;YAC/G,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,oBAAoB;YACxB,KAAK,EAAE,oBAAoB;YAC3B,OAAO,EAAE,oDAAoD;YAC7D,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;QACD;YACE,EAAE,EAAE,oBAAoB;YACxB,KAAK,EAAE,oBAAoB;YAC3B,OAAO,EAAE,iFAAiF;YAC1F,IAAI,EAAE,GAAG;YACT,aAAa,EAAE,IAAI;SACpB;KACF;CACF,CAAC"}

package/dist/parser.d.ts

@@ -0,0 +1,15 @@
+import type { UWBlock, ParsedUWFile, ParseOptions } from './types.js';
+export declare class UWMDParseError extends Error {
+    readonly code: string;
+    readonly line?: number;
+    readonly feature?: string;
+    constructor(code: string, message: string, opts?: {
+        line?: number;
+        feature?: string;
+    });
+}
+export declare function parseUWFile(content: string, options?: ParseOptions): ParsedUWFile;
+export declare function getSection(parsed: ParsedUWFile, sectionId: string): UWBlock | null;
+export declare function getSectionVariant(parsed: ParsedUWFile, sectionId: string, variant: string): UWBlock | null;
+export declare function deepGet(obj: unknown, path: string): unknown;
+//# sourceMappingURL=parser.d.ts.map

package/dist/parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../src/parser.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,OAAO,EAIP,YAAY,EAEZ,YAAY,EAEb,MAAM,YAAY,CAAC;AAsDpB,qBAAa,cAAe,SAAQ,KAAK;IACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;gBACd,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO;CAO1F;AAmJD,wBAAgB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,YAAiB,GAAG,YAAY,CAqHrF;AAwGD,wBAAgB,UAAU,CAAC,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,CAKlF;AAED,wBAAgB,iBAAiB,CAC/B,MAAM,EAAE,YAAY,EACpB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GACd,OAAO,GAAG,IAAI,CAIhB;AAMD,wBAAgB,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAQ3D"}