@justins-home/types 1.0.0

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@justins-home/types",
+  "version": "1.0.0",
+  "private": false,
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "lint": "eslint src",
+    "check-types": "tsc --noEmit -p ../../tsconfig.base.json",
+    "build": "tsup src/index.ts --format esm,cjs",
+    "test": "vitest"
+  }
+}

package/src/api.types.ts

@@ -0,0 +1,33 @@
+export interface ApiResponse<T> {
+  message: string;
+  data?: T;
+  event?: string | null;
+}
+
+export interface PaginatedResponse<T> {
+  message: string;
+
+  data: T[];
+
+  meta: {
+    current_page: number;
+    last_page: number;
+    per_page: number;
+    total: number;
+  };
+
+  links: {
+    first?: string;
+    last?: string;
+    prev?: string | null;
+    next?: string | null;
+  };
+
+  event?: string | null;
+}
+
+export interface ApiErrorResponse {
+  message: string;
+  errors?: Record<string, any>;
+  event?: string | null;
+}

package/src/common.types.ts

@@ -0,0 +1,37 @@
+export interface UserSummary {
+  uid: string;
+  name: string;
+}
+
+export interface PricePayload {
+  amount: string;
+  currency: string;
+  period?: string;
+}
+
+export interface MediaPayload {
+  cover?: string | null;
+  count?: number;
+}
+
+export interface WorkflowState {
+  current_step: string;
+  can_submit?: boolean;
+  missing_requirements?: string[];
+}
+
+export interface ListingRef {
+  id: number;
+  uid: string;
+}
+
+export interface PlanRef {
+  key: string;
+  name: string;
+}
+export interface ConversationRef {
+  id: number;
+}
+export interface InspectionRef {
+  uid: string;
+}

package/src/compliance.types.ts

@@ -0,0 +1,93 @@
+export interface ComplianceDefinition {
+  id: number;
+
+  compliance_key: string;
+
+  name: string;
+
+  description?: string | null;
+
+  enforcement_level: string;
+
+  validity_type?: string | null;
+
+  grace_period_days?: number | null;
+
+  status?: string | null;
+
+  requirements?: string[];
+}
+
+export interface ComplianceRequirement {
+  verification_layer_key: string;
+}
+
+export interface ComplianceStatus {
+  overall: string;
+
+  breakdown: ComplianceBreakdown[];
+}
+
+export interface ComplianceBreakdown {
+  compliance_key: string;
+
+  state: string;
+
+  valid_until?: string | null;
+}
+
+export interface ListingComplianceStateResource {
+  listing_uid: string;
+
+  compliances: ComplianceStatus;
+}
+
+export interface ComplianceSubmissionCompliance {
+  id: number;
+  key: string;
+  name: string;
+}
+
+export interface ListingComplianceSubmissionResource {
+  id: number;
+
+  listing_id: number;
+
+  compliance: ComplianceSubmissionCompliance;
+
+  verification_layer_key: string;
+
+  status: string;
+
+  submitted_data: Record<string, any>;
+
+  rejection_reason?: string | null;
+
+  reviewed_by?: number | null;
+
+  reviewed_at?: string | null;
+
+  created_at: string;
+}
+
+export interface TenancyComplianceSubmissionResource {
+  id: number;
+
+  tenancy_id: number;
+
+  compliance: ComplianceSubmissionCompliance;
+
+  verification_layer_key: string;
+
+  status: string;
+
+  submitted_data: Record<string, any>;
+
+  rejection_reason?: string | null;
+
+  reviewed_by?: number | null;
+
+  reviewed_at?: string | null;
+
+  created_at: string;
+}

package/src/feature.types.ts

@@ -0,0 +1,38 @@
+export interface Feature {
+  id: number;
+  name: string;
+  is_filterable?: boolean;
+}
+
+export interface PropertyFeature extends Feature {
+  category_id: number;
+
+  description?: string;
+  icon?: string;
+
+  is_active: boolean;
+}
+
+export interface PropertyFeatureCategory {
+  id: number;
+
+  name: string;
+  description?: string;
+
+  display_order?: number;
+
+  is_active: boolean;
+
+  features?: PropertyFeature[];
+}
+
+export interface FeatureGroup {
+  group: {
+    id: number;
+    name: string;
+    description?: string;
+    display_order?: number;
+  };
+
+  features: Feature[];
+}

package/src/index.ts

@@ -0,0 +1,20 @@
+export * from './api.types';
+export * from './common.types';
+
+export * from './user.types';
+
+export * from './listing.types';
+export * from './tenancy.types';
+export * from './compliance.types';
+
+export * from './inspection.types';
+export * from './maintenance.types';
+
+export * from './messaging.types';
+export * from './notification.types';
+
+export * from './verification.types';
+export * from './plan.types';
+
+export * from './wishlist.types';
+export * from './review.types';

package/src/inspection.types.ts

@@ -0,0 +1,37 @@
+
+import { UserType } from './user.types';
+
+export interface InspectionMedia {
+  uid: string;
+  file_type: string;
+  caption?: string | null;
+  path: string;
+}
+
+
+
+export interface InspectionResource {
+  uid: string;
+
+  inspection_type?: string | null;
+
+  status?: string | null;
+
+  scheduled_date?: string | null;
+
+  completed_date?: string | null;
+
+  condition_rating?: string | null;
+
+  summary?: string | null;
+
+  next_inspection_date?: string | null;
+
+  inspector?: UserType;
+
+  media?: InspectionMedia[];
+
+  created_at?: string | null;
+
+  updated_at?: string | null;
+}

package/src/listing.types.ts

@@ -0,0 +1,65 @@
+import { PricePayload, MediaPayload, WorkflowState } from './common.types';
+import { ComplianceDefinition, ComplianceStatus } from './compliance.types';
+import { UserType } from './user.types';
+
+export interface PropertyListingSummary {
+  property_type?: string;
+
+  bedrooms?: number;
+
+  bathrooms?: number;
+
+  city?: string;
+
+  availability?: string;
+}
+
+export interface UsedItemListingSummary {
+  item_name?: string;
+
+  condition?: string;
+
+  category?: string;
+
+  availability?: string;
+}
+
+export interface BaseListingResource {
+  uid: string;
+
+  listing_type: string;
+
+  state: string;
+
+  is_visible: boolean;
+
+  price: PricePayload;
+
+  owner?: UserType;
+
+  created_by?: UserType;
+
+  workflow?: WorkflowState;
+
+  media?: MediaPayload;
+}
+
+export interface PropertyListingResource extends BaseListingResource {
+  vertical: 'property';
+
+  summary?: PropertyListingSummary;
+}
+
+export interface UsedItemListingResource extends BaseListingResource {
+  vertical: 'used_item';
+
+  summary?: UsedItemListingSummary;
+}
+
+export type ListingResource = PropertyListingResource | UsedItemListingResource;
+
+export type ListingWithComplianceResource = ListingResource & {
+  compliances: ComplianceDefinition[];
+
+  compliance_status: ComplianceStatus;
+};

package/src/maintenance.types.ts

@@ -0,0 +1,59 @@
+import { ListingRef } from './common.types';
+import { UserType } from './user.types';
+
+export interface MaintenanceAttachmentResource {
+  uid: string;
+
+  file_type: string;
+
+  url: string;
+
+  uploaded_by?: UserType;
+
+  created_at: string;
+}
+
+export interface MaintenanceUpdateResource {
+  uid: string;
+
+  note?: string | null;
+
+  user: UserType;
+
+  created_at: string;
+}
+
+
+export interface MaintenanceRequestResource {
+  uid: string;
+
+  title: string;
+
+  description?: string | null;
+
+  status: string;
+
+  priority: string;
+
+  reported_at?: string | null;
+
+  assigned_at?: string | null;
+
+  completed_at?: string | null;
+
+  sla_deadline?: string | null;
+
+  listing?: ListingRef;
+  
+  reporter?: UserType;
+
+  technician?: UserType;
+
+  updates?: MaintenanceUpdateResource[];
+
+  attachments?: MaintenanceAttachmentResource[];
+
+  created_at: string;
+
+  updated_at: string;
+}

package/src/messaging.types.ts

@@ -0,0 +1,36 @@
+import { ListingRef } from './common.types';
+import { UserType } from './user.types';
+
+export interface ConversationResource {
+  id: number;
+
+  type: string;
+
+  listing?: ListingRef;
+
+  created_by?: UserType;
+
+  last_message_at?: string | null;
+
+  created_at: string;
+}
+
+export interface MessageResource {
+  id: number;
+
+  conversation_id: number;
+
+  sender?: UserType;
+
+  body?: string | null;
+
+  attachment_url?: string | null;
+
+  is_system: boolean;
+
+  state: string;
+
+  read_at?: string | null;
+
+  created_at: string;
+}

package/src/notification.types.ts

@@ -0,0 +1,15 @@
+export interface NotificationResource {
+  id: string;
+
+  type: string;
+
+  title: string;
+
+  body: string;
+
+  data?: Record<string, any>;
+
+  read_at?: string | null;
+
+  created_at: string;
+}

package/src/plan.types.ts

@@ -0,0 +1,43 @@
+export interface CapabilityResource {
+  key: string;
+
+  name: string;
+
+  description?: string | null;
+}
+
+export interface EntitlementResource {
+  key: string;
+
+  name: string;
+
+  description?: string | null;
+
+  value_type: string;
+}
+
+export interface PlanEntitlementResource {
+  key: string;
+
+  name: string;
+
+  description?: string | null;
+
+  value: number | string | boolean | null;
+}
+
+export interface PlanResource {
+  key: string;
+
+  name: string;
+
+  user_type: string;
+
+  is_active: boolean;
+
+  capabilities?: CapabilityResource[];
+
+  entitlements?: PlanEntitlementResource[];
+
+  verification_requirements?: string[];
+}

package/src/review.types.ts

@@ -0,0 +1,16 @@
+export interface ReviewResource {
+  id: number;
+
+  rating: number;
+
+  comment?: string;
+
+  reviewer: {
+    id: number;
+    name: string;
+  };
+
+  created_at?: string;
+
+  updated_at?: string;
+}

package/src/tenancy.types.ts

@@ -0,0 +1,43 @@
+import { ComplianceDefinition } from './compliance.types';
+import { ComplianceStatus } from './compliance.types';
+
+export interface TenancyResource {
+  uid: string;
+
+  listing_id: number;
+
+  landlord_id: number;
+  tenant_id: number;
+
+  rent_amount: string | number;
+  deposit_amount: string | number;
+
+  state: string;
+
+  start_date: string | null;
+  end_date: string | null;
+
+  is_periodic: boolean;
+
+  created_at: string;
+}
+
+export interface TenancyTransitionResource {
+  from_state: string;
+
+  to_state: string;
+
+  changed_by_user_id: number;
+
+  changed_by_name?: string | null;
+
+  comment?: string | null;
+
+  created_at: string;
+}
+
+export interface TenancyWithComplianceResource extends TenancyResource {
+  compliances: ComplianceDefinition[];
+
+  compliance_status: ComplianceStatus;
+}

package/src/user.types.ts

@@ -0,0 +1,17 @@
+export interface UserResource {
+  uid: string;
+
+  name: string;
+
+  email: string;
+
+  avatar?: string;
+}
+
+export interface UserType {
+  id: number;
+
+  uid: string;
+
+  name: string;
+}

package/src/verification.types.ts

@@ -0,0 +1,65 @@
+export interface VerificationLayerResource {
+  id: number;
+
+  key: string;
+
+  name: string;
+
+  description?: string | null;
+
+  requires_review: boolean;
+
+  metadata_schema?: Record<string, any> | null;
+
+  is_active: boolean;
+
+  created_at: string;
+
+  updated_at: string;
+}
+
+export interface VerificationFlowResource {
+  order: number;
+
+  is_required: boolean;
+
+  layer?: VerificationLayerResource;
+}
+
+export interface VerificationFlowGroupResource {
+  user_type: string;
+
+  user_type_class: string;
+
+  layers: VerificationFlowResource[];
+}
+
+export interface UserVerificationResource {
+  id: number;
+
+  status: string;
+
+  submitted_data?: Record<string, any>;
+
+  rejection_reason?: string | null;
+
+  layer?: VerificationLayerResource;
+
+  reviewed_by?: number | null;
+
+  reviewed_at?: string | null;
+
+  created_at: string;
+
+  updated_at: string;
+}
+
+export interface UserVerificationStateResource {
+  current_level: number;
+
+  completed_layers: string[];
+
+  pending_layers: string[];
+
+  last_calculated_at?: string | null;
+}

package/src/wishlist.types.ts

@@ -0,0 +1,7 @@
+import { ListingResource } from './listing.types';
+
+export interface WishlistResource {
+  wishlist_uid: string;
+
+  listing?: ListingResource;
+}