rocket-launch-live-client 0.1.4 → 0.2.0

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

@@ -8,15 +8,15 @@ export declare enum RLLEndPoint {
     TAGS = "tags",
     VEHICLES = "vehicles"
 }
-interface RLLRecord {
-    id: number;
-}
 export declare namespace RLLEntity {
-    interface Country {
+    interface RLLRecord {
+        id: number;
+    }
+    export interface Country {
         name: string;
         code: ISO3166Alpha2.CountryCode;
     }
-    interface State {
+    export interface State {
         name: string;
         abbr: ISO3166Alpha2.StateCodeUS;
     }
@@ -24,14 +24,14 @@ export declare namespace RLLEntity {
         country: Country;
         inactive: boolean | null;
     }
-    enum LaunchResult {
+    export enum LaunchResult {
         NOT_SET = -1,
         FAILURE = 0,
         SUCCESS = 1,
         PARTIAL_FAILURE = 2,
         IN_FLIGHT_ABORT_CREWED = 3
     }
-    interface Media extends RLLRecord {
+    export interface Media extends RLLRecord {
         media_url: string | null;
         youtube_vidid: string | null;
         featured: boolean;
@@ -103,17 +103,37 @@ export declare namespace RLLEntity {
     }
     export {};
 }
-interface RLLBaseQueryConfig {
-    id?: number | string;
-    page?: number | string;
-}
+export declare const RLLQueryParams: {
+    id: boolean;
+    page: boolean;
+    name: boolean;
+    country_code: boolean;
+    inactive: boolean;
+    cospar_id: boolean;
+    after_date: boolean;
+    before_date: boolean;
+    modified_since: boolean;
+    location_id: boolean;
+    pad_id: boolean;
+    provider_id: boolean;
+    tag_id: boolean;
+    vehicle_id: boolean;
+    state_abbr: boolean;
+    search: boolean;
+    slug: boolean;
+    text: boolean;
+};
 export declare namespace RLLQueryConfig {
-    interface Companies extends RLLBaseQueryConfig {
+    interface Base {
+        id?: number | string;
+        page?: number | string;
+    }
+    export interface Companies extends Base {
         name?: string | number;
         country_code?: ISO3166Alpha2.CountryCode;
         inactive?: boolean;
     }
-    interface Launches extends RLLBaseQueryConfig {
+    export interface Launches extends Base {
         cospar_id?: string;
         after_date?: Date | string;
         before_date?: Date | string;
@@ -128,27 +148,26 @@ export declare namespace RLLQueryConfig {
         search?: string | number;
         slug?: string | number;
     }
-    interface Locations extends RLLBaseQueryConfig {
+    export interface Locations extends Base {
         name?: string | number;
         state_abbr?: ISO3166Alpha2.StateCodeUS;
         country_code?: ISO3166Alpha2.CountryCode;
     }
-    interface Missions extends RLLBaseQueryConfig {
+    export interface Missions extends Base {
         name?: string | number;
     }
-    interface Pads extends RLLBaseQueryConfig {
+    export interface Pads extends Base {
         name?: string | number;
         state_abbr?: ISO3166Alpha2.StateCodeUS;
         country_code?: ISO3166Alpha2.CountryCode;
     }
-    interface Tags extends RLLBaseQueryConfig {
+    export interface Tags extends Base {
         text?: string | number;
     }
-    interface Vehicles extends RLLBaseQueryConfig {
+    export interface Vehicles extends Base {
         name?: string | number;
     }
-    interface All extends Companies, Launches, Locations, Missions, Pads, Tags, Vehicles {
-    }
+    export {};
 }
 export type RLLClientOptions = {
     keyInQueryParams?: boolean;
@@ -162,4 +181,4 @@ export type RLLResponse<T> = {
     last_page: number;
     result: T;
 };
-export {};
+//# sourceMappingURL=application.d.ts.map

package/lib/cjs/types/types/application.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"application.d.ts","sourceRoot":"","sources":["../../../../src/types/application.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,oBAAY,WAAW;IACrB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,QAAQ,aAAa;CACtB;AAED,yBAAiB,SAAS,CAAC;IACzB,UAAU,SAAS;QACjB,EAAE,EAAE,MAAM,CAAC;KACZ;IAED,MAAM,WAAW,OAAO;QACtB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,aAAa,CAAC,WAAW,CAAC;KACjC;IAED,MAAM,WAAW,KAAK;QACpB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,aAAa,CAAC,WAAW,CAAC;KACjC;IAED,MAAM,WAAW,OAAQ,SAAQ,SAAS;QACxC,OAAO,EAAE,OAAO,CAAC;QACjB,QAAQ,EAAE,OAAO,GAAG,IAAI,CAAC;KAC1B;IAED,MAAM,MAAM,YAAY;QACtB,OAAO,KAAK;QACZ,OAAO,IAAI;QACX,OAAO,IAAI;QACX,eAAe,IAAI;QACnB,sBAAsB,IAAI;KAC3B;IAED,MAAM,WAAW,KAAM,SAAQ,SAAS;QACtC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,QAAQ,EAAE,OAAO,CAAC;QAClB,UAAU,EAAE,OAAO,CAAC;QACpB,QAAQ,EAAE,OAAO,CAAC;KACnB;IAED,MAAM,WAAW,MAAO,SAAQ,SAAS;QACvC,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,IAAI,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,CAAC,CAAC;QAChD,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,YAAY,GAAG,SAAS,CAAC,CAAC;QACjD,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAC5B,QAAQ,EAAE,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,CAAC;QACvC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;QACnC,kBAAkB,EAAE,MAAM,CAAC;QAC3B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,EAAE,EAAE,MAAM,GAAG,IAAI,CAAC;QAClB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,QAAQ,EAAE;YACR,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;YACrB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;YACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;YACpB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;SACxB,CAAC;QACF,QAAQ,EAAE,MAAM,CAAC;QACjB,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;QAC1B,IAAI,EAAE,MAAM,CAAC;QACb,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAC/B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;QAC5B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAC/B,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC;QAChB,MAAM,EAAE,YAAY,CAAC;QACrB,UAAU,EAAE,OAAO,CAAC;QACpB,QAAQ,EAAE,MAAM,CAAC;KAClB;IAED,MAAM,WAAW,QAAS,SAAQ,SAAS;QACzC,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO,CAAC,EAAE,CAAC;QACpD,UAAU,EAAE,MAAM,CAAC;KACpB;IAED,MAAM,WAAW,OAAQ,SAAQ,SAAS;QACxC,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC,CAAC;KACzD;IAED,MAAM,WAAW,GAAI,SAAQ,SAAS;QACpC,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;QAClB,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,GAAG,UAAU,CAAC,CAAC;KAC9D;IAED,MAAM,WAAW,GAAI,SAAQ,SAAS;QACpC,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;KACd;IAED,MAAM,WAAW,OAAQ,SAAQ,SAAS;QACxC,IAAI,EAAE,MAAM,CAAC;QACb,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC,CAAC;KACzD;;CACF;AAED,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;CAmB1B,CAAC;AAEF,yBAAiB,cAAc,CAAC;IAC9B,UAAU,IAAI;QACZ,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;KACxB;IAED,MAAM,WAAW,SAAU,SAAQ,IAAI;QACrC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACvB,YAAY,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC;QACzC,QAAQ,CAAC,EAAE,OAAO,CAAC;KACpB;IAED,MAAM,WAAW,QAAS,SAAQ,IAAI;QACpC,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;QAC3B,WAAW,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;QAC5B,cAAc,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;QAC/B,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAC9B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACzB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAC9B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACzB,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAC7B,UAAU,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC;QACvC,YAAY,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC;QACzC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACzB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;KACxB;IAED,MAAM,WAAW,SAAU,SAAQ,IAAI;QACrC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACvB,UAAU,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC;QACvC,YAAY,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC;KAC1C;IAED,MAAM,WAAW,QAAS,SAAQ,IAAI;QACpC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;KACxB;IAED,MAAM,WAAW,IAAK,SAAQ,IAAI;QAChC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QACvB,UAAU,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC;QACvC,YAAY,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC;KAC1C;IAED,MAAM,WAAW,IAAK,SAAQ,IAAI;QAChC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;KACxB;IAED,MAAM,WAAW,QAAS,SAAQ,IAAI;QACpC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;KACxB;;CACF;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAC3B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,CAAC,CAAC;CACX,CAAC"}

package/{dist → lib/cjs/types}/types/standards.d.ts

@@ -308,7 +308,10 @@ export declare const usStateCodes: {
     UM: string;
     VI: string;
 };
+export declare const isValidCountryCode: (code: string) => code is "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 isValidStateCode: (code: string) => code is "AL" | "AS" | "AR" | "AZ" | "CA" | "KY" | "CO" | "GA" | "DE" | "GU" | "VA" | "IN" | "ID" | "IL" | "LA" | "MO" | "MT" | "MD" | "MN" | "ME" | "MS" | "MA" | "NC" | "NE" | "MP" | "PA" | "PR" | "SC" | "SD" | "TN" | "UM" | "VI" | "AK" | "CT" | "FL" | "HI" | "IA" | "KS" | "MI" | "NV" | "NH" | "NJ" | "NM" | "NY" | "ND" | "OH" | "OK" | "OR" | "RI" | "TX" | "UT" | "VT" | "WA" | "WV" | "WI" | "WY" | "DC";
 export declare namespace ISO3166Alpha2 {
     type CountryCode = keyof typeof countryCodes;
     type StateCodeUS = keyof typeof usStateCodes;
 }
+//# sourceMappingURL=standards.d.ts.map

package/lib/cjs/types/types/standards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"standards.d.ts","sourceRoot":"","sources":["../../../../src/types/standards.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0PxB,CAAC;AAEF,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0DxB,CAAC;AAEF,eAAO,MAAM,kBAAkB,SACvB,MAAM,ytDAGb,CAAC;AAEF,eAAO,MAAM,gBAAgB,SACrB,MAAM,yZAGb,CAAC;AAEF,yBAAiB,aAAa,CAAC;IAC7B,KAAY,WAAW,GAAG,MAAM,OAAO,YAAY,CAAC;IAEpD,KAAY,WAAW,GAAG,MAAM,OAAO,YAAY,CAAC;CACrD"}

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

@@ -0,0 +1,11 @@
+import { RLLEndPoint, RLLQueryConfig } from "./types/application";
+export declare const apiKeyValidator: (apiKey: any) => void;
+export declare const optionsValidator: (options: {
+    [key: string]: any;
+    [key: number]: any;
+    [key: symbol]: any;
+}) => void;
+export declare const queryOptionsValidator: (resource: RLLEndPoint, options?: RLLQueryConfig.Companies | RLLQueryConfig.Launches | RLLQueryConfig.Locations | RLLQueryConfig.Missions | RLLQueryConfig.Pads | RLLQueryConfig.Tags | RLLQueryConfig.Vehicles) => Promise<URLSearchParams>;
+export declare const warn: (msg: string) => void;
+export declare const error: (msg: string, type?: "type" | "range" | "error") => void;
+//# sourceMappingURL=utils.d.ts.map

package/lib/cjs/types/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAQlE,eAAO,MAAM,eAAe,WAAY,GAAG,KAAG,IAuB7C,CAAC;AAEF,eAAO,MAAM,gBAAgB;;;;MAEzB,IAeH,CAAC;AAuLF,eAAO,MAAM,qBAAqB,aACtB,WAAW,YAEjB,eAAe,SAAS,GACxB,eAAe,QAAQ,GACvB,eAAe,SAAS,GACxB,eAAe,QAAQ,GACvB,eAAe,IAAI,GACnB,eAAe,IAAI,GACnB,eAAe,QAAQ,KAC1B,QAAQ,eAAe,CA0CzB,CAAC;AAEF,eAAO,MAAM,IAAI,QAAS,MAAM,SAAyC,CAAC;AAE1E,eAAO,MAAM,KAAK,QACX,MAAM,SACL,MAAM,GAAG,OAAO,GAAG,OAAO,KAC/B,IAYF,CAAC"}

package/{dist → lib/cjs}/utils.js

@@ -1,13 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.error = exports.warn = exports.queryOptionsValidator = exports.optionsValidator = exports.apiKeyValidator = void 0;
-var standards_1 = require("./types/standards");
-var getLeadingZero = function (month, offset) {
-    if (offset === void 0) { offset = 0; }
-    var str = "0".concat((month + offset).toString());
+const standards_1 = require("./types/standards");
+const getLeadingZero = (month, offset = 0) => {
+    const str = "0".concat((month + offset).toString());
     return str.slice(-2);
 };
-var apiKeyValidator = function (apiKey) {
+const apiKeyValidator = (apiKey) => {
     if (apiKey === undefined) {
         (0, exports.error)("RLL Client requires API Key", "type");
     }
@@ -17,16 +16,16 @@ var apiKeyValidator = function (apiKey) {
     if (apiKey === "") {
         (0, exports.error)("RLL Client API Key cannot be an empty string", "type");
     }
-    var validator = apiKey.match(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i);
+    const validator = apiKey.match(/^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$/i);
     if (validator === null) {
         (0, exports.error)("RLL Client API Key appears malformed. RLL Client API Keys are in UUID format.", "type");
     }
 };
 exports.apiKeyValidator = apiKeyValidator;
-var optionsValidator = function (options) {
-    for (var option in options) {
+const optionsValidator = (options) => {
+    for (const option in options) {
         if (option !== "keyInQueryParams") {
-            (0, exports.warn)("RLL Client options do not accept a \"".concat(option, "\" property. This property will be ignored."));
+            (0, exports.warn)(`RLL Client options do not accept a "${option}" property. This property will be ignored.`);
         }
         else {
             if (typeof options[option] !== "boolean") {
@@ -36,9 +35,9 @@ var optionsValidator = function (options) {
     }
 };
 exports.optionsValidator = optionsValidator;
-var validators = {
-    string: function (option) {
-        return new Promise(function (resolve, reject) {
+const validators = {
+    string: (option) => {
+        return new Promise((resolve, reject) => {
             if (typeof option === "number") {
                 resolve(option.toString());
             }
@@ -51,16 +50,16 @@ var validators = {
             resolve(option);
         });
     },
-    boolean: function (option) {
-        return new Promise(function (resolve, reject) {
+    boolean: (option) => {
+        return new Promise((resolve, reject) => {
             if (typeof option !== "boolean") {
                 return reject("Must be a boolean");
             }
             resolve(option === true ? 1 : 0);
         });
     },
-    number: function (option) {
-        return new Promise(function (resolve, reject) {
+    number: (option) => {
+        return new Promise((resolve, reject) => {
             if (typeof option === "number") {
                 return resolve(option);
             }
@@ -74,30 +73,30 @@ var validators = {
             }
         });
     },
-    countryCode: function (option) {
-        return new Promise(function (resolve, reject) {
+    countryCode: (option) => {
+        return new Promise((resolve, reject) => {
             if (typeof option !== "string") {
                 return reject("Must be a string");
             }
-            if (!standards_1.countryCodes[option]) {
+            if (!(0, standards_1.isValidCountryCode)(option)) {
                 return reject("Invalid country code. Country codes should follow ISO 3166-1 A2 convention, like 'US'.");
             }
             resolve(option);
         });
     },
-    stateCode: function (option) {
-        return new Promise(function (resolve, reject) {
+    stateCode: (option) => {
+        return new Promise((resolve, reject) => {
             if (typeof option !== "string") {
                 return reject("Must be a string");
             }
-            if (!standards_1.usStateCodes[option]) {
+            if (!(0, standards_1.isValidStateCode)(option)) {
                 return reject("Invalid United States State Code. State Codes should follow ISO 3166-2 convention, like 'FL'.");
             }
             resolve(option);
         });
     },
-    cosparId: function (option) {
-        return new Promise(function (resolve, reject) {
+    cosparId: (option) => {
+        return new Promise((resolve, reject) => {
             if (typeof option !== "string") {
                 return reject("Must be a string");
             }
@@ -107,12 +106,12 @@ var validators = {
             resolve(option);
         });
     },
-    shortDate: function (option) {
-        return new Promise(function (resolve, reject) {
+    shortDate: (option) => {
+        return new Promise((resolve, reject) => {
             if (typeof option === "string" || option instanceof Date) {
-                var date = void 0;
+                let date;
                 if (typeof option === "string") {
-                    var parsed = Date.parse(option);
+                    const parsed = Date.parse(option);
                     if (isNaN(parsed)) {
                         return reject("Must be an ISO 8601 Date String");
                     }
@@ -121,17 +120,17 @@ var validators = {
                 else {
                     date = option;
                 }
-                resolve("".concat(date.getUTCFullYear(), "-").concat(getLeadingZero(date.getUTCMonth(), 1), "-").concat(getLeadingZero(date.getUTCDate())));
+                resolve(`${date.getUTCFullYear()}-${getLeadingZero(date.getUTCMonth(), 1)}-${getLeadingZero(date.getUTCDate())}`);
             }
             return reject("Must be a JavaScript Date Object or ISO 8601 Date String");
         });
     },
-    isoDate: function (option) {
-        return new Promise(function (resolve, reject) {
+    isoDate: (option) => {
+        return new Promise((resolve, reject) => {
             if (typeof option === "string" || option instanceof Date) {
-                var date = void 0;
+                let date;
                 if (typeof option === "string") {
-                    var parsed = Date.parse(option);
+                    const parsed = Date.parse(option);
                     if (isNaN(parsed)) {
                         return reject("Must be an ISO 8601 Date String");
                     }
@@ -146,7 +145,7 @@ var validators = {
         });
     },
 };
-var optionsMap = {
+const optionsMap = {
     companies: {
         page: validators.number,
         id: validators.number,
@@ -201,53 +200,48 @@ var optionsMap = {
         name: validators.string,
     },
 };
-var queryOptionsValidator = function (resource, options) {
-    var params = new URLSearchParams();
-    var paramsPromises = [];
+const queryOptionsValidator = (resource, options) => {
+    const params = new URLSearchParams();
+    const paramsPromises = [];
     if (!options) {
         return Promise.resolve(params);
     }
-    if ((options.id || options.slug || options.cospar_id) &&
+    if ((options.id || "slug" in options || "cospar_id" in options) &&
         Object.keys(options).length > 1) {
         (0, exports.warn)("Using 'id', 'slug', or 'cospar_id' as query parameters generally returns a single result. Combining it with other parameters may not be achieving the result you expect.");
     }
-    var _loop_1 = function (option) {
-        if (!optionsMap[resource][option]) {
-            (0, exports.warn)("Parameter \"".concat(option, "\" is not a valid option for the ").concat(resource, " endpoint. It will be ignored."));
-            return "continue";
+    for (const option in options) {
+        if (!(option in optionsMap[resource])) {
+            (0, exports.warn)(`Parameter "${option}" is not a valid option for the ${resource} endpoint. It will be ignored.`);
+            continue;
         }
         if (options[option] === undefined) {
-            (0, exports.warn)("Parameter \"".concat(option, "\" is undefined and will be ignored."));
-            return "continue";
+            (0, exports.warn)(`Parameter "${option}" is undefined and will be ignored.`);
+            continue;
         }
-        var promise = optionsMap[resource][option](options[option])
-            .then(function (o) { return params.set(option, o); })
-            .catch(function (err) {
-            throw "Malformed query parameter for resource \"".concat(resource, "\" and parameter: \"").concat(option, "\": ").concat(err, ".");
+        const promise = optionsMap[resource][option](options[option])
+            .then((o) => params.set(option, o))
+            .catch((err) => {
+            throw `Malformed query parameter for resource "${resource}" and parameter: "${option}": ${err}.`;
         });
         paramsPromises.push(promise);
-    };
-    for (var option in options) {
-        _loop_1(option);
     }
-    return Promise.all(paramsPromises).then(function () { return params; });
+    return Promise.all(paramsPromises).then(() => params);
 };
 exports.queryOptionsValidator = queryOptionsValidator;
-var warn = function (msg) { return console.warn("[RLL Client]: ".concat(msg)); };
+const warn = (msg) => console.warn(`[RLL Client]: ${msg}`);
 exports.warn = warn;
-var error = function (msg, type) {
-    if (type === void 0) { type = "error"; }
+const error = (msg, type = "error") => {
     switch (type) {
         case "error": {
-            throw new Error("[RLL Client]: ".concat(msg));
+            throw new Error(`[RLL Client]: ${msg}`);
         }
         case "type": {
-            throw new TypeError("[RLL Client]: ".concat(msg));
+            throw new TypeError(`[RLL Client]: ${msg}`);
         }
         case "range": {
-            throw new RangeError("[RLL Client]: ".concat(msg));
+            throw new RangeError(`[RLL Client]: ${msg}`);
         }
     }
 };
 exports.error = error;
-//# sourceMappingURL=utils.js.map

package/lib/esm/Client.js

@@ -0,0 +1,208 @@
+import { RLLEndPoint, } from "./types/application";
+import { fetcher } from "./fetcher";
+import { apiKeyValidator, optionsValidator, queryOptionsValidator, } from "./utils";
+/**
+ * Class representing a RocketLaunch.Live client
+ * @class
+ */
+export class RLLClient {
+    apiKey;
+    config = {
+        keyInQueryParams: false,
+    };
+    /**
+     * 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) {
+        // Validate API Key is a valid UUID format
+        // Constructor throws if not
+        apiKeyValidator(apiKey);
+        this.apiKey = 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);
+    }
+    /**
+     * 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 = client.companies({ country_code: "US" })
+     */
+    companies(options) {
+        return queryOptionsValidator(RLLEndPoint.COMPANIES, options).then((params) => 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
+     *
+     * @returns {Promise<RLLResponse<RLLEntity.Launch[]>>} Array of companies wrapped in a standard RLL Response
+     *
+     * @example
+     *
+     * const response = client.launches({ after_date: new Date("2022-10-10") })
+     */
+    launches(options) {
+        return queryOptionsValidator(RLLEndPoint.LAUNCHES, options).then((params) => 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 = client.locations({ country_code: "US" })
+     */
+    locations(options) {
+        return queryOptionsValidator(RLLEndPoint.LOCATIONS, options).then((params) => 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 = client.missions({ name: "Mars 2020" })
+     */
+    missions(options) {
+        return queryOptionsValidator(RLLEndPoint.MISSIONS, options).then((params) => 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 = client.pads({ country_code: "US" })
+     */
+    pads(options) {
+        return queryOptionsValidator(RLLEndPoint.PADS, options).then((params) => 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 = client.tags({ text: "Crewed" })
+     */
+    tags(options) {
+        return queryOptionsValidator(RLLEndPoint.TAGS, options).then((params) => 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 = client.vehicles({ name: "Falcon 9" })
+     */
+    vehicles(options) {
+        return queryOptionsValidator(RLLEndPoint.VEHICLES, options).then((params) => this.query(RLLEndPoint.VEHICLES, params));
+    }
+}

package/lib/esm/fetcher.js

@@ -0,0 +1,39 @@
+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", () => {
+                if (res.statusCode === 200) {
+                    const 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);
+    });
+};