rocket-launch-live-client 0.1.0

package/dist/fetcher.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetcher = void 0;
+var https = require("node:https");
+var BASE_URL = "https://fdo.rocketlaunch.live";
+var fetcher = function (apiKey, endpoint, params, keyInQueryParams) {
+    var url = new URL("json/" + endpoint, BASE_URL);
+    var headers;
+    if (keyInQueryParams) {
+        params.set("key", apiKey);
+    }
+    else {
+        headers = { authorization: "Bearer ".concat(apiKey) };
+    }
+    params.forEach(function (v, k) { return url.searchParams.set(k, v); });
+    return query(url, headers);
+};
+exports.fetcher = fetcher;
+var query = function (url, headers) {
+    return new Promise(function (resolve, reject) {
+        var req = https.get(url, { headers: headers }, function (res) {
+            var data = [];
+            res.on("data", function (chunk) { return data.push(chunk); });
+            res.on("end", function () {
+                if (res.statusCode === 200) {
+                    var response = Buffer.concat(data).toString();
+                    resolve(JSON.parse(response));
+                }
+                else if (res.statusCode === 404) {
+                    reject({
+                        error: "Resource not found",
+                        statusCode: 404,
+                        message: "The server returned a 404 Not Found response. Check that your API key is valid, and that you are not requesting a page number beyond the available results.",
+                    });
+                }
+                else {
+                    reject(res);
+                }
+            });
+        });
+        req.on("error", reject);
+    });
+};
+//# sourceMappingURL=fetcher.js.map

package/dist/fetcher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetcher.js","sourceRoot":"","sources":["../src/fetcher.ts"],"names":[],"mappings":";;;AAAA,IAAM,KAAK,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAEpC,IAAM,QAAQ,GAAG,+BAA+B,CAAC;AAE1C,IAAM,OAAO,GAAG,UACrB,MAAc,EACd,QAAgB,EAChB,MAAuB,EACvB,gBAAyB;IAEzB,IAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,GAAG,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAClD,IAAI,OAAgC,CAAC;IAErC,IAAI,gBAAgB,EAAE;QACpB,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;KAC3B;SAAM;QACL,OAAO,GAAG,EAAE,aAAa,EAAE,iBAAU,MAAM,CAAE,EAAE,CAAC;KACjD;IAED,MAAM,CAAC,OAAO,CAAC,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAA1B,CAA0B,CAAC,CAAC;IAErD,OAAO,KAAK,CAAI,GAAG,EAAE,OAAO,CAAC,CAAC;AAChC,CAAC,CAAC;AAlBW,QAAA,OAAO,WAkBlB;AAEF,IAAM,KAAK,GAAG,UAAI,GAAQ,EAAE,OAAqB;IAC/C,OAAO,IAAI,OAAO,CAAC,UAAC,OAAO,EAAE,MAAM;QACjC,IAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,SAAA,EAAE,EAAE,UAAC,GAAG;YAC1C,IAAI,IAAI,GAAG,EAAE,CAAC;YAEd,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,UAAC,KAAK,IAAK,OAAA,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAhB,CAAgB,CAAC,CAAC;YAE5C,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE;gBACZ,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE;oBAC1B,IAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;oBAChD,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;iBAC/B;qBAAM,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE;oBACjC,MAAM,CAAC;wBACL,KAAK,EAAE,oBAAoB;wBAC3B,UAAU,EAAE,GAAG;wBACf,OAAO,EACL,6JAA6J;qBAChK,CAAC,CAAC;iBACJ;qBAAM;oBACL,MAAM,CAAC,GAAG,CAAC,CAAC;iBACb;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC1B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+import RLLClient from "./Client";
+import { RLLClientOptions } from "./types/application";
+/**
+ * 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 = clientGenerator(MY_KEY, { keyInQueryParams: true })
+ */
+declare const clientGenerator: (apiKey: string, options?: RLLClientOptions) => RLLClient;
+export default clientGenerator;

package/dist/index.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var Client_1 = require("./Client");
+/**
+ * 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 = clientGenerator(MY_KEY, { keyInQueryParams: true })
+ */
+var clientGenerator = function (apiKey, options) {
+    return new Client_1.default(apiKey, options);
+};
+exports.default = clientGenerator;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,mCAAiC;AAGjC;;;;;;;;;;;;;;;;;GAiBG;AACH,IAAM,eAAe,GAAG,UACtB,MAAc,EACd,OAA0B;IAE1B,OAAO,IAAI,gBAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACxC,CAAC,CAAC;AAEF,kBAAe,eAAe,CAAC"}

package/dist/test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var dotenv = require("dotenv");
+dotenv.config();
+var index_1 = require("./index");
+var client = (0, index_1.default)(process.env.API_KEY);
+var randomId = Math.floor(Math.random() * 300);
+client.launches({ country_code: "CA" });
+//# sourceMappingURL=test.js.map

package/dist/test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.js","sourceRoot":"","sources":["../src/test.ts"],"names":[],"mappings":";;AAAA,IAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AACjC,MAAM,CAAC,MAAM,EAAE,CAAC;AAEhB,iCAA2B;AAE3B,IAAM,MAAM,GAAG,IAAA,eAAI,EAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAEzC,IAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC;AAEjD,MAAM,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC"}

package/dist/types/application.d.ts

@@ -0,0 +1,165 @@
+import { ISO3166Alpha2 } from "./standards";
+export declare enum RLLEndPoint {
+    COMPANIES = "companies",
+    LAUNCHES = "launches",
+    LOCATIONS = "locations",
+    MISSIONS = "missions",
+    PADS = "pads",
+    TAGS = "tags",
+    VEHICLES = "vehicles"
+}
+interface RLLRecord {
+    id: number;
+}
+export declare namespace RLLEntity {
+    interface Country {
+        name: string;
+        code: ISO3166Alpha2.CountryCode;
+    }
+    interface State {
+        name: string;
+        abbr: ISO3166Alpha2.StateCodeUS;
+    }
+    export interface Company extends RLLRecord {
+        country: Country;
+        inactive: boolean | null;
+    }
+    enum LaunchResult {
+        NOT_SET = -1,
+        FAILURE = 0,
+        SUCCESS = 1,
+        PARTIAL_FAILURE = 2,
+        IN_FLIGHT_ABORT_CREWED = 3
+    }
+    interface Media extends RLLRecord {
+        media_url: string | null;
+        youtube_vidid: string | null;
+        featured: boolean;
+        ldfeatured: boolean;
+        approved: boolean;
+    }
+    export interface Launch extends RLLRecord {
+        name: string;
+        cospar_id: string;
+        sort_date: string;
+        provider: Omit<Company, "inactive" | "country">;
+        vehicle: Omit<Vehicle, "company_id" | "company">;
+        pad: Omit<Pad, "full_name">;
+        missions: Omit<Mission, "launch_id">[];
+        mission_description: string | null;
+        launch_description: string;
+        win_open: string | null;
+        t0: string | null;
+        win_close: string | null;
+        est_date: {
+            month: number | null;
+            day: number | null;
+            year: number | null;
+            quarter: number | null;
+        };
+        date_str: string;
+        tags: Omit<Tag, "slug">[];
+        slug: string;
+        weather_summary: string | null;
+        weather_temp: number | null;
+        weather_icon: string | null;
+        weather_updated: string | null;
+        quicktext: string;
+        media?: Media[];
+        result: LaunchResult;
+        suborbital: boolean;
+        modified: string;
+    }
+    export interface Location extends RLLRecord {
+        name: string;
+        latitute: string;
+        latitude: string;
+        longitude: string;
+        state: State | null;
+        statename?: string | null;
+        country: Country;
+        pads: Omit<Pad, "location" | "country" | "state">[];
+        utc_offset: number;
+    }
+    export interface Mission extends RLLRecord {
+        name: string;
+        description: string | null;
+        launch_id: number;
+        company: Omit<Company, "slug" | "inactive" | "country">;
+    }
+    export interface Pad extends RLLRecord {
+        name: string;
+        full_name: string;
+        location: Omit<Location, "pads" | "utc_offset" | "latitute">;
+    }
+    export interface Tag extends RLLRecord {
+        text: string;
+        slug: string;
+    }
+    export interface Vehicle extends RLLRecord {
+        name: string;
+        company_id?: number;
+        company: Omit<Company, "slug" | "inactive" | "country">;
+    }
+    export {};
+}
+interface RLLBaseQueryConfig {
+    id?: number | string;
+    page?: number | string;
+}
+export declare namespace RLLQueryConfig {
+    interface Companies extends RLLBaseQueryConfig {
+        name?: string | number;
+        country_code?: ISO3166Alpha2.CountryCode;
+        inactive?: boolean;
+    }
+    interface Launches extends RLLBaseQueryConfig {
+        cospar_id?: string;
+        after_date?: Date | string;
+        before_date?: Date | string;
+        modified_since?: Date | string;
+        location_id?: number | string;
+        pad_id?: number | string;
+        provider_id?: number | string;
+        tag_id?: number | string;
+        vehicle_id?: number | string;
+        state_abbr?: ISO3166Alpha2.StateCodeUS;
+        country_code?: ISO3166Alpha2.CountryCode;
+        search?: string | number;
+        slug?: string | number;
+    }
+    interface Locations extends RLLBaseQueryConfig {
+        name?: string | number;
+        state_abbr?: ISO3166Alpha2.StateCodeUS;
+        country_code?: ISO3166Alpha2.CountryCode;
+    }
+    interface Missions extends RLLBaseQueryConfig {
+        name?: string | number;
+    }
+    interface Pads extends RLLBaseQueryConfig {
+        name?: string | number;
+        state_abbr?: ISO3166Alpha2.StateCodeUS;
+        country_code?: ISO3166Alpha2.CountryCode;
+    }
+    interface Tags extends RLLBaseQueryConfig {
+        text?: string | number;
+    }
+    interface Vehicles extends RLLBaseQueryConfig {
+        name?: string | number;
+    }
+    interface All extends Companies, Launches, Locations, Missions, Pads, Tags, Vehicles {
+    }
+}
+export type RLLClientOptions = {
+    keyInQueryParams?: boolean;
+};
+export type RLLResponse<T> = {
+    errors?: string[];
+    valid_auth: boolean;
+    count: number;
+    limit: number;
+    total: number;
+    last_page: number;
+    result: T;
+};
+export {};

package/dist/types/application.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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 || (exports.RLLEndPoint = {}));
+var RLLEntity;
+(function (RLLEntity) {
+    var 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 || (LaunchResult = {}));
+})(RLLEntity = exports.RLLEntity || (exports.RLLEntity = {}));
+//# sourceMappingURL=application.js.map

package/dist/types/application.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"application.js","sourceRoot":"","sources":["../../src/types/application.ts"],"names":[],"mappings":";;;AAEA,IAAY,WAQX;AARD,WAAY,WAAW;IACrB,sCAAuB,CAAA;IACvB,oCAAqB,CAAA;IACrB,sCAAuB,CAAA;IACvB,oCAAqB,CAAA;IACrB,4BAAa,CAAA;IACb,4BAAa,CAAA;IACb,oCAAqB,CAAA;AACvB,CAAC,EARW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAQtB;AAMD,IAAiB,SAAS,CAoGzB;AApGD,WAAiB,SAAS;IAgBxB,IAAK,YAMJ;IAND,WAAK,YAAY;QACf,sDAAY,CAAA;QACZ,qDAAW,CAAA;QACX,qDAAW,CAAA;QACX,qEAAmB,CAAA;QACnB,mFAA0B,CAAA;IAC5B,CAAC,EANI,YAAY,KAAZ,YAAY,QAMhB;AA8EH,CAAC,EApGgB,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAoGzB"}

package/dist/types/standards.d.ts

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