rocket-launch-live-client 1.0.4 → 2.0.0

package/lib/cjs/fetcher.js

@@ -1,61 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetcher = void 0;
-const https_1 = __importDefault(require("https"));
-const BASE_URL = "https://fdo.rocketlaunch.live";
-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);
-};
-exports.fetcher = fetcher;
-const query = (url, headers) => {
-    return new Promise((resolve, reject) => {
-        const req = https_1.default.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/cjs/index.js

@@ -1,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.rllc = exports.RLLWatcher = exports.RLLClient = exports.RLLEntity = exports.RLLEndPoint = void 0;
-const Client_js_1 = require("./Client.js");
-var application_js_1 = require("./types/application.js");
-Object.defineProperty(exports, "RLLEndPoint", { enumerable: true, get: function () { return application_js_1.RLLEndPoint; } });
-Object.defineProperty(exports, "RLLEntity", { enumerable: true, get: function () { return application_js_1.RLLEntity; } });
-var Client_js_2 = require("./Client.js");
-Object.defineProperty(exports, "RLLClient", { enumerable: true, get: function () { return Client_js_2.RLLClient; } });
-var Watcher_js_1 = require("./Watcher.js");
-Object.defineProperty(exports, "RLLWatcher", { enumerable: true, get: function () { return Watcher_js_1.RLLWatcher; } });
-/**
- * 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 })
- */
-const rllc = (apiKey, options) => new Client_js_1.RLLClient(apiKey, options);
-exports.rllc = rllc;

package/lib/cjs/package.json

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

package/lib/cjs/types/Client.d.ts

@@ -1,189 +0,0 @@
-import { RLLClientOptions, RLLEntity, RLLQueryConfig, RLLResponse } from "./types/application.js";
-import { RLLWatcher } from "./Watcher.js";
-/**
- * Class representing a RocketLaunch.Live client
- * @class
- */
-export declare class RLLClient {
-    private apiKey;
-    private config;
-    /**
-     * 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: string, options?: RLLClientOptions);
-    /**
-     * 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>}
-     */
-    private query;
-    /**
-     * 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?: number | string, options?: RLLQueryConfig.Launches): RLLWatcher;
-    /**
-     * 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?: RLLQueryConfig.Companies): Promise<RLLResponse<RLLEntity.Company[]>>;
-    /**
-     * 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?: RLLQueryConfig.Launches): Promise<RLLResponse<RLLEntity.Launch[]>>;
-    /**
-     * 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?: RLLQueryConfig.Locations): Promise<RLLResponse<RLLEntity.Location[]>>;
-    /**
-     * 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?: RLLQueryConfig.Missions): Promise<RLLResponse<RLLEntity.Mission[]>>;
-    /**
-     * 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?: RLLQueryConfig.Pads): Promise<RLLResponse<RLLEntity.Pad[]>>;
-    /**
-     * 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?: RLLQueryConfig.Tags): Promise<RLLResponse<RLLEntity.Tag[]>>;
-    /**
-     * 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?: RLLQueryConfig.Vehicles): Promise<RLLResponse<RLLEntity.Vehicle[]>>;
-}

package/lib/cjs/types/application.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RLLQueryParams = exports.RLLEntity = exports.RLLEndPoint = void 0;
-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 || (exports.RLLEndPoint = RLLEndPoint = {}));
-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 || (exports.RLLEntity = RLLEntity = {}));
-exports.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/cjs/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/cjs/types/standards.js

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