rocket-launch-live-client 1.0.3 → 2.0.0

package/lib/{cjs/types/types → types}/application.d.ts

@@ -1,13 +1,14 @@
 import { ISO3166Alpha2 } from "./standards.js";
-export declare enum RLLEndPoint {
-    COMPANIES = "companies",
-    LAUNCHES = "launches",
-    LOCATIONS = "locations",
-    MISSIONS = "missions",
-    PADS = "pads",
-    TAGS = "tags",
-    VEHICLES = "vehicles"
-}
+export declare const RLLEndPoint: {
+    readonly COMPANIES: "companies";
+    readonly LAUNCHES: "launches";
+    readonly LOCATIONS: "locations";
+    readonly MISSIONS: "missions";
+    readonly PADS: "pads";
+    readonly TAGS: "tags";
+    readonly VEHICLES: "vehicles";
+};
+export type RLLEndPoint = (typeof RLLEndPoint)[keyof typeof RLLEndPoint];
 export declare namespace RLLEntity {
     interface RLLRecord {
         id: number;
@@ -22,22 +23,28 @@ export declare namespace RLLEntity {
     }
     export interface Company extends RLLRecord {
         name: string;
+        slug: string;
         country: Country;
         inactive: boolean;
     }
-    export enum LaunchResult {
-        NOT_SET = -1,
-        FAILURE = 0,
-        SUCCESS = 1,
-        PARTIAL_FAILURE = 2,
-        IN_FLIGHT_ABORT_CREWED = 3
-    }
+    export const LaunchResult: {
+        readonly NOT_SET: -1;
+        readonly FAILURE: 0;
+        readonly SUCCESS: 1;
+        readonly PARTIAL_FAILURE: 2;
+        readonly IN_FLIGHT_ABORT_CREWED: 3;
+    };
+    export type LaunchResult = (typeof LaunchResult)[keyof typeof LaunchResult];
     export interface Media extends RLLRecord {
         media_url: string | null;
         youtube_vidid: string | null;
+        x_postid: string | null;
+        x_accountid: string | null;
+        bilibili_roomid: string | null;
         featured: boolean;
         ldfeatured: boolean;
         approved: boolean;
+        live_status: boolean | null;
     }
     export interface Launch extends RLLRecord {
         name: string;
@@ -45,7 +52,7 @@ export declare namespace RLLEntity {
         sort_date: string;
         provider: {
             slug: string;
-        } & Omit<Company, "inactive" | "country">;
+        } & Omit<Company, "slug" | "inactive" | "country">;
         vehicle: {
             company_id: number;
             slug: string;
@@ -74,32 +81,32 @@ export declare namespace RLLEntity {
         slug: string;
         weather_summary: string | null;
         weather_condition: string | null;
-        weather_wind_mph: number | null;
-        weather_temp: number | null;
+        weather_wind_mph: string | null;
+        weather_temp: string | null;
         weather_icon: string | null;
         weather_updated: string | null;
         quicktext: string;
-        media?: Media[];
+        media: Media[];
         result: LaunchResult | null;
         suborbital: boolean;
         modified: string;
     }
     export interface Location extends RLLRecord {
         name: string;
-        latitute: string;
-        latitude: string;
-        longitude: string;
+        latitute: string | null;
+        latitude: string | null;
+        longitude: string | null;
         state: State | null;
         statename?: string | null;
         country: Country | null;
         pads: Omit<Pad, "full_name" | "location" | "country" | "state">[];
-        utc_offset: number | null;
+        utc_offset: string | null;
     }
     export interface Mission extends RLLRecord {
         name: string;
         description: string | null;
-        launch_id: number;
-        company: Omit<Company, "inactive" | "country">;
+        launch_id: number | null;
+        company: Omit<Company, "slug" | "inactive" | "country">;
     }
     export interface Pad extends RLLRecord {
         name: string;
@@ -112,7 +119,7 @@ export declare namespace RLLEntity {
     }
     export interface Vehicle extends RLLRecord {
         name: string;
-        company: Omit<Company, "inactive" | "country">;
+        company: Omit<Company, "slug" | "inactive" | "country">;
     }
     export {};
 }
@@ -188,6 +195,13 @@ export declare namespace RLLQueryConfig {
 }
 export type RLLClientOptions = {
     keyInQueryParams?: boolean;
+    /** HTTP request timeout in milliseconds (default 30000). Must be greater than 0. */
+    timeoutMs?: number;
+    /**
+     * Max decompressed response body size in bytes (default 10 MiB).
+     * Protects against oversized or gzip-bomb responses. Must be greater than 0.
+     */
+    maxResponseBytes?: number;
 };
 export type RLLResponse<T> = {
     errors?: string[];

package/lib/types/application.js

@@ -0,0 +1,41 @@
+export const RLLEndPoint = {
+    COMPANIES: "companies",
+    LAUNCHES: "launches",
+    LOCATIONS: "locations",
+    MISSIONS: "missions",
+    PADS: "pads",
+    TAGS: "tags",
+    VEHICLES: "vehicles",
+};
+export var RLLEntity;
+(function (RLLEntity) {
+    RLLEntity.LaunchResult = {
+        NOT_SET: -1,
+        FAILURE: 0,
+        SUCCESS: 1,
+        PARTIAL_FAILURE: 2,
+        IN_FLIGHT_ABORT_CREWED: 3,
+    };
+})(RLLEntity || (RLLEntity = {}));
+export const RLLQueryParams = {
+    id: true,
+    page: true,
+    name: true,
+    country_code: true,
+    inactive: true,
+    cospar_id: true,
+    after_date: true,
+    before_date: true,
+    modified_since: true,
+    location_id: true,
+    pad_id: true,
+    provider_id: true,
+    tag_id: true,
+    vehicle_id: true,
+    state_abbr: true,
+    search: true,
+    slug: true,
+    text: true,
+    limit: true,
+    direction: true,
+};

package/lib/types/standards.d.ts

@@ -0,0 +1,8 @@
+export declare const countryCodes: readonly ["AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "CV", "KH", "CM", "CA", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CD", "CG", "CK", "CR", "HR", "CU", "CW", "CY", "CZ", "CI", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "SZ", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "MK", "RO", "RU", "RW", "RE", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "UM", "US", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW", "AX"];
+export declare const usStateCodes: readonly ["AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY", "DC", "AS", "GU", "MP", "PR", "UM", "VI"];
+export declare const isValidCountryCode: (code: string) => code is (typeof countryCodes)[number];
+export declare const isValidStateCode: (code: string) => code is (typeof usStateCodes)[number];
+export declare namespace ISO3166Alpha2 {
+    type CountryCode = (typeof countryCodes)[number];
+    type StateCodeUS = (typeof usStateCodes)[number];
+}

package/lib/types/standards.js

@@ -0,0 +1,314 @@
+export const countryCodes = [
+    "AF",
+    "AL",
+    "DZ",
+    "AS",
+    "AD",
+    "AO",
+    "AI",
+    "AQ",
+    "AG",
+    "AR",
+    "AM",
+    "AW",
+    "AU",
+    "AT",
+    "AZ",
+    "BS",
+    "BH",
+    "BD",
+    "BB",
+    "BY",
+    "BE",
+    "BZ",
+    "BJ",
+    "BM",
+    "BT",
+    "BO",
+    "BQ",
+    "BA",
+    "BW",
+    "BV",
+    "BR",
+    "IO",
+    "BN",
+    "BG",
+    "BF",
+    "BI",
+    "CV",
+    "KH",
+    "CM",
+    "CA",
+    "KY",
+    "CF",
+    "TD",
+    "CL",
+    "CN",
+    "CX",
+    "CC",
+    "CO",
+    "KM",
+    "CD",
+    "CG",
+    "CK",
+    "CR",
+    "HR",
+    "CU",
+    "CW",
+    "CY",
+    "CZ",
+    "CI",
+    "DK",
+    "DJ",
+    "DM",
+    "DO",
+    "EC",
+    "EG",
+    "SV",
+    "GQ",
+    "ER",
+    "EE",
+    "SZ",
+    "ET",
+    "FK",
+    "FO",
+    "FJ",
+    "FI",
+    "FR",
+    "GF",
+    "PF",
+    "TF",
+    "GA",
+    "GM",
+    "GE",
+    "DE",
+    "GH",
+    "GI",
+    "GR",
+    "GL",
+    "GD",
+    "GP",
+    "GU",
+    "GT",
+    "GG",
+    "GN",
+    "GW",
+    "GY",
+    "HT",
+    "HM",
+    "VA",
+    "HN",
+    "HK",
+    "HU",
+    "IS",
+    "IN",
+    "ID",
+    "IR",
+    "IQ",
+    "IE",
+    "IM",
+    "IL",
+    "IT",
+    "JM",
+    "JP",
+    "JE",
+    "JO",
+    "KZ",
+    "KE",
+    "KI",
+    "KP",
+    "KR",
+    "KW",
+    "KG",
+    "LA",
+    "LV",
+    "LB",
+    "LS",
+    "LR",
+    "LY",
+    "LI",
+    "LT",
+    "LU",
+    "MO",
+    "MG",
+    "MW",
+    "MY",
+    "MV",
+    "ML",
+    "MT",
+    "MH",
+    "MQ",
+    "MR",
+    "MU",
+    "YT",
+    "MX",
+    "FM",
+    "MD",
+    "MC",
+    "MN",
+    "ME",
+    "MS",
+    "MA",
+    "MZ",
+    "MM",
+    "NA",
+    "NR",
+    "NP",
+    "NL",
+    "NC",
+    "NZ",
+    "NI",
+    "NE",
+    "NG",
+    "NU",
+    "NF",
+    "MP",
+    "NO",
+    "OM",
+    "PK",
+    "PW",
+    "PS",
+    "PA",
+    "PG",
+    "PY",
+    "PE",
+    "PH",
+    "PN",
+    "PL",
+    "PT",
+    "PR",
+    "QA",
+    "MK",
+    "RO",
+    "RU",
+    "RW",
+    "RE",
+    "BL",
+    "SH",
+    "KN",
+    "LC",
+    "MF",
+    "PM",
+    "VC",
+    "WS",
+    "SM",
+    "ST",
+    "SA",
+    "SN",
+    "RS",
+    "SC",
+    "SL",
+    "SG",
+    "SX",
+    "SK",
+    "SI",
+    "SB",
+    "SO",
+    "ZA",
+    "GS",
+    "SS",
+    "ES",
+    "LK",
+    "SD",
+    "SR",
+    "SJ",
+    "SE",
+    "CH",
+    "SY",
+    "TW",
+    "TJ",
+    "TZ",
+    "TH",
+    "TL",
+    "TG",
+    "TK",
+    "TO",
+    "TT",
+    "TN",
+    "TR",
+    "TM",
+    "TC",
+    "TV",
+    "UG",
+    "UA",
+    "AE",
+    "GB",
+    "UM",
+    "US",
+    "UY",
+    "UZ",
+    "VU",
+    "VE",
+    "VN",
+    "VG",
+    "VI",
+    "WF",
+    "EH",
+    "YE",
+    "ZM",
+    "ZW",
+    "AX",
+];
+export const usStateCodes = [
+    "AL",
+    "AK",
+    "AZ",
+    "AR",
+    "CA",
+    "CO",
+    "CT",
+    "DE",
+    "FL",
+    "GA",
+    "HI",
+    "ID",
+    "IL",
+    "IN",
+    "IA",
+    "KS",
+    "KY",
+    "LA",
+    "ME",
+    "MD",
+    "MA",
+    "MI",
+    "MN",
+    "MS",
+    "MO",
+    "MT",
+    "NE",
+    "NV",
+    "NH",
+    "NJ",
+    "NM",
+    "NY",
+    "NC",
+    "ND",
+    "OH",
+    "OK",
+    "OR",
+    "PA",
+    "RI",
+    "SC",
+    "SD",
+    "TN",
+    "TX",
+    "UT",
+    "VT",
+    "VA",
+    "WA",
+    "WV",
+    "WI",
+    "WY",
+    "DC",
+    "AS",
+    "GU",
+    "MP",
+    "PR",
+    "UM",
+    "VI",
+];
+const countryCodeSet = new Set(countryCodes);
+const usStateCodeSet = new Set(usStateCodes);
+export const isValidCountryCode = (code) => countryCodeSet.has(code);
+export const isValidStateCode = (code) => usStateCodeSet.has(code);

package/lib/{cjs/types/utils.d.ts → utils.d.ts}

@@ -1,11 +1,8 @@
-/// <reference types="node" />
 import { RLLEndPoint, RLLQueryConfig } from "./types/application.js";
 export declare const formatToRLLISODate: (date: Date) => string;
 export declare const apiKeyValidator: (apiKey: any) => string;
 export declare const optionsValidator: (options: {
-    [key: string]: any;
-    [key: number]: any;
-    [key: symbol]: any;
+    [key: string | number | symbol]: any;
 }) => void;
 export declare const queryOptionsValidator: (resource: RLLEndPoint, options?: RLLQueryConfig.Companies | RLLQueryConfig.Launches | RLLQueryConfig.Locations | RLLQueryConfig.Missions | RLLQueryConfig.Pads | RLLQueryConfig.Tags | RLLQueryConfig.Vehicles) => URLSearchParams;
 export declare const warn: (msg: string) => void;

package/lib/{esm/utils.js → utils.js}

@@ -25,14 +25,28 @@ export const apiKeyValidator = (apiKey) => {
 };
 export const optionsValidator = (options) => {
     for (const option in options) {
-        if (option !== "keyInQueryParams") {
-            warn(`RLL Client options do not accept a "${option}" property. This property will be ignored.`);
-        }
-        else {
+        if (option === "keyInQueryParams") {
             if (typeof options[option] !== "boolean") {
                 error("RLL Client configuration option 'keyInQueryParams' must be a boolean.", "type");
             }
         }
+        else if (option === "timeoutMs") {
+            if (typeof options[option] !== "number" ||
+                !Number.isFinite(options[option]) ||
+                options[option] <= 0) {
+                error("RLL Client configuration option 'timeoutMs' must be a number greater than 0.", "type");
+            }
+        }
+        else if (option === "maxResponseBytes") {
+            if (typeof options[option] !== "number" ||
+                !Number.isFinite(options[option]) ||
+                options[option] <= 0) {
+                error("RLL Client configuration option 'maxResponseBytes' must be a number greater than 0.", "type");
+            }
+        }
+        else {
+            warn(`RLL Client options do not accept a "${option}" property. This property will be ignored.`);
+        }
     }
 };
 const validators = {

package/lib/{cjs/types → watcher}/Watcher.d.ts

@@ -1,7 +1,5 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { EventEmitter } from "events";
-import { RLLEntity, RLLQueryConfig, RLLResponse } from "./types/application.js";
+import { EventEmitter } from "node:events";
+import { RLLEntity, RLLQueryConfig, RLLResponse } from "../types/application.js";
 /**
  * Class representing a RocketLaunch.Live Client Watcher
  * @class
@@ -14,6 +12,8 @@ export declare class RLLWatcher extends EventEmitter {
     private interval;
     private params;
     private timer;
+    private running;
+    private queryInFlight;
     private fetcher;
     /**
      * Create a new RocketLaunch.live Client Watcher
@@ -22,7 +22,8 @@ export declare class RLLWatcher extends EventEmitter {
      * @param {number | string} [interval] - Optional Client Configuration options
      * @param {Object} [options] - Launch Search Options
      * @param {number | string} options.id - Launch id
-     * @param {number | string} options.page - Page number of results
+     * @param {number | string} options.page - Ignored; Watcher always starts at page 1
+     * @param {number | string} options.limit - Ignored; Watcher uses the API default page size
      * @param {string} options.cospar_id - Launch COSPAR ID (ie. 2022-123)
      * @param {Date | string} options.before_date - Only return launches before this date
      * @param {Date | string} options.after_date - Only return launches after this date
@@ -40,17 +41,19 @@ export declare class RLLWatcher extends EventEmitter {
      */
     constructor(fetcher: (params: URLSearchParams) => Promise<RLLResponse<RLLEntity.Launch[]>>, interval?: number | string, options?: RLLQueryConfig.Launches);
     /**
-     * Recursive API Caller to iterate through pages
+     * Fetch a single launches page. Always normalizes the page query param so a
+     * caller-supplied `page` cannot derail pagination.
      *
      * @private
-     * @function
-     *
-     * @param {URLSearchParams} params - Search parameters
-     * @param {function(results: RLLResponse<RLLEntity.Launch[]>)} callback - To execute on each page
+     */
+    private fetchPage;
+    /**
+     * Fetch every page for a query. After page 1 reveals `last_page`, remaining
+     * pages are fetched with bounded concurrency (1 = fully serial).
      *
-     * @returns {Promise<void>}
+     * @private
      */
-    private recursivelyFetch;
+    private fetchAllPages;
     /**
      * Query wrapper to trigger events
      *
@@ -62,6 +65,7 @@ export declare class RLLWatcher extends EventEmitter {
     private query;
     /**
      * Begin monitoring API using the configured query parameters.
+     * Subsequent calls while already running are no-ops.
      *
      * @public
      * @function