ws-dottie/dist/apis/wsdot-bridge-clearances/core.d.ts

Your friendly TypeScript companion for Washington State transportation APIs - WSDOT and WSF data with smart caching and React Query integration

export { BridgeClearance, BridgeClearancesByRouteInput, BridgeClearancesInput, bridgeClearanceSchema, bridgeClearancesByRouteInputSchema, bridgeClearancesInputSchema } from './schemas.js';
import * as zod from 'zod';
import { H as HookFactory, F as FetchFactory } from '../../types-D3jt2o5t.js';
import '@tanstack/react-query';

/**
 * Metadata for the fetchBridgeClearances endpoint
 */
declare const bridgeClearancesMeta: {
    functionName: string;
    endpoint: string;
    inputSchema: zod.ZodObject<{}, "strip", zod.ZodTypeAny, {}, {}>;
    outputSchema: zod.ZodArray<zod.ZodObject<{
        APILastUpdate: zod.ZodDate;
        BridgeNumber: zod.ZodNullable<zod.ZodString>;
        ControlEntityGuid: zod.ZodString;
        CrossingDescription: zod.ZodNullable<zod.ZodString>;
        CrossingLocationId: zod.ZodNumber;
        CrossingRecordGuid: zod.ZodString;
        InventoryDirection: zod.ZodNullable<zod.ZodString>;
        Latitude: zod.ZodNumber;
        LocationGuid: zod.ZodString;
        Longitude: zod.ZodNumber;
        RouteDate: zod.ZodDate;
        SRMP: zod.ZodNumber;
        SRMPAheadBackIndicator: zod.ZodNullable<zod.ZodString>;
        StateRouteID: zod.ZodNullable<zod.ZodString>;
        StateStructureId: zod.ZodNullable<zod.ZodString>;
        VerticalClearanceMaximumFeetInch: zod.ZodNullable<zod.ZodString>;
        VerticalClearanceMaximumInches: zod.ZodNumber;
        VerticalClearanceMinimumFeetInch: zod.ZodNullable<zod.ZodString>;
        VerticalClearanceMinimumInches: zod.ZodNumber;
    }, "strip", zod.ZodTypeAny, {
        Latitude: number;
        Longitude: number;
        APILastUpdate: Date;
        BridgeNumber: string | null;
        ControlEntityGuid: string;
        CrossingDescription: string | null;
        CrossingLocationId: number;
        CrossingRecordGuid: string;
        InventoryDirection: string | null;
        LocationGuid: string;
        RouteDate: Date;
        SRMP: number;
        SRMPAheadBackIndicator: string | null;
        StateRouteID: string | null;
        StateStructureId: string | null;
        VerticalClearanceMaximumFeetInch: string | null;
        VerticalClearanceMaximumInches: number;
        VerticalClearanceMinimumFeetInch: string | null;
        VerticalClearanceMinimumInches: number;
    }, {
        Latitude: number;
        Longitude: number;
        APILastUpdate: Date;
        BridgeNumber: string | null;
        ControlEntityGuid: string;
        CrossingDescription: string | null;
        CrossingLocationId: number;
        CrossingRecordGuid: string;
        InventoryDirection: string | null;
        LocationGuid: string;
        RouteDate: Date;
        SRMP: number;
        SRMPAheadBackIndicator: string | null;
        StateRouteID: string | null;
        StateStructureId: string | null;
        VerticalClearanceMaximumFeetInch: string | null;
        VerticalClearanceMaximumInches: number;
        VerticalClearanceMinimumFeetInch: string | null;
        VerticalClearanceMinimumInches: number;
    }>, "many">;
    sampleParams: {};
    endpointDescription: string;
};
/**
 * Fetch function and React Query hook for retrieving vertical clearance data for all Washington State bridges
 */
declare const fetchBridgeClearances: FetchFactory<{}, {
    Latitude: number;
    Longitude: number;
    APILastUpdate: Date;
    BridgeNumber: string | null;
    ControlEntityGuid: string;
    CrossingDescription: string | null;
    CrossingLocationId: number;
    CrossingRecordGuid: string;
    InventoryDirection: string | null;
    LocationGuid: string;
    RouteDate: Date;
    SRMP: number;
    SRMPAheadBackIndicator: string | null;
    StateRouteID: string | null;
    StateStructureId: string | null;
    VerticalClearanceMaximumFeetInch: string | null;
    VerticalClearanceMaximumInches: number;
    VerticalClearanceMinimumFeetInch: string | null;
    VerticalClearanceMinimumInches: number;
}[]>;
declare const useBridgeClearances: HookFactory<{}, {
    Latitude: number;
    Longitude: number;
    APILastUpdate: Date;
    BridgeNumber: string | null;
    ControlEntityGuid: string;
    CrossingDescription: string | null;
    CrossingLocationId: number;
    CrossingRecordGuid: string;
    InventoryDirection: string | null;
    LocationGuid: string;
    RouteDate: Date;
    SRMP: number;
    SRMPAheadBackIndicator: string | null;
    StateRouteID: string | null;
    StateStructureId: string | null;
    VerticalClearanceMaximumFeetInch: string | null;
    VerticalClearanceMaximumInches: number;
    VerticalClearanceMinimumFeetInch: string | null;
    VerticalClearanceMinimumInches: number;
}[]>;

/**
 * Metadata for the fetchBridgeClearancesByRoute endpoint
 */
declare const bridgeClearancesByRouteMeta: {
    functionName: string;
    endpoint: string;
    inputSchema: zod.ZodObject<{
        Route: zod.ZodString;
    }, "strip", zod.ZodTypeAny, {
        Route: string;
    }, {
        Route: string;
    }>;
    outputSchema: zod.ZodArray<zod.ZodObject<{
        APILastUpdate: zod.ZodDate;
        BridgeNumber: zod.ZodNullable<zod.ZodString>;
        ControlEntityGuid: zod.ZodString;
        CrossingDescription: zod.ZodNullable<zod.ZodString>;
        CrossingLocationId: zod.ZodNumber;
        CrossingRecordGuid: zod.ZodString;
        InventoryDirection: zod.ZodNullable<zod.ZodString>;
        Latitude: zod.ZodNumber;
        LocationGuid: zod.ZodString;
        Longitude: zod.ZodNumber;
        RouteDate: zod.ZodDate;
        SRMP: zod.ZodNumber;
        SRMPAheadBackIndicator: zod.ZodNullable<zod.ZodString>;
        StateRouteID: zod.ZodNullable<zod.ZodString>;
        StateStructureId: zod.ZodNullable<zod.ZodString>;
        VerticalClearanceMaximumFeetInch: zod.ZodNullable<zod.ZodString>;
        VerticalClearanceMaximumInches: zod.ZodNumber;
        VerticalClearanceMinimumFeetInch: zod.ZodNullable<zod.ZodString>;
        VerticalClearanceMinimumInches: zod.ZodNumber;
    }, "strip", zod.ZodTypeAny, {
        Latitude: number;
        Longitude: number;
        APILastUpdate: Date;
        BridgeNumber: string | null;
        ControlEntityGuid: string;
        CrossingDescription: string | null;
        CrossingLocationId: number;
        CrossingRecordGuid: string;
        InventoryDirection: string | null;
        LocationGuid: string;
        RouteDate: Date;
        SRMP: number;
        SRMPAheadBackIndicator: string | null;
        StateRouteID: string | null;
        StateStructureId: string | null;
        VerticalClearanceMaximumFeetInch: string | null;
        VerticalClearanceMaximumInches: number;
        VerticalClearanceMinimumFeetInch: string | null;
        VerticalClearanceMinimumInches: number;
    }, {
        Latitude: number;
        Longitude: number;
        APILastUpdate: Date;
        BridgeNumber: string | null;
        ControlEntityGuid: string;
        CrossingDescription: string | null;
        CrossingLocationId: number;
        CrossingRecordGuid: string;
        InventoryDirection: string | null;
        LocationGuid: string;
        RouteDate: Date;
        SRMP: number;
        SRMPAheadBackIndicator: string | null;
        StateRouteID: string | null;
        StateStructureId: string | null;
        VerticalClearanceMaximumFeetInch: string | null;
        VerticalClearanceMaximumInches: number;
        VerticalClearanceMinimumFeetInch: string | null;
        VerticalClearanceMinimumInches: number;
    }>, "many">;
    sampleParams: {
        Route: string;
    };
    endpointDescription: string;
};
/**
 * Fetch function and React Query hook for retrieving vertical clearance data for bridges on a specific state route
 */
declare const fetchBridgeClearancesByRoute: FetchFactory<{
    Route: string;
}, {
    Latitude: number;
    Longitude: number;
    APILastUpdate: Date;
    BridgeNumber: string | null;
    ControlEntityGuid: string;
    CrossingDescription: string | null;
    CrossingLocationId: number;
    CrossingRecordGuid: string;
    InventoryDirection: string | null;
    LocationGuid: string;
    RouteDate: Date;
    SRMP: number;
    SRMPAheadBackIndicator: string | null;
    StateRouteID: string | null;
    StateStructureId: string | null;
    VerticalClearanceMaximumFeetInch: string | null;
    VerticalClearanceMaximumInches: number;
    VerticalClearanceMinimumFeetInch: string | null;
    VerticalClearanceMinimumInches: number;
}[]>;
declare const useBridgeClearancesByRoute: HookFactory<{
    Route: string;
}, {
    Latitude: number;
    Longitude: number;
    APILastUpdate: Date;
    BridgeNumber: string | null;
    ControlEntityGuid: string;
    CrossingDescription: string | null;
    CrossingLocationId: number;
    CrossingRecordGuid: string;
    InventoryDirection: string | null;
    LocationGuid: string;
    RouteDate: Date;
    SRMP: number;
    SRMPAheadBackIndicator: string | null;
    StateRouteID: string | null;
    StateStructureId: string | null;
    VerticalClearanceMaximumFeetInch: string | null;
    VerticalClearanceMaximumInches: number;
    VerticalClearanceMinimumFeetInch: string | null;
    VerticalClearanceMinimumInches: number;
}[]>;

export { bridgeClearancesByRouteMeta, bridgeClearancesMeta, fetchBridgeClearances, fetchBridgeClearancesByRoute, useBridgeClearances, useBridgeClearancesByRoute };