@uwmd/core 1.1.0

package/dist/defaults.d.ts

@@ -0,0 +1,104 @@
+import type { AssetClass } from './types.js';
+export type DefaultUnit = 'percent' | 'currency' | 'ratio' | 'months' | 'count';
+export interface DefaultRange {
+    /** Lower bound of the published range. */
+    low: number;
+    /** Central / typical value used when a single scalar is needed. */
+    central: number;
+    /** Upper bound of the published range. */
+    high: number;
+    /** Unit of measure; informs renderer formatting and validators. */
+    unit?: DefaultUnit;
+    /** Always 'asset_class_default' for entries in this module. */
+    source: 'asset_class_default';
+    /** Format/Protocol spec reference for this default. */
+    spec_ref?: string;
+    /** Human-readable provenance (data vendor, publication, internal study). */
+    citation?: string;
+}
+export interface AssetClassDefaults {
+    asset_class: AssetClass | (string & {});
+    /** Semver — bumps when ranges change materially. */
+    version: string;
+    /** Field paths use dot notation rooted at the file's section tree. */
+    fields: Record<string, DefaultRange>;
+}
+/**
+ * Multifamily asset-class defaults, v1.0.0.
+ *
+ * Ranges are deliberately wide enough to span most US primary/secondary markets
+ * for stabilized garden / mid-rise product. They are intended for triage —
+ * scope-stage VOI ranking — not for committee-grade underwriting.
+ *
+ * Citations name the canonical industry source; specific point values within
+ * the range reflect a blend of published surveys and internal calibration.
+ * Bump `version` when any low/central/high shifts beyond round-off.
+ */
+export declare const MULTIFAMILY_DEFAULTS: AssetClassDefaults;
+/**
+ * Office asset-class defaults, v1.0.0.
+ *
+ * Calibrated for stabilized Class A/B suburban and CBD office. Ranges run wider
+ * than multifamily — office cash flows are lumpier (lease rollover, TI/LC, longer
+ * downtime) and pricing is more dispersed across markets and building class.
+ * Like the multifamily table these are triage-grade (scope-stage VOI ranking),
+ * not committee underwriting.
+ *
+ * Citations name the canonical industry source; specific point values within
+ * the range reflect a blend of published surveys and internal calibration.
+ * Bump `version` when any low/central/high shifts beyond round-off.
+ */
+export declare const OFFICE_DEFAULTS: AssetClassDefaults;
+/**
+ * Retail asset-class defaults, v1.0.0.
+ *
+ * Calibrated for stabilized grocery-anchored and neighborhood retail on a
+ * predominantly NNN lease structure. The defining retail trait is expense
+ * recovery: most operating expenses are reimbursed by tenants, so the *effective*
+ * (unrecovered) expense ratio is low even though gross expenses are not. Triage
+ * grade (scope-stage VOI ranking), not committee underwriting.
+ *
+ * Citations name the canonical industry source; specific point values within
+ * the range reflect a blend of published surveys and internal calibration.
+ * Bump `version` when any low/central/high shifts beyond round-off.
+ */
+export declare const RETAIL_DEFAULTS: AssetClassDefaults;
+/**
+ * Industrial asset-class defaults, v1.0.0.
+ *
+ * Calibrated for stabilized Class A/B bulk-distribution and logistics product on
+ * NNN leases. Industrial has the lowest effective expense ratio of the major
+ * classes (cheap to operate, near-total expense recovery) and the tightest cap
+ * rates. Triage grade (scope-stage VOI ranking), not committee underwriting.
+ *
+ * Citations name the canonical industry source; specific point values within
+ * the range reflect a blend of published surveys and internal calibration.
+ * Bump `version` when any low/central/high shifts beyond round-off.
+ */
+export declare const INDUSTRIAL_DEFAULTS: AssetClassDefaults;
+/**
+ * Self-storage asset-class defaults, v1.0.0.
+ *
+ * Calibrated for stabilized drive-up and climate-controlled storage facilities.
+ * The key class-specific inputs are physical occupancy, economic occupancy,
+ * and revenue per net rentable square foot. Triage grade (scope-stage VOI
+ * ranking), not committee underwriting.
+ */
+export declare const SELF_STORAGE_DEFAULTS: AssetClassDefaults;
+/**
+ * Look up the published defaults for an asset class. Returns null when no
+ * table is registered (callers should fall through to `global_default` /
+ * `system_default` per the cascade in protocol §V.7).
+ */
+export declare function getAssetClassDefaults(asset_class: string): AssetClassDefaults | null;
+/**
+ * Look up a single default range by `(asset_class, field_path)`. Returns null
+ * if the asset class has no table or the field has no published default.
+ */
+export declare function getDefaultRange(asset_class: string, field_path: string): DefaultRange | null;
+/**
+ * List the field paths for which an asset class publishes defaults. Useful for
+ * the refinement engine to enumerate candidate inputs.
+ */
+export declare function listDefaultedFields(asset_class: string): string[];
+//# sourceMappingURL=defaults.d.ts.map

package/dist/defaults.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../src/defaults.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,UAAU,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEhF,MAAM,WAAW,YAAY;IAC3B,0CAA0C;IAC1C,GAAG,EAAE,MAAM,CAAC;IACZ,mEAAmE;IACnE,OAAO,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,mEAAmE;IACnE,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,+DAA+D;IAC/D,MAAM,EAAE,qBAAqB,CAAC;IAC9B,uDAAuD;IACvD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4EAA4E;IAC5E,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,UAAU,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;IACxC,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,sEAAsE;IACtE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;CACtC;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,EAAE,kBA6FlC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,EAAE,kBA6G7B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,EAAE,kBA6G7B,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,mBAAmB,EAAE,kBA6GjC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,EAAE,kBAqGnC,CAAC;AAUF;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,MAAM,GAAG,kBAAkB,GAAG,IAAI,CAEpF;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI,CAG5F;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,CAGjE"}