UNPKG

ws-dottie

Version:

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

544 lines (540 loc) 19.7 kB
export { CVRestriction, CVRestrictionWithId, CommercialVehicleRestrictionsInput, CommercialVehicleRestrictionsWithIdInput, commercialVehicleRestrictionsInputSchema, commercialVehicleRestrictionsWithIdInputSchema, cvRestrictionSchema, cvRestrictionWithIdSchema } from './schemas.mjs'; export { R as RoadwayLocation } from '../../roadwayLocationSchema-ByZokQ0d.mjs'; import * as zod from 'zod'; import { H as HookFactory, F as FetchFactory } from '../../types-D3jt2o5t.mjs'; import '@tanstack/react-query'; /** * Metadata for the fetchCommercialVehicleRestrictions endpoint */ declare const commercialVehicleRestrictionsMeta: { functionName: string; endpoint: string; inputSchema: zod.ZodObject<{}, "strip", zod.ZodTypeAny, {}, {}>; outputSchema: zod.ZodArray<zod.ZodObject<{ BLMaxAxle: zod.ZodNullable<zod.ZodNumber>; BridgeName: zod.ZodNullable<zod.ZodString>; BridgeNumber: zod.ZodNullable<zod.ZodString>; CL8MaxAxle: zod.ZodNullable<zod.ZodNumber>; DateEffective: zod.ZodDate; DateExpires: zod.ZodDate; DatePosted: zod.ZodDate; EndRoadwayLocation: zod.ZodNullable<zod.ZodObject<{ Description: zod.ZodNullable<zod.ZodString>; Direction: zod.ZodNullable<zod.ZodString>; Latitude: zod.ZodNumber; Longitude: zod.ZodNumber; MilePost: zod.ZodNumber; RoadName: zod.ZodNullable<zod.ZodString>; }, "strip", zod.ZodTypeAny, { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; }, { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; }>>; IsDetourAvailable: zod.ZodBoolean; IsExceptionsAllowed: zod.ZodBoolean; IsPermanentRestriction: zod.ZodBoolean; IsWarning: zod.ZodBoolean; Latitude: zod.ZodNumber; LocationDescription: zod.ZodNullable<zod.ZodString>; LocationName: zod.ZodNullable<zod.ZodString>; Longitude: zod.ZodNumber; MaximumGrossVehicleWeightInPounds: zod.ZodNullable<zod.ZodNumber>; RestrictionComment: zod.ZodNullable<zod.ZodString>; RestrictionHeightInInches: zod.ZodNullable<zod.ZodNumber>; RestrictionLengthInInches: zod.ZodNullable<zod.ZodNumber>; RestrictionType: zod.ZodNumber; RestrictionWeightInPounds: zod.ZodNullable<zod.ZodNumber>; RestrictionWidthInInches: zod.ZodNullable<zod.ZodNumber>; SAMaxAxle: zod.ZodNullable<zod.ZodNumber>; StartRoadwayLocation: zod.ZodNullable<zod.ZodObject<{ Description: zod.ZodNullable<zod.ZodString>; Direction: zod.ZodNullable<zod.ZodString>; Latitude: zod.ZodNumber; Longitude: zod.ZodNumber; MilePost: zod.ZodNumber; RoadName: zod.ZodNullable<zod.ZodString>; }, "strip", zod.ZodTypeAny, { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; }, { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; }>>; State: zod.ZodNullable<zod.ZodString>; StateRouteID: zod.ZodNullable<zod.ZodString>; TDMaxAxle: zod.ZodNullable<zod.ZodNumber>; VehicleType: zod.ZodNullable<zod.ZodString>; }, "strip", zod.ZodTypeAny, { Latitude: number; Longitude: number; BridgeNumber: string | null; StateRouteID: string | null; BLMaxAxle: number | null; BridgeName: string | null; CL8MaxAxle: number | null; DateEffective: Date; DateExpires: Date; DatePosted: Date; EndRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; IsDetourAvailable: boolean; IsExceptionsAllowed: boolean; IsPermanentRestriction: boolean; IsWarning: boolean; LocationDescription: string | null; LocationName: string | null; MaximumGrossVehicleWeightInPounds: number | null; RestrictionComment: string | null; RestrictionHeightInInches: number | null; RestrictionLengthInInches: number | null; RestrictionType: number; RestrictionWeightInPounds: number | null; RestrictionWidthInInches: number | null; SAMaxAxle: number | null; StartRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; State: string | null; TDMaxAxle: number | null; VehicleType: string | null; }, { Latitude: number; Longitude: number; BridgeNumber: string | null; StateRouteID: string | null; BLMaxAxle: number | null; BridgeName: string | null; CL8MaxAxle: number | null; DateEffective: Date; DateExpires: Date; DatePosted: Date; EndRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; IsDetourAvailable: boolean; IsExceptionsAllowed: boolean; IsPermanentRestriction: boolean; IsWarning: boolean; LocationDescription: string | null; LocationName: string | null; MaximumGrossVehicleWeightInPounds: number | null; RestrictionComment: string | null; RestrictionHeightInInches: number | null; RestrictionLengthInInches: number | null; RestrictionType: number; RestrictionWeightInPounds: number | null; RestrictionWidthInInches: number | null; SAMaxAxle: number | null; StartRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; State: string | null; TDMaxAxle: number | null; VehicleType: string | null; }>, "many">; sampleParams: {}; endpointDescription: string; }; /** * Fetch function and React Query hook for retrieving commercial vehicle restrictions for all Washington State highways */ declare const fetchCommercialVehicleRestrictions: FetchFactory<{}, { Latitude: number; Longitude: number; BridgeNumber: string | null; StateRouteID: string | null; BLMaxAxle: number | null; BridgeName: string | null; CL8MaxAxle: number | null; DateEffective: Date; DateExpires: Date; DatePosted: Date; EndRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; IsDetourAvailable: boolean; IsExceptionsAllowed: boolean; IsPermanentRestriction: boolean; IsWarning: boolean; LocationDescription: string | null; LocationName: string | null; MaximumGrossVehicleWeightInPounds: number | null; RestrictionComment: string | null; RestrictionHeightInInches: number | null; RestrictionLengthInInches: number | null; RestrictionType: number; RestrictionWeightInPounds: number | null; RestrictionWidthInInches: number | null; SAMaxAxle: number | null; StartRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; State: string | null; TDMaxAxle: number | null; VehicleType: string | null; }[]>; declare const useCommercialVehicleRestrictions: HookFactory<{}, { Latitude: number; Longitude: number; BridgeNumber: string | null; StateRouteID: string | null; BLMaxAxle: number | null; BridgeName: string | null; CL8MaxAxle: number | null; DateEffective: Date; DateExpires: Date; DatePosted: Date; EndRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; IsDetourAvailable: boolean; IsExceptionsAllowed: boolean; IsPermanentRestriction: boolean; IsWarning: boolean; LocationDescription: string | null; LocationName: string | null; MaximumGrossVehicleWeightInPounds: number | null; RestrictionComment: string | null; RestrictionHeightInInches: number | null; RestrictionLengthInInches: number | null; RestrictionType: number; RestrictionWeightInPounds: number | null; RestrictionWidthInInches: number | null; SAMaxAxle: number | null; StartRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; State: string | null; TDMaxAxle: number | null; VehicleType: string | null; }[]>; /** * Metadata for the fetchCommercialVehicleRestrictionsWithId endpoint */ declare const commercialVehicleRestrictionsWithIdMeta: { functionName: string; endpoint: string; inputSchema: zod.ZodObject<{}, "strip", zod.ZodTypeAny, {}, {}>; outputSchema: zod.ZodArray<zod.ZodObject<{ BLMaxAxle: zod.ZodNullable<zod.ZodNumber>; BridgeName: zod.ZodNullable<zod.ZodString>; BridgeNumber: zod.ZodNullable<zod.ZodString>; CL8MaxAxle: zod.ZodNullable<zod.ZodNumber>; DateEffective: zod.ZodDate; DateExpires: zod.ZodDate; DatePosted: zod.ZodDate; EndRoadwayLocation: zod.ZodNullable<zod.ZodObject<{ Description: zod.ZodNullable<zod.ZodString>; Direction: zod.ZodNullable<zod.ZodString>; Latitude: zod.ZodNumber; Longitude: zod.ZodNumber; MilePost: zod.ZodNumber; RoadName: zod.ZodNullable<zod.ZodString>; }, "strip", zod.ZodTypeAny, { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; }, { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; }>>; IsDetourAvailable: zod.ZodBoolean; IsExceptionsAllowed: zod.ZodBoolean; IsPermanentRestriction: zod.ZodBoolean; IsWarning: zod.ZodBoolean; Latitude: zod.ZodNumber; LocationDescription: zod.ZodNullable<zod.ZodString>; LocationName: zod.ZodNullable<zod.ZodString>; Longitude: zod.ZodNumber; MaximumGrossVehicleWeightInPounds: zod.ZodNullable<zod.ZodNumber>; RestrictionComment: zod.ZodNullable<zod.ZodString>; RestrictionHeightInInches: zod.ZodNullable<zod.ZodNumber>; RestrictionLengthInInches: zod.ZodNullable<zod.ZodNumber>; RestrictionType: zod.ZodNumber; RestrictionWeightInPounds: zod.ZodNullable<zod.ZodNumber>; RestrictionWidthInInches: zod.ZodNullable<zod.ZodNumber>; SAMaxAxle: zod.ZodNullable<zod.ZodNumber>; StartRoadwayLocation: zod.ZodNullable<zod.ZodObject<{ Description: zod.ZodNullable<zod.ZodString>; Direction: zod.ZodNullable<zod.ZodString>; Latitude: zod.ZodNumber; Longitude: zod.ZodNumber; MilePost: zod.ZodNumber; RoadName: zod.ZodNullable<zod.ZodString>; }, "strip", zod.ZodTypeAny, { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; }, { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; }>>; State: zod.ZodNullable<zod.ZodString>; StateRouteID: zod.ZodNullable<zod.ZodString>; TDMaxAxle: zod.ZodNullable<zod.ZodNumber>; VehicleType: zod.ZodNullable<zod.ZodString>; } & { UniqueID: zod.ZodNullable<zod.ZodString>; }, "strip", zod.ZodTypeAny, { Latitude: number; Longitude: number; BridgeNumber: string | null; StateRouteID: string | null; BLMaxAxle: number | null; BridgeName: string | null; CL8MaxAxle: number | null; DateEffective: Date; DateExpires: Date; DatePosted: Date; EndRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; IsDetourAvailable: boolean; IsExceptionsAllowed: boolean; IsPermanentRestriction: boolean; IsWarning: boolean; LocationDescription: string | null; LocationName: string | null; MaximumGrossVehicleWeightInPounds: number | null; RestrictionComment: string | null; RestrictionHeightInInches: number | null; RestrictionLengthInInches: number | null; RestrictionType: number; RestrictionWeightInPounds: number | null; RestrictionWidthInInches: number | null; SAMaxAxle: number | null; StartRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; State: string | null; TDMaxAxle: number | null; VehicleType: string | null; UniqueID: string | null; }, { Latitude: number; Longitude: number; BridgeNumber: string | null; StateRouteID: string | null; BLMaxAxle: number | null; BridgeName: string | null; CL8MaxAxle: number | null; DateEffective: Date; DateExpires: Date; DatePosted: Date; EndRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; IsDetourAvailable: boolean; IsExceptionsAllowed: boolean; IsPermanentRestriction: boolean; IsWarning: boolean; LocationDescription: string | null; LocationName: string | null; MaximumGrossVehicleWeightInPounds: number | null; RestrictionComment: string | null; RestrictionHeightInInches: number | null; RestrictionLengthInInches: number | null; RestrictionType: number; RestrictionWeightInPounds: number | null; RestrictionWidthInInches: number | null; SAMaxAxle: number | null; StartRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; State: string | null; TDMaxAxle: number | null; VehicleType: string | null; UniqueID: string | null; }>, "many">; sampleParams: {}; endpointDescription: string; }; /** * Fetch function and React Query hook for retrieving commercial vehicle restrictions with unique identifiers for all Washington State highways */ declare const fetchCommercialVehicleRestrictionsWithId: FetchFactory<{}, { Latitude: number; Longitude: number; BridgeNumber: string | null; StateRouteID: string | null; BLMaxAxle: number | null; BridgeName: string | null; CL8MaxAxle: number | null; DateEffective: Date; DateExpires: Date; DatePosted: Date; EndRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; IsDetourAvailable: boolean; IsExceptionsAllowed: boolean; IsPermanentRestriction: boolean; IsWarning: boolean; LocationDescription: string | null; LocationName: string | null; MaximumGrossVehicleWeightInPounds: number | null; RestrictionComment: string | null; RestrictionHeightInInches: number | null; RestrictionLengthInInches: number | null; RestrictionType: number; RestrictionWeightInPounds: number | null; RestrictionWidthInInches: number | null; SAMaxAxle: number | null; StartRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; State: string | null; TDMaxAxle: number | null; VehicleType: string | null; UniqueID: string | null; }[]>; declare const useCommercialVehicleRestrictionsWithId: HookFactory<{}, { Latitude: number; Longitude: number; BridgeNumber: string | null; StateRouteID: string | null; BLMaxAxle: number | null; BridgeName: string | null; CL8MaxAxle: number | null; DateEffective: Date; DateExpires: Date; DatePosted: Date; EndRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; IsDetourAvailable: boolean; IsExceptionsAllowed: boolean; IsPermanentRestriction: boolean; IsWarning: boolean; LocationDescription: string | null; LocationName: string | null; MaximumGrossVehicleWeightInPounds: number | null; RestrictionComment: string | null; RestrictionHeightInInches: number | null; RestrictionLengthInInches: number | null; RestrictionType: number; RestrictionWeightInPounds: number | null; RestrictionWidthInInches: number | null; SAMaxAxle: number | null; StartRoadwayLocation: { Description: string | null; Direction: string | null; Latitude: number; Longitude: number; MilePost: number; RoadName: string | null; } | null; State: string | null; TDMaxAxle: number | null; VehicleType: string | null; UniqueID: string | null; }[]>; export { commercialVehicleRestrictionsMeta, commercialVehicleRestrictionsWithIdMeta, fetchCommercialVehicleRestrictions, fetchCommercialVehicleRestrictionsWithId, useCommercialVehicleRestrictions, useCommercialVehicleRestrictionsWithId };