@grupolapa/cotizador-sdk 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,502 @@
+export type PaymentSchemeType = "cashback" | "installment";
+export type PaymentProvider = "mercado_pago" | "stripe";
+export type InventoryStatus = "available" | "reserved" | "sold" | "unavailable";
+export type InventoryStatusLabels = {
+    available: string;
+    reserved: string;
+    sold: string;
+    unavailable?: string;
+};
+export type ProductInventoryMode = "units" | "shares";
+export type InventoryCategory = string;
+export type EntryProductKind = "copropiedad" | "acciones";
+export type ReservationProductKind = "inventory" | "copropiedad" | "acciones";
+export interface ProductTypeInventoryUnit {
+    id: string;
+    unitNumber: string;
+    areaM2: number;
+    pricePerM2MXN: number;
+    status: InventoryStatus;
+    svgElementIds?: string[];
+    svgPath?: string;
+}
+export interface ProductTypeShareInventory {
+    totalShares: number;
+    soldSharesBaseline: number;
+}
+export interface ProductType {
+    id: string;
+    name: string;
+    category: InventoryCategory;
+    deliveryDate: string;
+    allowedSchemeIds: string[];
+    defaultSchemeId: string;
+    inventoryMode?: ProductInventoryMode;
+    shareInventory?: ProductTypeShareInventory;
+    inventory: ProductTypeInventoryUnit[];
+}
+export interface InventoryUnit {
+    id: string;
+    unitNumber: string;
+    name: string;
+    productTypeId: string;
+    productTypeName: string;
+    category: InventoryCategory;
+    areaM2: number;
+    pricePerM2MXN: number;
+    deliveryDate: string;
+    allowedSchemeIds: string[];
+    defaultSchemeId: string;
+    inventoryMode?: ProductInventoryMode;
+    status: InventoryStatus;
+    svgElementIds?: string[];
+    svgPath?: string;
+}
+export interface InventoryShareAvailability {
+    total: number;
+    soldBaseline: number;
+    soldPaid: number;
+    soldTotal: number;
+    remaining: number;
+}
+export interface InventoryAvailability {
+    unitId: string;
+    productTypeId: string;
+    inventoryMode: ProductInventoryMode;
+    status: InventoryStatus;
+    canCheckout: boolean;
+    isSoldOutByShares?: boolean;
+    share?: InventoryShareAvailability;
+}
+export type InventoryAvailabilityByUnitId = Record<string, InventoryAvailability>;
+export interface FloorPlan {
+    floor: string;
+    image: string;
+    svg: string;
+    viewBox: string;
+    label: string;
+}
+export type FloorPlansByCategory = Partial<Record<InventoryCategory, FloorPlan>>;
+export interface RangeRule {
+    min: number;
+    max: number;
+    step: number;
+}
+interface PaymentSchemeBase {
+    id: string;
+    name: string;
+    description: string;
+    type: PaymentSchemeType;
+    active: boolean;
+}
+export interface CashbackPaymentScheme extends PaymentSchemeBase {
+    type: "cashback";
+    cashbackRate: number;
+    downPaymentRange: RangeRule;
+}
+export interface InstallmentPaymentScheme extends PaymentSchemeBase {
+    type: "installment";
+    downPaymentPct: number;
+    monthlyPct: number;
+    deferredPct: number;
+    deliveryPct: number;
+}
+export type PaymentSchemeDefinition = CashbackPaymentScheme | InstallmentPaymentScheme;
+export interface FinanceRules {
+    rentalRate: number;
+    accionesRentalRate: number;
+    corporateInflationRate: number;
+    bookingAmountMXN: number;
+    paymentsEnabled: boolean;
+    paymentProvider: PaymentProvider;
+    defaults: {
+        category: InventoryCategory;
+        unitId: string;
+        schemeId: string;
+        plusvaliaAnnualPct: number;
+        postDeliveryYears: number;
+        downPaymentPct: number;
+    };
+    ranges: {
+        postDeliveryYears: RangeRule;
+    };
+    milestones: {
+        cashbackStart: string;
+        midpoint: string;
+        delivery: string;
+        annualityPrefix: string;
+    };
+    disclaimer: string;
+}
+export interface SiteCategoryCopy {
+    id: InventoryCategory;
+    label: string;
+    description: string;
+    defaultDeliveryDate?: string;
+}
+export interface UploadedImageAsset {
+    imageUrl: string;
+    imageKey?: string;
+}
+export interface SplashScreenContent extends UploadedImageAsset {
+    backgroundColor: string;
+}
+export interface SiteContent {
+    brand: string;
+    subBrand: string;
+    heroEyebrow: string;
+    heroTitle: string;
+    heroDescription: string;
+    splash: SplashScreenContent;
+    favicon?: UploadedImageAsset;
+    uondrHeaderIcon?: UploadedImageAsset;
+    categories: SiteCategoryCopy[];
+    statusLabels: InventoryStatusLabels;
+    sections: Record<"inventory" | "proposal" | "metrics" | "breakdown" | "timeline" | "outlook" | "contact" | "disclaimer", string>;
+    cta: {
+        primaryLabel: string;
+        secondaryLabel: string;
+        missingWhatsapp: string;
+        unavailableInventory: string;
+    };
+}
+export interface EntrySettings {
+    apartmentLotIds: string[];
+    corporateLotId: string | null;
+}
+export interface EntryInventoryContent {
+    apartmentUnitIds: string[];
+    corporateUnitId: string | null;
+}
+export interface AppContent {
+    entryInventory: EntryInventoryContent;
+    entrySettings: EntrySettings;
+    financeRules: FinanceRules;
+    floorPlans: FloorPlansByCategory;
+    productTypes: ProductType[];
+    inventory: InventoryUnit[];
+    paymentSchemes: PaymentSchemeDefinition[];
+    siteContent: SiteContent;
+}
+export type ContentStorage = "convex";
+export interface ContentSnapshot {
+    content: AppContent;
+    inventoryAvailabilityByUnitId: InventoryAvailabilityByUnitId;
+    updatedAt: string;
+    storage: ContentStorage;
+}
+export interface ApiErrorResponse {
+    message: string;
+    fieldErrors?: Record<string, string>;
+}
+export interface QuoteInput {
+    unitId: string;
+    scheme: string;
+    plusvaliaAnnualPct: number;
+    postDeliveryYears: number;
+    downPaymentPct: number;
+    installmentDownPaymentPct?: number;
+    installmentMonthlyPct?: number;
+    includeIva: boolean;
+}
+export interface QuoteBreakdownItem {
+    label: string;
+    valueMXN: number;
+    tone: "negative" | "positive" | "auric" | "neutral";
+}
+export interface QuoteTimelineRow {
+    month: number;
+    paymentMXN: number;
+    paymentLabel: string;
+    cashbackMXN: number;
+    plusvaliaDeltaMXN: number;
+    accumulatedCashbackMXN: number;
+    accumulatedPlusvaliaMXN: number;
+    assetValueMXN: number;
+    isMilestone: boolean;
+    milestoneLabel: string;
+}
+export interface ProjectionPoint {
+    yearOffset: number;
+    label: string;
+    assetValueMXN: number;
+    rentalAccumulatedMXN: number;
+    valueWithRentMXN: number;
+}
+export interface PostDeliveryValueRow {
+    periodIndex: number;
+    label: string;
+    plusvaliaDeltaMXN: number;
+    rentalDeltaMXN: number;
+    valueAddedMXN: number;
+    assetValueMXN: number;
+    rentalAccumulatedMXN: number;
+    ownerValueMXN: number;
+}
+export interface QuoteResult {
+    unit: InventoryUnit;
+    scheme: PaymentSchemeDefinition;
+    input: QuoteInput;
+    listPriceMXN: number;
+    deliveryMonths: number;
+    isCashback: boolean;
+    cashbackMonths: number;
+    isCashbackCapped: boolean;
+    downPaymentPct: number;
+    downPaymentAmountMXN: number;
+    balanceAmountMXN: number;
+    cashbackMonthlyMXN: number;
+    cashbackTotalMXN: number;
+    installmentDiscountPct: number;
+    installmentDiscountMXN: number;
+    monthlyPaymentPct: number;
+    monthlyPaymentCount: number;
+    monthlyPaymentAmountMXN: number;
+    deferredPaymentPct: number;
+    deferredPaymentsTotalMXN: number;
+    deferredPaymentsCount: number;
+    deferredPaymentMonths: number[];
+    deferredPaymentAmountMXN: number;
+    deliveryPaymentPct: number;
+    deliveryPaymentAmountMXN: number;
+    netCostMXN: number;
+    plusvaliaAtDeliveryMXN: number;
+    plusvaliaPostDeliveryMXN: number;
+    totalGainMXN: number;
+    finalAssetValueMXN: number;
+    projectedAssetValueMXN: number;
+    rentalMonthlyMXN: number;
+    rentalAccumulatedMXN: number;
+    projectionPoints: ProjectionPoint[];
+    timelineRows: QuoteTimelineRow[];
+    visibleTimelineRows: QuoteTimelineRow[];
+    costBreakdown: QuoteBreakdownItem[];
+    gainBreakdown: QuoteBreakdownItem[];
+}
+export interface QuoteUrlState {
+    category: InventoryCategory;
+    unitId: string;
+    scheme: string;
+    postDeliveryYears: number;
+    downPaymentPct: number;
+    installmentDownPaymentPct?: number;
+    installmentMonthlyPct?: number;
+    includeIva: boolean;
+}
+export interface ContactFormValues {
+    name: string;
+    phone: string;
+    notes: string;
+}
+export type PublicApiLookup = "host" | "preview";
+export interface CotizadorApiErrorBody {
+    code?: string;
+    fieldErrors?: Record<string, string>;
+    message: string;
+}
+export interface CotizadorApiBaseOptions {
+    baseUrl: string;
+    fetch?: typeof fetch;
+}
+export interface PublicSiteInfo {
+    developmentName: string | null;
+    displayName: string;
+    host: string;
+    previewSlug: string;
+    status: string;
+}
+export interface PublicInstanceInfo {
+    displayName: string;
+    hidden: boolean;
+    isDefault: boolean;
+    rendererId: string;
+    slug: string;
+}
+export interface PublicInstancesResponse {
+    instances: PublicInstanceInfo[];
+}
+export interface PublicSnapshotResponse {
+    enabledSurfaces: string[];
+    instance: PublicInstanceInfo | null;
+    instances: PublicInstanceInfo[];
+    site: PublicSiteInfo;
+    snapshot: ContentSnapshot;
+}
+export interface PublicInventoryResponse {
+    availabilityByUnitId: InventoryAvailabilityByUnitId;
+    inventory: InventoryUnit[];
+    instance: PublicInstanceInfo | null;
+    site: PublicSiteInfo;
+    updatedAt: string;
+}
+export interface PublicPaymentProviderConfig {
+    enabled: boolean;
+    publicKey: string | null;
+}
+export interface PublicPaymentMethodsResponse {
+    activeProvider: PaymentProvider;
+    bookingAmountMXN: number;
+    enabled: boolean;
+    instance: PublicInstanceInfo | null;
+    paymentSchemes: PaymentSchemeDefinition[];
+    providers: Record<PaymentProvider, PublicPaymentProviderConfig>;
+    publicKey: string | null;
+    site: PublicSiteInfo;
+}
+export type PublicSitemapShapeTag = "circle" | "ellipse" | "path" | "polygon" | "polyline" | "rect";
+export interface PublicSitemapShape {
+    attributes: Record<string, string>;
+    geometry: Record<string, string>;
+    svgElementId: string;
+    tagName: PublicSitemapShapeTag;
+}
+export interface PublicSitemapUnitHotspot {
+    availability: string | null;
+    lotCode: string;
+    shape: PublicSitemapShape | null;
+    svgElementId: string;
+    unitId: string | null;
+}
+export interface PublicSitemapNavigationHotspot {
+    shape: PublicSitemapShape | null;
+    svgElementId: string;
+    targetMapId: string;
+    targetMapName: string;
+}
+export interface PublicSitemapMap {
+    appliedAt: string | null;
+    assets: {
+        imageHeight: number | null;
+        imageUrl: string;
+        imageWidth: number | null;
+        overlayUrl: string;
+        overlayViewBox: string | null;
+    };
+    clusterKey: string | null;
+    counts: {
+        clusterLinkHotspots: number;
+        linkedShapes: number;
+        lotHotspots: number;
+        missingShapes: number;
+    };
+    id: string;
+    imageHeight: number | null;
+    imageUrl: string;
+    imageWidth: number | null;
+    kind: "cluster" | "root";
+    missingShapeElementIds: string[];
+    name: string;
+    navigationHotspots: PublicSitemapNavigationHotspot[];
+    overlayUrl: string;
+    overlayViewBox: string | null;
+    parentMapId: string | null;
+    shapes: PublicSitemapShape[];
+    unitHotspots: PublicSitemapUnitHotspot[];
+}
+export interface PublicSitemapResponse {
+    development: {
+        id: string;
+        name: string;
+    };
+    maps: PublicSitemapMap[];
+    site: PublicSiteInfo;
+}
+export interface PublicSessionResponse {
+    expiresAt: string;
+    token: string;
+    tokenType: "Bearer";
+}
+export interface PublicReservationItemRequest {
+    productKind?: ReservationProductKind;
+    productLabel?: string;
+    quoteState?: Record<string, unknown>;
+    selection?: Record<string, unknown>;
+    shareQuantity?: number;
+    unitId: string;
+}
+export type PublicReservationPaymentRequest = {
+    provider: "stripe";
+    returnUrl: string;
+} | {
+    installments?: number;
+    payer?: {
+        email: string;
+        first_name?: string;
+        last_name?: string;
+    };
+    payment_method_id: string;
+    payment_type_id: string;
+    provider: "mercado_pago";
+    token: string;
+};
+export interface PublicReservationRequest {
+    instanceSlug?: string;
+    items: PublicReservationItemRequest[];
+    partnerReference?: string;
+    payment: PublicReservationPaymentRequest;
+    posthogDistinctId?: string;
+    posthogSessionId?: string;
+    surface?: "default" | "social" | "uondr" | "entrada";
+}
+export interface PublicReservationItemStatus {
+    fulfillmentStatus: string;
+    inventoryMode?: ProductInventoryMode;
+    productKind: ReservationProductKind;
+    productLabel: string;
+    shareQuantity: number | null;
+    unitId: string;
+    unitName: string;
+}
+export interface PublicReservationStatus {
+    amountMXN: number;
+    checkoutUrl: string | null;
+    externalReference: string;
+    itemCount: number;
+    items: PublicReservationItemStatus[];
+    partnerReference: string | null;
+    productKind: ReservationProductKind;
+    productLabel: string;
+    provider: PaymentProvider;
+    providerStatus: string | null;
+    providerStatusDetail: string | null;
+    status: string;
+    stripePaymentIntentId: string | null;
+    stripeSessionId: string | null;
+    surface: string;
+    unitId: string;
+    unitName: string;
+    updatedAt: string;
+    mercadoPagoStatus?: string | null;
+    mercadoPagoStatusDetail?: string | null;
+    orderId?: string | null;
+    orderStatus?: string | null;
+    orderStatusDetail?: string | null;
+    paymentId?: string | null;
+    preferenceId?: string | null;
+    transactionId?: string | null;
+}
+export interface CotizadorSiteRequest {
+    instanceSlug?: string;
+    lookup?: PublicApiLookup;
+    siteKey: string;
+}
+export interface CotizadorInventoryRequest extends CotizadorSiteRequest {
+    unitIds?: string[];
+}
+export interface CotizadorSitemapRequest extends CotizadorSiteRequest {
+    includeShapes?: boolean;
+}
+export interface CreatePublicSessionRequest {
+    lookup?: PublicApiLookup;
+    origin?: string;
+    siteKey: string;
+}
+export interface CreatePublicReservationRequest extends CotizadorSiteRequest {
+    request: PublicReservationRequest;
+    sessionToken?: string;
+}
+export interface GetPublicReservationRequest {
+    externalReference: string;
+    sessionToken?: string;
+}
+export {};

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@grupolapa/cotizador-sdk",
+  "version": "0.1.0",
+  "description": "Framework-agnostic TypeScript SDK for Grupo LAPA public cotizador integrations.",
+  "type": "module",
+  "license": "UNLICENSED",
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./server": {
+      "types": "./dist/server.d.ts",
+      "import": "./dist/server.js",
+      "default": "./dist/server.js"
+    },
+    "./quote": {
+      "types": "./dist/quote.d.ts",
+      "import": "./dist/quote.js",
+      "default": "./dist/quote.js"
+    },
+    "./sitemap": {
+      "types": "./dist/sitemap.d.ts",
+      "import": "./dist/sitemap.js",
+      "default": "./dist/sitemap.js"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/types.js",
+      "default": "./dist/types.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.build.json",
+    "prepack": "pnpm run build",
+    "typecheck": "tsc --noEmit"
+  }
+}