@honestdigital/vehicle-service-types 1.0.13

package/README.md

@@ -0,0 +1,76 @@
+# @honestdigital/vehicle-service-types
+
+TypeScript type definitions for the HonestCMS Vehicle Service API.
+
+## Overview
+
+This package provides type-safe TypeScript definitions for building clients that interact with the HonestCMS Vehicle Service. The service manages vehicle inventory operations for multi-tenant automotive dealerships.
+
+## Installation
+
+```bash
+npm install @honestdigital/vehicle-service-types
+# or
+bun add @honestdigital/vehicle-service-types
+```
+
+## Usage
+
+### Type-Safe tRPC Client
+
+```typescript
+import type { AppRouter } from '@honestdigital/vehicle-service-types/types'
+import { createTRPCClient, httpBatchLink } from '@trpc/client'
+
+const client = createTRPCClient<AppRouter>({
+  links: [
+    httpBatchLink({
+      url: 'https://your-api.com/trpc',
+      headers: {
+        'x-tenant-id': '1',
+      },
+    }),
+  ],
+})
+
+// Fully type-safe calls with autocomplete
+const vehicles = await client.inventory.getInventory.query({
+  filters: {},
+  limit: 20,
+})
+```
+
+### Type Imports
+
+```typescript
+import type {
+  Vehicle,
+  FilterState,
+  SyncResult,
+} from '@honestdigital/vehicle-service-types/types'
+```
+
+## What's Included
+
+This package contains only TypeScript type definitions (`.d.ts` files) for:
+
+- **AppRouter** - tRPC router type for client inference
+- **Vehicle Types** - Vehicle data structures and pricing information
+- **Filter Types** - Inventory filtering and sorting options
+- **Sync Types** - Data synchronization operations
+
+## Requirements
+
+- TypeScript 5.0+
+- tRPC 11.0+ (if using tRPC client)
+
+## Features
+
+- ✅ Full type safety for API calls
+- ✅ IntelliSense autocomplete support
+- ✅ Zero runtime dependencies
+- ✅ Compatible with any tRPC client setup
+
+## Support
+
+For API documentation and integration guides, contact HonestDigital support.

package/dist/context.d.ts

@@ -0,0 +1,53 @@
+/**
+ * tRPC context factory for Hono + Cloudflare Workers
+ * Creates context with tenant info and environment bindings
+ */
+import type { Context } from 'hono';
+/**
+ * Cloudflare Workers Rate Limiter binding type
+ */
+type RateLimiter = {
+    limit: (options: {
+        key: string;
+    }) => Promise<{
+        success: boolean;
+    }>;
+};
+/**
+ * Cloudflare Workers environment bindings
+ * Includes secrets and environment variables defined in wrangler.toml
+ */
+export type Bindings = {
+    POSTGRES_URL: string;
+    NODE_ENV?: string;
+    CRON_API_KEY?: string;
+    SENTRY_DSN?: string;
+    CF_VERSION_METADATA?: {
+        id: string;
+    };
+    RATE_LIMITER?: RateLimiter;
+    DISABLE_RATE_LIMIT?: string;
+    BUILD_API_KEY?: string;
+    CHROME_IMAGE_PROXY_URL?: string;
+    ADMIN_USERNAME?: string;
+    ADMIN_PASSWORD?: string;
+};
+/**
+ * Context shape passed to all tRPC procedures
+ * Includes tenant isolation and environment access
+ */
+export type TRPCContext = {
+    tenantId: number | null;
+    tenantSlug: string | null;
+    env: Bindings;
+    req: Context['req'];
+};
+/**
+ * Creates tRPC context from Hono context
+ * Extracts tenant from headers for multi-tenant isolation
+ */
+export declare function createContext(c: Context<{
+    Bindings: Bindings;
+}>): TRPCContext;
+export {};
+//# sourceMappingURL=context.d.ts.map

package/dist/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAGnC;;GAEG;AACH,KAAK,WAAW,GAAG;IACjB,KAAK,EAAE,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAA;CACnE,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,mBAAmB,CAAC,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAA;IACpC,YAAY,CAAC,EAAE,WAAW,CAAA;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,GAAG,EAAE,QAAQ,CAAA;IACb,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;CACpB,CAAA;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,OAAO,CAAC;IAAE,QAAQ,EAAE,QAAQ,CAAA;CAAE,CAAC,GAAG,WAAW,CA+B7E"}

package/dist/repositories/vehicleConfigOptions.d.ts

@@ -0,0 +1,165 @@
+import type { Vehicle } from '@/types';
+import type { EnvBindings } from '@/types/index';
+import type { ImageParams } from '@/types/vehicle';
+import { BaseRepository } from './baseRepository';
+export interface ColorOption {
+    code: string;
+    name: string;
+    hex?: string;
+}
+export interface VehicleConfiguration {
+    brand: string;
+    model: string;
+    year: number;
+    currentTrim: string | null;
+    currentExteriorColor: string | null;
+    currentInteriorColor: string | null;
+    availableTrims: Array<{
+        trim: string;
+        count: number;
+    }>;
+    availableExteriorColors: ColorOption[];
+    availableInteriorColors: ColorOption[];
+}
+export interface TrimColors {
+    exteriorColors: string[];
+    interiorColors: string[];
+}
+export declare class VehicleConfigOptionsRepository extends BaseRepository {
+    protected readonly repositoryName = "VehicleConfigOptionsRepository";
+    static getInstance: () => VehicleConfigOptionsRepository;
+    private constructor();
+    /**
+     * Determine color type from color name
+     */
+    private getColorType;
+    /**
+     * Get fallback hex color from color name
+     */
+    private getFallbackHex;
+    /**
+     * Build color options from raw database results
+     */
+    private buildColorOptions;
+    /**
+     * Build trim options from raw database results
+     */
+    private buildTrimOptions;
+    /**
+     * Build changes object showing what was different from the request
+     */
+    private buildChangesObject;
+    /**
+     * Get available colors for a specific trim
+     * @param brand Vehicle brand
+     * @param model Vehicle model
+     * @param trimId Trim identifier
+     * @param tenantId Tenant ID for isolation
+     */
+    getAvailableColorsForTrim(brand: string, model: string, trimId: string, tenantId: number | null, env?: EnvBindings): Promise<TrimColors>;
+    /**
+     * Build parameterized SQL status filter, expanding USED to include CERTIFIED when toggle is on.
+     * Returns the SQL fragment and the updated paramIndex.
+     */
+    private buildStatusFilter;
+    /**
+     * Find vehicle by configuration parameters
+     * Uses optimized single CTE query to eliminate N+1 queries
+     * @param brand Vehicle brand
+     * @param model Vehicle model
+     * @param trim Vehicle trim
+     * @param exteriorColor Exterior color name
+     * @param interiorColor Interior color name
+     * @param priorityField Field to prioritize in matching
+     * @param tenantId Tenant ID for isolation
+     * @param env Optional environment bindings
+     * @param imageParams Optional image params to include sized images
+     */
+    getVehicleByConfiguration(brand: string, model: string, trim: string | null, exteriorColor: string | null, interiorColor: string | null, priorityField?: string, tenantId?: number | null, env?: EnvBindings, imageParams?: ImageParams | null, status?: string): Promise<{
+        vehicle: Vehicle;
+        matchType: 'exact' | 'partial';
+        changes: {
+            trim?: {
+                requested: string;
+                returned: string;
+            };
+            exteriorColor?: {
+                requested: string;
+                returned: string;
+            };
+            interiorColor?: {
+                requested: string;
+                returned: string;
+            };
+        };
+        colorOptions: {
+            exterior: Array<{
+                id: string;
+                name: string;
+                hex: string;
+                type: 'standard' | 'metallic' | 'premium';
+                available: boolean;
+            }>;
+            interior: Array<{
+                id: string;
+                name: string;
+                hex: string;
+                type: 'standard' | 'metallic' | 'premium';
+                available: boolean;
+            }>;
+        };
+        matchingCount: number;
+        trimOptions: Array<{
+            id: string;
+            name: string;
+            description: string;
+            available: boolean;
+        }>;
+    }>;
+    /**
+     * Get vehicle by slug with configuration options in a single query
+     * Combines getVehicleBySlug and getVehicleByConfiguration into one CTE query
+     * @param brand Vehicle brand
+     * @param modelTrimSlug Model-trim slug (e.g., "xc40-b4-fwd-core")
+     * @param status Optional status filter (NEW, USED, CERTIFIED)
+     * @param tenantId Tenant ID for isolation
+     * @param env Optional environment bindings
+     * @param imageParams Optional image params to include sized images
+     */
+    getVehicleBySlugWithConfig(brand: string, modelTrimSlug: string, status: string | null, tenantId: number | null, env?: EnvBindings, imageParams?: ImageParams | null): Promise<{
+        vehicle: Vehicle;
+        matchType: 'exact' | 'partial';
+        colorOptions: {
+            exterior: Array<{
+                id: string;
+                name: string;
+                hex: string;
+                type: 'standard' | 'metallic' | 'premium';
+                available: boolean;
+            }>;
+            interior: Array<{
+                id: string;
+                name: string;
+                hex: string;
+                type: 'standard' | 'metallic' | 'premium';
+                available: boolean;
+            }>;
+        };
+        matchingCount: number;
+        trimOptions: Array<{
+            id: string;
+            name: string;
+            description: string;
+            available: boolean;
+        }>;
+    } | null>;
+    /**
+     * Get vehicle configuration by VIN with available options
+     * @param vin Vehicle identification number
+     * @param tenantId Tenant ID for isolation
+     * @param env Optional environment bindings
+     * @returns Vehicle configuration with available trims and colors
+     */
+    getVehicleConfigurationByVin(vin: string, tenantId: number | null, env?: EnvBindings): Promise<VehicleConfiguration>;
+}
+//# sourceMappingURL=vehicleConfigOptions.d.ts.map

package/dist/repositories/vehicleConfigOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vehicleConfigOptions.d.ts","sourceRoot":"","sources":["../../src/repositories/vehicleConfigOptions.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AACtC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAKlD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAMjD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAA;IACnC,cAAc,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;IACtD,uBAAuB,EAAE,WAAW,EAAE,CAAA;IACtC,uBAAuB,EAAE,WAAW,EAAE,CAAA;CACvC;AAED,MAAM,WAAW,UAAU;IACzB,cAAc,EAAE,MAAM,EAAE,CAAA;IACxB,cAAc,EAAE,MAAM,EAAE,CAAA;CACzB;AAQD,qBAAa,8BAA+B,SAAQ,cAAc;IAChE,SAAS,CAAC,QAAQ,CAAC,cAAc,oCAAmC;IACpE,MAAM,CAAC,WAAW,uCAA8D;IAEhF,OAAO;IAKP;;OAEG;IACH,OAAO,CAAC,YAAY;IAOpB;;OAEG;IACH,OAAO,CAAC,cAAc;IAWtB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAsBzB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IASxB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAgC1B;;;;;;OAMG;IACG,yBAAyB,CAC7B,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,GAAG,CAAC,EAAE,WAAW,GAChB,OAAO,CAAC,UAAU,CAAC;IAatB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAkBzB;;;;;;;;;;;;OAYG;IACG,yBAAyB,CAC7B,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,GAAG,IAAI,EACnB,aAAa,EAAE,MAAM,GAAG,IAAI,EAC5B,aAAa,EAAE,MAAM,GAAG,IAAI,EAC5B,aAAa,CAAC,EAAE,MAAM,EACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,EACxB,GAAG,CAAC,EAAE,WAAW,EACjB,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI,EAChC,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC;QACT,OAAO,EAAE,OAAO,CAAA;QAChB,SAAS,EAAE,OAAO,GAAG,SAAS,CAAA;QAC9B,OAAO,EAAE;YACP,IAAI,CAAC,EAAE;gBAAE,SAAS,EAAE,MAAM,CAAC;gBAAC,QAAQ,EAAE,MAAM,CAAA;aAAE,CAAA;YAC9C,aAAa,CAAC,EAAE;gBAAE,SAAS,EAAE,MAAM,CAAC;gBAAC,QAAQ,EAAE,MAAM,CAAA;aAAE,CAAA;YACvD,aAAa,CAAC,EAAE;gBAAE,SAAS,EAAE,MAAM,CAAC;gBAAC,QAAQ,EAAE,MAAM,CAAA;aAAE,CAAA;SACxD,CAAA;QACD,YAAY,EAAE;YACZ,QAAQ,EAAE,KAAK,CAAC;gBACd,EAAE,EAAE,MAAM,CAAA;gBACV,IAAI,EAAE,MAAM,CAAA;gBACZ,GAAG,EAAE,MAAM,CAAA;gBACX,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,CAAA;gBACzC,SAAS,EAAE,OAAO,CAAA;aACnB,CAAC,CAAA;YACF,QAAQ,EAAE,KAAK,CAAC;gBACd,EAAE,EAAE,MAAM,CAAA;gBACV,IAAI,EAAE,MAAM,CAAA;gBACZ,GAAG,EAAE,MAAM,CAAA;gBACX,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,CAAA;gBACzC,SAAS,EAAE,OAAO,CAAA;aACnB,CAAC,CAAA;SACH,CAAA;QACD,aAAa,EAAE,MAAM,CAAA;QACrB,WAAW,EAAE,KAAK,CAAC;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,WAAW,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,OAAO,CAAA;SAAE,CAAC,CAAA;KAC1F,CAAC;IAyNF;;;;;;;;;OASG;IACG,0BAA0B,CAC9B,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,MAAM,GAAG,IAAI,EACrB,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,GAAG,CAAC,EAAE,WAAW,EACjB,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI,GAC/B,OAAO,CAAC;QACT,OAAO,EAAE,OAAO,CAAA;QAChB,SAAS,EAAE,OAAO,GAAG,SAAS,CAAA;QAC9B,YAAY,EAAE;YACZ,QAAQ,EAAE,KAAK,CAAC;gBACd,EAAE,EAAE,MAAM,CAAA;gBACV,IAAI,EAAE,MAAM,CAAA;gBACZ,GAAG,EAAE,MAAM,CAAA;gBACX,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,CAAA;gBACzC,SAAS,EAAE,OAAO,CAAA;aACnB,CAAC,CAAA;YACF,QAAQ,EAAE,KAAK,CAAC;gBACd,EAAE,EAAE,MAAM,CAAA;gBACV,IAAI,EAAE,MAAM,CAAA;gBACZ,GAAG,EAAE,MAAM,CAAA;gBACX,IAAI,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,CAAA;gBACzC,SAAS,EAAE,OAAO,CAAA;aACnB,CAAC,CAAA;SACH,CAAA;QACD,aAAa,EAAE,MAAM,CAAA;QACrB,WAAW,EAAE,KAAK,CAAC;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,WAAW,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,OAAO,CAAA;SAAE,CAAC,CAAA;KAC1F,GAAG,IAAI,CAAC;IA0KT;;;;;;OAMG;IACG,4BAA4B,CAChC,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,GAAG,IAAI,EACvB,GAAG,CAAC,EAAE,WAAW,GAChB,OAAO,CAAC,oBAAoB,CAAC;CAkHjC"}