ws-dottie/dist/shared/types.d.ts

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

/**
 * @fileoverview Simplified Shared Types for WS-Dottie
 *
 * Consolidated type definitions without over-engineering.
 */
import type { z } from "zod";
import type { ApiMeta, EndpointGroupMeta } from "../apis/types";
/**
 * Cache strategies for different data update frequencies
 *
 * These strategies define how frequently data should be refreshed based on
 * nature of transportation data. Each strategy includes appropriate
 * stale time, garbage collection time, and refetch intervals.
 */
export type CacheStrategy = "REALTIME" | "FREQUENT" | "MODERATE" | "STATIC";
/**
 * Runtime endpoint interface with computed properties
 *
 * This interface defines the structure for runtime endpoint objects that are
 * created from endpoint configurations. It includes all necessary information
 * for validation, caching, and URL generation.
 */
export interface Endpoint<I, O> {
    /** API configuration */
    api: ApiMeta;
    /** Endpoint group metadata */
    group: EndpointGroupMeta;
    /** Complete HTTP endpoint URL template */
    endpoint: string;
    /** Zod schema for input validation (optional - excluded in lite builds) */
    inputSchema?: z.ZodSchema<I>;
    /** Zod schema for output validation (optional - excluded in lite builds) */
    outputSchema?: z.ZodSchema<O>;
    /** Optional sample parameters for testing */
    sampleParams?: Partial<I> | (() => Promise<Partial<I>>);
    /** Cache strategy */
    cacheStrategy: CacheStrategy;
    /** Function name */
    functionName: string;
    /** Complete URL template with domain */
    urlTemplate: string;
    /** Computed unique identifier in format "api:function" for backward compatibility */
    id: string;
    /** One-sentence description of what this specific endpoint does */
    endpointDescription?: string;
}
/**
 * Logging verbosity levels for WS-Dottie
 *
 * Controls the amount of logging output during API operations.
 * - none: No logging output
 * - info: Basic information about API calls and results
 * - debug: Detailed logging including performance metrics
 */
export type LoggingMode = "none" | "info" | "debug";
/**
 * Function type for fetching data from URLs
 *
 * This type defines the interface for fetch handlers that can retrieve
 * data from URLs and return it as a string. Used by both JSONP and native
 * fetch implementations.
 */
export type FetchHandler = (url: string) => Promise<string>;
/**
 * Fetch strategy for data fetching
 *
 * Defines the underlying transport mechanism used to fetch data.
 * - native: Uses standard fetch API (works in Node.js and modern browsers)
 * - jsonp: Uses JSONP callbacks (browser-only, bypasses CORS)
 */
export type FetchStrategy = "native" | "jsonp";
//# sourceMappingURL=types.d.ts.map