@justins-home/types 1.0.0 → 1.0.1

package/dist/index.d.mts

@@ -0,0 +1,361 @@
+interface ApiResponse<T> {
+    message: string;
+    data?: T;
+    event?: string | null;
+}
+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;
+}
+interface ApiErrorResponse {
+    message: string;
+    errors?: Record<string, any>;
+    event?: string | null;
+}
+
+interface UserSummary {
+    uid: string;
+    name: string;
+}
+interface PricePayload {
+    amount: string;
+    currency: string;
+    period?: string;
+}
+interface MediaPayload {
+    cover?: string | null;
+    count?: number;
+}
+interface WorkflowState {
+    current_step: string;
+    can_submit?: boolean;
+    missing_requirements?: string[];
+}
+interface ListingRef {
+    id: number;
+    uid: string;
+}
+interface PlanRef {
+    key: string;
+    name: string;
+}
+interface ConversationRef {
+    id: number;
+}
+interface InspectionRef {
+    uid: string;
+}
+
+interface UserResource {
+    uid: string;
+    name: string;
+    email: string;
+    avatar?: string;
+}
+interface UserType {
+    id: number;
+    uid: string;
+    name: string;
+}
+
+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[];
+}
+interface ComplianceRequirement {
+    verification_layer_key: string;
+}
+interface ComplianceStatus {
+    overall: string;
+    breakdown: ComplianceBreakdown[];
+}
+interface ComplianceBreakdown {
+    compliance_key: string;
+    state: string;
+    valid_until?: string | null;
+}
+interface ListingComplianceStateResource {
+    listing_uid: string;
+    compliances: ComplianceStatus;
+}
+interface ComplianceSubmissionCompliance {
+    id: number;
+    key: string;
+    name: string;
+}
+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;
+}
+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;
+}
+
+interface PropertyListingSummary {
+    property_type?: string;
+    bedrooms?: number;
+    bathrooms?: number;
+    city?: string;
+    availability?: string;
+}
+interface UsedItemListingSummary {
+    item_name?: string;
+    condition?: string;
+    category?: string;
+    availability?: string;
+}
+interface BaseListingResource {
+    uid: string;
+    listing_type: string;
+    state: string;
+    is_visible: boolean;
+    price: PricePayload;
+    owner?: UserType;
+    created_by?: UserType;
+    workflow?: WorkflowState;
+    media?: MediaPayload;
+}
+interface PropertyListingResource extends BaseListingResource {
+    vertical: 'property';
+    summary?: PropertyListingSummary;
+}
+interface UsedItemListingResource extends BaseListingResource {
+    vertical: 'used_item';
+    summary?: UsedItemListingSummary;
+}
+type ListingResource = PropertyListingResource | UsedItemListingResource;
+type ListingWithComplianceResource = ListingResource & {
+    compliances: ComplianceDefinition[];
+    compliance_status: ComplianceStatus;
+};
+
+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;
+}
+interface TenancyTransitionResource {
+    from_state: string;
+    to_state: string;
+    changed_by_user_id: number;
+    changed_by_name?: string | null;
+    comment?: string | null;
+    created_at: string;
+}
+interface TenancyWithComplianceResource extends TenancyResource {
+    compliances: ComplianceDefinition[];
+    compliance_status: ComplianceStatus;
+}
+
+interface InspectionMedia {
+    uid: string;
+    file_type: string;
+    caption?: string | null;
+    path: string;
+}
+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;
+}
+
+interface MaintenanceAttachmentResource {
+    uid: string;
+    file_type: string;
+    url: string;
+    uploaded_by?: UserType;
+    created_at: string;
+}
+interface MaintenanceUpdateResource {
+    uid: string;
+    note?: string | null;
+    user: UserType;
+    created_at: string;
+}
+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;
+}
+
+interface ConversationResource {
+    id: number;
+    type: string;
+    listing?: ListingRef;
+    created_by?: UserType;
+    last_message_at?: string | null;
+    created_at: string;
+}
+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;
+}
+
+interface NotificationResource {
+    id: string;
+    type: string;
+    title: string;
+    body: string;
+    data?: Record<string, any>;
+    read_at?: string | null;
+    created_at: string;
+}
+
+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;
+}
+interface VerificationFlowResource {
+    order: number;
+    is_required: boolean;
+    layer?: VerificationLayerResource;
+}
+interface VerificationFlowGroupResource {
+    user_type: string;
+    user_type_class: string;
+    layers: VerificationFlowResource[];
+}
+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;
+}
+interface UserVerificationStateResource {
+    current_level: number;
+    completed_layers: string[];
+    pending_layers: string[];
+    last_calculated_at?: string | null;
+}
+
+interface CapabilityResource {
+    key: string;
+    name: string;
+    description?: string | null;
+}
+interface EntitlementResource {
+    key: string;
+    name: string;
+    description?: string | null;
+    value_type: string;
+}
+interface PlanEntitlementResource {
+    key: string;
+    name: string;
+    description?: string | null;
+    value: number | string | boolean | null;
+}
+interface PlanResource {
+    key: string;
+    name: string;
+    user_type: string;
+    is_active: boolean;
+    capabilities?: CapabilityResource[];
+    entitlements?: PlanEntitlementResource[];
+    verification_requirements?: string[];
+}
+
+interface WishlistResource {
+    wishlist_uid: string;
+    listing?: ListingResource;
+}
+
+interface ReviewResource {
+    id: number;
+    rating: number;
+    comment?: string;
+    reviewer: {
+        id: number;
+        name: string;
+    };
+    created_at?: string;
+    updated_at?: string;
+}
+
+export type { ApiErrorResponse, ApiResponse, BaseListingResource, CapabilityResource, ComplianceBreakdown, ComplianceDefinition, ComplianceRequirement, ComplianceStatus, ComplianceSubmissionCompliance, ConversationRef, ConversationResource, EntitlementResource, InspectionMedia, InspectionRef, InspectionResource, ListingComplianceStateResource, ListingComplianceSubmissionResource, ListingRef, ListingResource, ListingWithComplianceResource, MaintenanceAttachmentResource, MaintenanceRequestResource, MaintenanceUpdateResource, MediaPayload, MessageResource, NotificationResource, PaginatedResponse, PlanEntitlementResource, PlanRef, PlanResource, PricePayload, PropertyListingResource, PropertyListingSummary, ReviewResource, TenancyComplianceSubmissionResource, TenancyResource, TenancyTransitionResource, TenancyWithComplianceResource, UsedItemListingResource, UsedItemListingSummary, UserResource, UserSummary, UserType, UserVerificationResource, UserVerificationStateResource, VerificationFlowGroupResource, VerificationFlowResource, VerificationLayerResource, WishlistResource, WorkflowState };

package/dist/index.d.ts

@@ -0,0 +1,361 @@
+interface ApiResponse<T> {
+    message: string;
+    data?: T;
+    event?: string | null;
+}
+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;
+}
+interface ApiErrorResponse {
+    message: string;
+    errors?: Record<string, any>;
+    event?: string | null;
+}
+
+interface UserSummary {
+    uid: string;
+    name: string;
+}
+interface PricePayload {
+    amount: string;
+    currency: string;
+    period?: string;
+}
+interface MediaPayload {
+    cover?: string | null;
+    count?: number;
+}
+interface WorkflowState {
+    current_step: string;
+    can_submit?: boolean;
+    missing_requirements?: string[];
+}
+interface ListingRef {
+    id: number;
+    uid: string;
+}
+interface PlanRef {
+    key: string;
+    name: string;
+}
+interface ConversationRef {
+    id: number;
+}
+interface InspectionRef {
+    uid: string;
+}
+
+interface UserResource {
+    uid: string;
+    name: string;
+    email: string;
+    avatar?: string;
+}
+interface UserType {
+    id: number;
+    uid: string;
+    name: string;
+}
+
+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[];
+}
+interface ComplianceRequirement {
+    verification_layer_key: string;
+}
+interface ComplianceStatus {
+    overall: string;
+    breakdown: ComplianceBreakdown[];
+}
+interface ComplianceBreakdown {
+    compliance_key: string;
+    state: string;
+    valid_until?: string | null;
+}
+interface ListingComplianceStateResource {
+    listing_uid: string;
+    compliances: ComplianceStatus;
+}
+interface ComplianceSubmissionCompliance {
+    id: number;
+    key: string;
+    name: string;
+}
+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;
+}
+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;
+}
+
+interface PropertyListingSummary {
+    property_type?: string;
+    bedrooms?: number;
+    bathrooms?: number;
+    city?: string;
+    availability?: string;
+}
+interface UsedItemListingSummary {
+    item_name?: string;
+    condition?: string;
+    category?: string;
+    availability?: string;
+}
+interface BaseListingResource {
+    uid: string;
+    listing_type: string;
+    state: string;
+    is_visible: boolean;
+    price: PricePayload;
+    owner?: UserType;
+    created_by?: UserType;
+    workflow?: WorkflowState;
+    media?: MediaPayload;
+}
+interface PropertyListingResource extends BaseListingResource {
+    vertical: 'property';
+    summary?: PropertyListingSummary;
+}
+interface UsedItemListingResource extends BaseListingResource {
+    vertical: 'used_item';
+    summary?: UsedItemListingSummary;
+}
+type ListingResource = PropertyListingResource | UsedItemListingResource;
+type ListingWithComplianceResource = ListingResource & {
+    compliances: ComplianceDefinition[];
+    compliance_status: ComplianceStatus;
+};
+
+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;
+}
+interface TenancyTransitionResource {
+    from_state: string;
+    to_state: string;
+    changed_by_user_id: number;
+    changed_by_name?: string | null;
+    comment?: string | null;
+    created_at: string;
+}
+interface TenancyWithComplianceResource extends TenancyResource {
+    compliances: ComplianceDefinition[];
+    compliance_status: ComplianceStatus;
+}
+
+interface InspectionMedia {
+    uid: string;
+    file_type: string;
+    caption?: string | null;
+    path: string;
+}
+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;
+}
+
+interface MaintenanceAttachmentResource {
+    uid: string;
+    file_type: string;
+    url: string;
+    uploaded_by?: UserType;
+    created_at: string;
+}
+interface MaintenanceUpdateResource {
+    uid: string;
+    note?: string | null;
+    user: UserType;
+    created_at: string;
+}
+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;
+}
+
+interface ConversationResource {
+    id: number;
+    type: string;
+    listing?: ListingRef;
+    created_by?: UserType;
+    last_message_at?: string | null;
+    created_at: string;
+}
+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;
+}
+
+interface NotificationResource {
+    id: string;
+    type: string;
+    title: string;
+    body: string;
+    data?: Record<string, any>;
+    read_at?: string | null;
+    created_at: string;
+}
+
+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;
+}
+interface VerificationFlowResource {
+    order: number;
+    is_required: boolean;
+    layer?: VerificationLayerResource;
+}
+interface VerificationFlowGroupResource {
+    user_type: string;
+    user_type_class: string;
+    layers: VerificationFlowResource[];
+}
+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;
+}
+interface UserVerificationStateResource {
+    current_level: number;
+    completed_layers: string[];
+    pending_layers: string[];
+    last_calculated_at?: string | null;
+}
+
+interface CapabilityResource {
+    key: string;
+    name: string;
+    description?: string | null;
+}
+interface EntitlementResource {
+    key: string;
+    name: string;
+    description?: string | null;
+    value_type: string;
+}
+interface PlanEntitlementResource {
+    key: string;
+    name: string;
+    description?: string | null;
+    value: number | string | boolean | null;
+}
+interface PlanResource {
+    key: string;
+    name: string;
+    user_type: string;
+    is_active: boolean;
+    capabilities?: CapabilityResource[];
+    entitlements?: PlanEntitlementResource[];
+    verification_requirements?: string[];
+}
+
+interface WishlistResource {
+    wishlist_uid: string;
+    listing?: ListingResource;
+}
+
+interface ReviewResource {
+    id: number;
+    rating: number;
+    comment?: string;
+    reviewer: {
+        id: number;
+        name: string;
+    };
+    created_at?: string;
+    updated_at?: string;
+}
+
+export type { ApiErrorResponse, ApiResponse, BaseListingResource, CapabilityResource, ComplianceBreakdown, ComplianceDefinition, ComplianceRequirement, ComplianceStatus, ComplianceSubmissionCompliance, ConversationRef, ConversationResource, EntitlementResource, InspectionMedia, InspectionRef, InspectionResource, ListingComplianceStateResource, ListingComplianceSubmissionResource, ListingRef, ListingResource, ListingWithComplianceResource, MaintenanceAttachmentResource, MaintenanceRequestResource, MaintenanceUpdateResource, MediaPayload, MessageResource, NotificationResource, PaginatedResponse, PlanEntitlementResource, PlanRef, PlanResource, PricePayload, PropertyListingResource, PropertyListingSummary, ReviewResource, TenancyComplianceSubmissionResource, TenancyResource, TenancyTransitionResource, TenancyWithComplianceResource, UsedItemListingResource, UsedItemListingSummary, UserResource, UserSummary, UserType, UserVerificationResource, UserVerificationStateResource, VerificationFlowGroupResource, VerificationFlowResource, VerificationLayerResource, WishlistResource, WorkflowState };

package/dist/index.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;