rocket-launch-live-client 1.0.4 → 2.0.0

package/lib/esm/Client.js

@@ -1,229 +0,0 @@
-import { RLLEndPoint, } from "./types/application.js";
-import { fetcher } from "./fetcher.js";
-import { apiKeyValidator, optionsValidator, queryOptionsValidator, } from "./utils.js";
-import { RLLWatcher } from "./Watcher.js";
-/**
- * Class representing a RocketLaunch.Live client
- * @class
- */
-export class RLLClient {
-    /**
-     * Create a new RocketLaunch.live Client
-     *
-     * @param {string} apiKey - Your RocketLaunch.Live API Key
-     * @param {Object} [options] - Optional Client Configuration options
-     * @param {boolean} options.keyInQueryParams - Set to true to send your API Key via Query parameters instead of Authorization Header (not recommended)
-     *
-     */
-    constructor(apiKey, options) {
-        this.config = {
-            keyInQueryParams: false,
-        };
-        // Validate API Key is a valid UUID format
-        // Constructor throws if not
-        this.apiKey = apiKeyValidator(apiKey);
-        if (!options) {
-            return;
-        }
-        // Validate Options with warnings or throws
-        optionsValidator(options);
-        if (options.keyInQueryParams) {
-            this.config.keyInQueryParams = options.keyInQueryParams;
-        }
-    }
-    /**
-     * Used internally to make API query
-     *
-     * @private
-     *
-     * @template T
-     *
-     * @param {string} endpoint - API endpoint (ie. "/launches")
-     * @param {URLSearchParams} params - API Search Params
-     *
-     * @returns {Promise<T>}
-     */
-    query(endpoint, params) {
-        return fetcher(this.apiKey, endpoint, params, this.config.keyInQueryParams);
-    }
-    /**
-     * Instantiate a new RLL Watcher which will continually query the API for changes to the launches endpoint
-     *
-     * @public
-     *
-     * @param {number} interval - Interval in minutes to query the API for changes. Defaults to 5 minutes, cannot be less than 1 minute
-     * @param {RLLQueryConfig.Launches} options - Query options, same as calling the launches method
-     *
-     * @returns {RLLWatcher}
-     */
-    watch(interval, options) {
-        return new RLLWatcher((params) => this.query(RLLEndPoint.LAUNCHES, params), interval, options);
-    }
-    /**
-     * Fetch launch companies
-     *
-     * @public
-     * @function
-     *
-     * @param {Object} [options] - Launch Company Search Options
-     * @param {number | string} options.id - Company id
-     * @param {number | string} options.page - Page number of results
-     * @param {number | string} options.name - Company name
-     * @param {ISO3166Alpha2.CountryCode} options.country_code - ISO 3166 Alpha 2 Country Code
-     * @param {boolean} options.inactive - Company inactive status
-     *
-     * @returns {Promise<RLLResponse<RLLEntity.Company[]>>} Array of companies wrapped in a standard RLL Response
-     *
-     * @example
-     *
-     * const response = await client.companies({ country_code: "US" })
-     */
-    companies(options) {
-        const params = queryOptionsValidator(RLLEndPoint.COMPANIES, options);
-        return this.query(RLLEndPoint.COMPANIES, params);
-    }
-    /**
-     * Fetch launches
-     *
-     * @public
-     * @function
-     *
-     * @param {Object} [options] - Launch Search Options
-     * @param {number | string} options.id - Launch id
-     * @param {number | string} options.page - Page number of results
-     * @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
-     * @param {Date | string} options.modified_since - Only return launches with API changes after this date
-     * @param {number | string} options.location_id - Launches from this Location
-     * @param {number | string} options.pad_id - Launches from this Pad
-     * @param {number | string} options.provider_id - Launches from this Company
-     * @param {number | string} options.tag_id - Launches with this Tag
-     * @param {number | string} options.vehicle_id - Launches on this Vehicle
-     * @param {ISO3166Alpha2.StateCodeUS} options.state_abbr - ISO 3166 Alpha 2 US State Code
-     * @param {ISO3166Alpha2.CountryCode} options.country_code - ISO 3166 Alpha 2 Country Code
-     * @param {number | string} options.search - Launches matching this search string
-     * @param {number | string} options.slug - Launches matching this unique slug
-     * @param {number | string} options.limit - Limit results (default 25, max 25)
-     * @param {'asc' | 'desc'} options.direction - Launches matching this unique slug
-     *
-     * @returns {Promise<RLLResponse<RLLEntity.Launch[]>>} Array of companies wrapped in a standard RLL Response
-     *
-     * @example
-     *
-     * const response = await client.launches({ after_date: new Date("2022-10-10") })
-     */
-    launches(options) {
-        const params = queryOptionsValidator(RLLEndPoint.LAUNCHES, options);
-        return this.query(RLLEndPoint.LAUNCHES, params);
-    }
-    /**
-     * Fetch launch locations
-     *
-     * @public
-     * @function
-     *
-     * @param {Object} [options] - Launch Location Search Options
-     * @param {number | string} options.id - Location id
-     * @param {number | string} options.page - Page number of results
-     * @param {number | string} options.name - Location name
-     * @param {ISO3166Alpha2.StateCodeUS} options.state_abbr - ISO 3166 Alpha 2 US State Code
-     * @param {ISO3166Alpha2.CountryCode} options.country_code - ISO 3166 Alpha 2 Country Code
-     *
-     * @returns {Promise<RLLResponse<RLLEntity.Location[]>>} Array of companies wrapped in a standard RLL Response
-     *
-     * @example
-     *
-     * const response = await client.locations({ country_code: "US" })
-     */
-    locations(options) {
-        const params = queryOptionsValidator(RLLEndPoint.LOCATIONS, options);
-        return this.query(RLLEndPoint.LOCATIONS, params);
-    }
-    /**
-     * Fetch launch Missions
-     *
-     * @public
-     * @function
-     *
-     * @param {Object} [options] - Launch Mission Search Options
-     * @param {number | string} options.id - Mission id
-     * @param {number | string} options.page - Page number of results
-     * @param {number | string} options.name - Mission name
-     *
-     * @returns {Promise<RLLResponse<RLLEntity.Mission[]>>} Array of companies wrapped in a standard RLL Response
-     *
-     * @example
-     *
-     * const response = await client.missions({ name: "Mars 2020" })
-     */
-    missions(options) {
-        const params = queryOptionsValidator(RLLEndPoint.MISSIONS, options);
-        return this.query(RLLEndPoint.MISSIONS, params);
-    }
-    /**
-     * Fetch launch pads
-     *
-     * @public
-     * @function
-     *
-     * @param {Object} [options] - Launch Pad Search Options
-     * @param {number | string} options.id - Pad id
-     * @param {number | string} options.page - Page number of results
-     * @param {number | string} options.name - Pad name
-     * @param {ISO3166Alpha2.StateCodeUS} options.state_abbr - ISO 3166 Alpha 2 US State Code
-     * @param {ISO3166Alpha2.CountryCode} options.country_code - ISO 3166 Alpha 2 Country Code
-     *
-     * @returns {Promise<RLLResponse<RLLEntity.Pad[]>>} Array of companies wrapped in a standard RLL Response
-     *
-     * @example
-     *
-     * const response = await client.pads({ country_code: "US" })
-     */
-    pads(options) {
-        const params = queryOptionsValidator(RLLEndPoint.PADS, options);
-        return this.query(RLLEndPoint.PADS, params);
-    }
-    /**
-     * Fetch launch tags
-     *
-     * @public
-     * @function
-     *
-     * @param {Object} [options] - Launch Tag Search Options
-     * @param {number | string} options.id - Tag id
-     * @param {number | string} options.page - Page number of results
-     * @param {number | string} options.text - Tag text
-     *
-     * @returns {Promise<RLLResponse<RLLEntity.Tag[]>>} Array of companies wrapped in a standard RLL Response
-     *
-     * @example
-     *
-     * const response = await client.tags({ text: "Crewed" })
-     */
-    tags(options) {
-        const params = queryOptionsValidator(RLLEndPoint.TAGS, options);
-        return this.query(RLLEndPoint.TAGS, params);
-    }
-    /**
-     * Fetch launch Vehicles
-     *
-     * @public
-     * @function
-     *
-     * @param {Object} [options] - Launch Vehicles Search Options
-     * @param {number | string} options.id - Vehicle id
-     * @param {number | string} options.page - Page number of results
-     * @param {number | string} options.name - Vehicle name
-     *
-     * @returns {Promise<RLLResponse<RLLEntity.Vehicle[]>>} Array of companies wrapped in a standard RLL Response
-     *
-     * @example
-     *
-     * const response = await client.vehicles({ name: "Falcon 9" })
-     */
-    vehicles(options) {
-        const params = queryOptionsValidator(RLLEndPoint.VEHICLES, options);
-        return this.query(RLLEndPoint.VEHICLES, params);
-    }
-}

package/lib/esm/Watcher.js

@@ -1,168 +0,0 @@
-import { EventEmitter } from "events";
-import { RLLEndPoint, } from "./types/application.js";
-import { error, warn, queryOptionsValidator, formatToRLLISODate, } from "./utils.js";
-const DEFAULT_INTERVAL_IN_MINS = 5;
-const MS_IN_MIN = 60000;
-const intervalValidator = (interval) => {
-    if (typeof interval !== "number" && typeof interval !== "string") {
-        error("RLLWatcher interval must be a number.");
-        return DEFAULT_INTERVAL_IN_MINS;
-    }
-    if (typeof interval === "string" &&
-        (isNaN(Number(interval)) || interval === "")) {
-        error("RLLWatcher interval must be a number.", "type");
-        return DEFAULT_INTERVAL_IN_MINS;
-    }
-    const typedInterval = Number(interval);
-    if (typedInterval <= 0) {
-        error("RLLWatcher interval cannot be a negative number or zero. Watcher intervals should be greater than or equal to 1 minute.");
-        return DEFAULT_INTERVAL_IN_MINS;
-    }
-    if (typedInterval < 1) {
-        warn("RLLWatcher does not accept intervals less than 1. Your watcher will default to 5 minute intervals unless corrected.");
-        return DEFAULT_INTERVAL_IN_MINS;
-    }
-    return typedInterval;
-};
-/**
- * Class representing a RocketLaunch.Live Client Watcher
- * @class
- */
-export class RLLWatcher extends EventEmitter {
-    /**
-     * Create a new RocketLaunch.live Client Watcher
-     *
-     * @param {function(params: URLSearchParams): Promise<RLLResponse<RLLEntity.Launch[]>>} fetcher - fetcher function to make API calls
-     * @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 {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
-     * @param {Date | string} options.modified_since - Only return launches with API changes after this date
-     * @param {number | string} options.location_id - Launches from this Location
-     * @param {number | string} options.pad_id - Launches from this Pad
-     * @param {number | string} options.provider_id - Launches from this Company
-     * @param {number | string} options.tag_id - Launches with this Tag
-     * @param {number | string} options.vehicle_id - Launches on this Vehicle
-     * @param {ISO3166Alpha2.StateCodeUS} options.state_abbr - ISO 3166 Alpha 2 US State Code
-     * @param {ISO3166Alpha2.CountryCode} options.country_code - ISO 3166 Alpha 2 Country Code
-     * @param {number | string} options.search - Launches matching this search string
-     * @param {number | string} options.slug - Launches matching this unique slug
-     *
-     */
-    constructor(fetcher, interval = DEFAULT_INTERVAL_IN_MINS, options) {
-        super();
-        this.launches = new Map();
-        /**
-         * Recursive API Caller to iterate through pages
-         *
-         * @private
-         * @function
-         *
-         * @param {URLSearchParams} params - Search parameters
-         * @param {function(results: RLLResponse<RLLEntity.Launch[]>)} callback - To execute on each page
-         *
-         * @returns {Promise<void>}
-         */
-        this.recursivelyFetch = (params, callback) => {
-            let page = 1;
-            const recursiveFetcher = () => {
-                this.emit("call", params);
-                return this.fetcher(params).then((results) => {
-                    callback(results);
-                    if (results.last_page > page) {
-                        page++;
-                        params.set("page", page.toString());
-                        return recursiveFetcher();
-                    }
-                    return;
-                });
-            };
-            return recursiveFetcher();
-        };
-        // Reassign default Event Emitter methods
-        this._untypedOn = this.on;
-        this._untypedEmit = this.emit;
-        // Methord Overide for type safety
-        this.on = (event, listener) => this._untypedOn(event, listener);
-        this.emit = (event, ...args) => this._untypedEmit(event, ...args);
-        this.last_call = new Date();
-        this.fetcher = fetcher;
-        this.interval = intervalValidator(interval);
-        this.params = queryOptionsValidator(RLLEndPoint.LAUNCHES, options);
-        // ignore any limit params as these cause unnecessary API calls and do not serve the Watcher role
-        this.params.delete("limit");
-    }
-    /**
-     * Query wrapper to trigger events
-     *
-     * @private
-     * @function
-     *
-     * @returns {void}
-     */
-    query() {
-        const notify = (response) => {
-            for (const changedLaunch of response.result) {
-                const { id } = changedLaunch;
-                const oldLaunch = this.launches.get(id);
-                if (oldLaunch) {
-                    this.emit("change", oldLaunch, changedLaunch);
-                }
-                else {
-                    this.emit("new", changedLaunch);
-                }
-                this.launches.set(changedLaunch.id, changedLaunch);
-            }
-        };
-        this.params.set("modified_since", formatToRLLISODate(this.last_call));
-        this.recursivelyFetch(new URLSearchParams(this.params), notify)
-            .then(() => {
-            this.last_call = new Date();
-        })
-            .catch((err) => {
-            this.emit("error", err);
-        });
-    }
-    /**
-     * Begin monitoring API using the configured query parameters.
-     *
-     * @public
-     * @function
-     *
-     * @returns {void}
-     */
-    start() {
-        const buildCache = (response) => {
-            for (const launch of response.result) {
-                this.launches.set(launch.id, launch);
-            }
-        };
-        this.recursivelyFetch(new URLSearchParams(this.params), buildCache)
-            .then(() => {
-            this.emit("ready", this.launches);
-            this.last_call = new Date();
-            this.timer = setInterval(() => {
-                this.query();
-            }, this.interval * MS_IN_MIN);
-        })
-            .catch((err) => {
-            this.emit("init_error", err);
-        });
-    }
-    /**
-     * Stop monitoring API
-     *
-     * @public
-     * @function
-     *
-     * @returns {void}
-     */
-    stop() {
-        if (this.timer) {
-            clearInterval(this.timer);
-        }
-    }
-}

package/lib/esm/fetcher.js

@@ -1,54 +0,0 @@
-import https from "https";
-const BASE_URL = "https://fdo.rocketlaunch.live";
-export const fetcher = (apiKey, endpoint, params, keyInQueryParams) => {
-    const url = new URL("json/" + endpoint, BASE_URL);
-    let headers;
-    if (keyInQueryParams) {
-        params.set("key", apiKey);
-    }
-    else {
-        headers = { authorization: `Bearer ${apiKey}` };
-    }
-    params.forEach((v, k) => url.searchParams.set(k, v));
-    return query(url, headers);
-};
-const query = (url, headers) => {
-    return new Promise((resolve, reject) => {
-        const req = https.get(url, { headers }, (res) => {
-            let data = [];
-            res.on("data", (chunk) => data.push(chunk));
-            res.on("end", () => {
-                var _a;
-                const response = Buffer.concat(data).toString();
-                let server_response;
-                try {
-                    server_response = JSON.parse(response);
-                }
-                catch (e) {
-                    server_response = response;
-                }
-                if (res.statusCode === 200) {
-                    resolve(server_response);
-                }
-                else {
-                    const error = {
-                        error: "API Call Failed",
-                        statusCode: (_a = res.statusCode) !== null && _a !== void 0 ? _a : null,
-                        message: "RLLC recieved a response from the server but it did not complete as expected.",
-                        server_response,
-                    };
-                    reject(error);
-                }
-            });
-        });
-        req.on("error", () => {
-            const error = {
-                error: "Unknown error",
-                statusCode: null,
-                message: "RLLC recieved an unknown error. This usually means that the HTTP request did not complete",
-                server_response: null,
-            };
-            reject(error);
-        });
-    });
-};

package/lib/esm/index.mjs

@@ -1,22 +0,0 @@
-import { RLLClient } from "./Client.js";
-export { RLLEndPoint, RLLEntity, } from "./types/application.js";
-export { RLLClient } from "./Client.js";
-export { RLLWatcher } from "./Watcher.js";
-/**
- * Generate a RocketLaunch.Live client
- *
- * @public
- * @function
- *
- * @param {string} apiKey - Your RocketLaunch.Live API Key
- * @param {Object} [options] - Optional Client Configuration options
- * @param {boolean} options.keyInQueryParams - Set to true to send your API Key via Query parameters instead of Authorization Header (not recommended)
- *
- * @returns {RLLCLient}
- *
- * @example
- *
- * const MY_KEY = process.env.ROCKETLAUNCH_LIVE_API_KEY
- * const client = rllc(MY_KEY, { keyInQueryParams: true })
- */
-export const rllc = (apiKey, options) => new RLLClient(apiKey, options);

package/lib/esm/package.json

@@ -1,3 +0,0 @@
-{
-    "type": "module"
-}

package/lib/esm/types/Watcher.d.ts

@@ -1,81 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { EventEmitter } from "events";
-import { RLLEntity, RLLQueryConfig, RLLResponse } from "./types/application.js";
-/**
- * Class representing a RocketLaunch.Live Client Watcher
- * @class
- */
-export declare class RLLWatcher extends EventEmitter {
-    private _untypedOn;
-    private _untypedEmit;
-    private last_call;
-    launches: Map<number, RLLEntity.Launch>;
-    private interval;
-    private params;
-    private timer;
-    private fetcher;
-    /**
-     * Create a new RocketLaunch.live Client Watcher
-     *
-     * @param {function(params: URLSearchParams): Promise<RLLResponse<RLLEntity.Launch[]>>} fetcher - fetcher function to make API calls
-     * @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 {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
-     * @param {Date | string} options.modified_since - Only return launches with API changes after this date
-     * @param {number | string} options.location_id - Launches from this Location
-     * @param {number | string} options.pad_id - Launches from this Pad
-     * @param {number | string} options.provider_id - Launches from this Company
-     * @param {number | string} options.tag_id - Launches with this Tag
-     * @param {number | string} options.vehicle_id - Launches on this Vehicle
-     * @param {ISO3166Alpha2.StateCodeUS} options.state_abbr - ISO 3166 Alpha 2 US State Code
-     * @param {ISO3166Alpha2.CountryCode} options.country_code - ISO 3166 Alpha 2 Country Code
-     * @param {number | string} options.search - Launches matching this search string
-     * @param {number | string} options.slug - Launches matching this unique slug
-     *
-     */
-    constructor(fetcher: (params: URLSearchParams) => Promise<RLLResponse<RLLEntity.Launch[]>>, interval?: number | string, options?: RLLQueryConfig.Launches);
-    /**
-     * Recursive API Caller to iterate through pages
-     *
-     * @private
-     * @function
-     *
-     * @param {URLSearchParams} params - Search parameters
-     * @param {function(results: RLLResponse<RLLEntity.Launch[]>)} callback - To execute on each page
-     *
-     * @returns {Promise<void>}
-     */
-    private recursivelyFetch;
-    /**
-     * Query wrapper to trigger events
-     *
-     * @private
-     * @function
-     *
-     * @returns {void}
-     */
-    private query;
-    /**
-     * Begin monitoring API using the configured query parameters.
-     *
-     * @public
-     * @function
-     *
-     * @returns {void}
-     */
-    start(): void;
-    /**
-     * Stop monitoring API
-     *
-     * @public
-     * @function
-     *
-     * @returns {void}
-     */
-    stop(): void;
-}

package/lib/esm/types/application.js

@@ -1,43 +0,0 @@
-export var RLLEndPoint;
-(function (RLLEndPoint) {
-    RLLEndPoint["COMPANIES"] = "companies";
-    RLLEndPoint["LAUNCHES"] = "launches";
-    RLLEndPoint["LOCATIONS"] = "locations";
-    RLLEndPoint["MISSIONS"] = "missions";
-    RLLEndPoint["PADS"] = "pads";
-    RLLEndPoint["TAGS"] = "tags";
-    RLLEndPoint["VEHICLES"] = "vehicles";
-})(RLLEndPoint || (RLLEndPoint = {}));
-export var RLLEntity;
-(function (RLLEntity) {
-    let LaunchResult;
-    (function (LaunchResult) {
-        LaunchResult[LaunchResult["NOT_SET"] = -1] = "NOT_SET";
-        LaunchResult[LaunchResult["FAILURE"] = 0] = "FAILURE";
-        LaunchResult[LaunchResult["SUCCESS"] = 1] = "SUCCESS";
-        LaunchResult[LaunchResult["PARTIAL_FAILURE"] = 2] = "PARTIAL_FAILURE";
-        LaunchResult[LaunchResult["IN_FLIGHT_ABORT_CREWED"] = 3] = "IN_FLIGHT_ABORT_CREWED";
-    })(LaunchResult = RLLEntity.LaunchResult || (RLLEntity.LaunchResult = {}));
-})(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/esm/types/fetcher.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="node" />
-export declare const fetcher: <T>(apiKey: string, endpoint: string, params: URLSearchParams, keyInQueryParams: boolean) => Promise<T>;

package/lib/esm/types/index.d.ts

@@ -1,24 +0,0 @@
-import { RLLClient } from "./Client.js";
-import { RLLClientOptions } from "./types/application.js";
-export { RLLEndPoint, RLLResponse, RLLClientOptions, RLLQueryConfig, RLLEntity, RLLError, } from "./types/application.js";
-export { ISO3166Alpha2 } from "./types/standards.js";
-export { RLLClient } from "./Client.js";
-export { RLLWatcher } from "./Watcher.js";
-/**
- * Generate a RocketLaunch.Live client
- *
- * @public
- * @function
- *
- * @param {string} apiKey - Your RocketLaunch.Live API Key
- * @param {Object} [options] - Optional Client Configuration options
- * @param {boolean} options.keyInQueryParams - Set to true to send your API Key via Query parameters instead of Authorization Header (not recommended)
- *
- * @returns {RLLCLient}
- *
- * @example
- *
- * const MY_KEY = process.env.ROCKETLAUNCH_LIVE_API_KEY
- * const client = rllc(MY_KEY, { keyInQueryParams: true })
- */
-export declare const rllc: (apiKey: string, options?: RLLClientOptions) => RLLClient;