rocket-launch-live-client 0.1.0 → 0.1.1

package/dist/Client.d.ts

@@ -1,7 +1,19 @@
 import { RLLClientOptions, RLLEntity, RLLQueryConfig, RLLResponse } from "./types/application";
+/**
+ * Class representing a RocketLaunch.Live client
+ * @class
+ */
 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

package/dist/Client.js

@@ -3,7 +3,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var application_1 = require("./types/application");
 var fetcher_1 = require("./fetcher");
 var utils_1 = require("./utils");
+/**
+ * Class representing a RocketLaunch.Live client
+ * @class
+ */
 var RLLClient = /** @class */ (function () {
+    /**
+     * 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)
+     *
+     */
     function RLLClient(apiKey, options) {
         this.config = {
             keyInQueryParams: false,

package/dist/Client.js.map

@@ -1 +1 @@
-{"version":3,"file":"Client.js","sourceRoot":"","sources":["../src/Client.ts"],"names":[],"mappings":";;AAAA,mDAM6B;AAC7B,qCAAoC;AACpC,iCAIiB;AAEjB;IAME,mBAAY,MAAc,EAAE,OAA0B;QAJ9C,WAAM,GAAG;YACf,gBAAgB,EAAE,KAAK;SACxB,CAAC;QAGA,0CAA0C;QAC1C,4BAA4B;QAC5B,IAAA,uBAAe,EAAC,MAAM,CAAC,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO;SACR;QAED,2CAA2C;QAC3C,IAAA,wBAAgB,EAAC,OAAO,CAAC,CAAC;QAE1B,IAAI,OAAO,CAAC,gBAAgB,EAAE;YAC5B,IAAI,CAAC,MAAM,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;SACzD;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACK,yBAAK,GAAb,UAAiB,QAAgB,EAAE,MAAuB;QACxD,OAAO,IAAA,iBAAO,EACZ,IAAI,CAAC,MAAM,EACX,QAAQ,EACR,MAAM,EACN,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAC7B,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,6BAAS,GAAhB,UACE,OAAkC;QADpC,iBAUC;QAPC,OAAO,IAAA,6BAAqB,EAAC,yBAAW,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,IAAI,CAC/D,UAAC,MAAM;YACL,OAAA,KAAI,CAAC,KAAK,CACR,yBAAW,CAAC,SAAS,EACrB,MAAM,CACP;QAHD,CAGC,CACJ,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,4BAAQ,GAAf,UACE,OAAiC;QADnC,iBAMC;QAHC,OAAO,IAAA,6BAAqB,EAAC,yBAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,UAAC,MAAM;YACtE,OAAA,KAAI,CAAC,KAAK,CAAkC,yBAAW,CAAC,QAAQ,EAAE,MAAM,CAAC;QAAzE,CAAyE,CAC1E,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,6BAAS,GAAhB,UACE,OAAkC;QADpC,iBAUC;QAPC,OAAO,IAAA,6BAAqB,EAAC,yBAAW,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,IAAI,CAC/D,UAAC,MAAM;YACL,OAAA,KAAI,CAAC,KAAK,CACR,yBAAW,CAAC,SAAS,EACrB,MAAM,CACP;QAHD,CAGC,CACJ,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,4BAAQ,GAAf,UACE,OAAiC;QADnC,iBAMC;QAHC,OAAO,IAAA,6BAAqB,EAAC,yBAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,UAAC,MAAM;YACtE,OAAA,KAAI,CAAC,KAAK,CAAmC,yBAAW,CAAC,QAAQ,EAAE,MAAM,CAAC;QAA1E,CAA0E,CAC3E,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,wBAAI,GAAX,UACE,OAA6B;QAD/B,iBAMC;QAHC,OAAO,IAAA,6BAAqB,EAAC,yBAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,UAAC,MAAM;YAClE,OAAA,KAAI,CAAC,KAAK,CAA+B,yBAAW,CAAC,IAAI,EAAE,MAAM,CAAC;QAAlE,CAAkE,CACnE,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,wBAAI,GAAX,UACE,OAA6B;QAD/B,iBAMC;QAHC,OAAO,IAAA,6BAAqB,EAAC,yBAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,UAAC,MAAM;YAClE,OAAA,KAAI,CAAC,KAAK,CAA+B,yBAAW,CAAC,IAAI,EAAE,MAAM,CAAC;QAAlE,CAAkE,CACnE,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,4BAAQ,GAAf,UACE,OAAiC;QADnC,iBAMC;QAHC,OAAO,IAAA,6BAAqB,EAAC,yBAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,UAAC,MAAM;YACtE,OAAA,KAAI,CAAC,KAAK,CAAmC,yBAAW,CAAC,QAAQ,EAAE,MAAM,CAAC;QAA1E,CAA0E,CAC3E,CAAC;IACJ,CAAC;IACH,gBAAC;AAAD,CAAC,AArPD,IAqPC;AAED,kBAAe,SAAS,CAAC"}
+{"version":3,"file":"Client.js","sourceRoot":"","sources":["../src/Client.ts"],"names":[],"mappings":";;AAAA,mDAM6B;AAC7B,qCAAoC;AACpC,iCAIiB;AAEjB;;;GAGG;AACH;IAME;;;;;;;OAOG;IACH,mBAAY,MAAc,EAAE,OAA0B;QAZ9C,WAAM,GAAG;YACf,gBAAgB,EAAE,KAAK;SACxB,CAAC;QAWA,0CAA0C;QAC1C,4BAA4B;QAC5B,IAAA,uBAAe,EAAC,MAAM,CAAC,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QAErB,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO;SACR;QAED,2CAA2C;QAC3C,IAAA,wBAAgB,EAAC,OAAO,CAAC,CAAC;QAE1B,IAAI,OAAO,CAAC,gBAAgB,EAAE;YAC5B,IAAI,CAAC,MAAM,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;SACzD;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACK,yBAAK,GAAb,UAAiB,QAAgB,EAAE,MAAuB;QACxD,OAAO,IAAA,iBAAO,EACZ,IAAI,CAAC,MAAM,EACX,QAAQ,EACR,MAAM,EACN,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAC7B,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,6BAAS,GAAhB,UACE,OAAkC;QADpC,iBAUC;QAPC,OAAO,IAAA,6BAAqB,EAAC,yBAAW,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,IAAI,CAC/D,UAAC,MAAM;YACL,OAAA,KAAI,CAAC,KAAK,CACR,yBAAW,CAAC,SAAS,EACrB,MAAM,CACP;QAHD,CAGC,CACJ,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,4BAAQ,GAAf,UACE,OAAiC;QADnC,iBAMC;QAHC,OAAO,IAAA,6BAAqB,EAAC,yBAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,UAAC,MAAM;YACtE,OAAA,KAAI,CAAC,KAAK,CAAkC,yBAAW,CAAC,QAAQ,EAAE,MAAM,CAAC;QAAzE,CAAyE,CAC1E,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,6BAAS,GAAhB,UACE,OAAkC;QADpC,iBAUC;QAPC,OAAO,IAAA,6BAAqB,EAAC,yBAAW,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,IAAI,CAC/D,UAAC,MAAM;YACL,OAAA,KAAI,CAAC,KAAK,CACR,yBAAW,CAAC,SAAS,EACrB,MAAM,CACP;QAHD,CAGC,CACJ,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,4BAAQ,GAAf,UACE,OAAiC;QADnC,iBAMC;QAHC,OAAO,IAAA,6BAAqB,EAAC,yBAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,UAAC,MAAM;YACtE,OAAA,KAAI,CAAC,KAAK,CAAmC,yBAAW,CAAC,QAAQ,EAAE,MAAM,CAAC;QAA1E,CAA0E,CAC3E,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,wBAAI,GAAX,UACE,OAA6B;QAD/B,iBAMC;QAHC,OAAO,IAAA,6BAAqB,EAAC,yBAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,UAAC,MAAM;YAClE,OAAA,KAAI,CAAC,KAAK,CAA+B,yBAAW,CAAC,IAAI,EAAE,MAAM,CAAC;QAAlE,CAAkE,CACnE,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,wBAAI,GAAX,UACE,OAA6B;QAD/B,iBAMC;QAHC,OAAO,IAAA,6BAAqB,EAAC,yBAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,UAAC,MAAM;YAClE,OAAA,KAAI,CAAC,KAAK,CAA+B,yBAAW,CAAC,IAAI,EAAE,MAAM,CAAC;QAAlE,CAAkE,CACnE,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,4BAAQ,GAAf,UACE,OAAiC;QADnC,iBAMC;QAHC,OAAO,IAAA,6BAAqB,EAAC,yBAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,UAAC,MAAM;YACtE,OAAA,KAAI,CAAC,KAAK,CAAmC,yBAAW,CAAC,QAAQ,EAAE,MAAM,CAAC;QAA1E,CAA0E,CAC3E,CAAC;IACJ,CAAC;IACH,gBAAC;AAAD,CAAC,AA7PD,IA6PC;AAED,kBAAe,SAAS,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rocket-launch-live-client",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A Node.JS client for interacting with the RocketLaunch.Live API",
   "main": "dist/index.js",
   "scripts": {

package/tsconfig.json

@@ -7,5 +7,5 @@
     "declaration": true
   },
   "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
+  "exclude": ["node_modules", "dist", "src/test.ts"]
 }

package/src/Client.ts

@@ -1,262 +0,0 @@
-import {
-  RLLClientOptions,
-  RLLEndPoint,
-  RLLEntity,
-  RLLQueryConfig,
-  RLLResponse,
-} from "./types/application";
-import { fetcher } from "./fetcher";
-import {
-  apiKeyValidator,
-  optionsValidator,
-  queryOptionsValidator,
-} from "./utils";
-
-class RLLClient {
-  private apiKey: string;
-  private config = {
-    keyInQueryParams: false,
-  };
-
-  constructor(apiKey: string, options?: RLLClientOptions) {
-    // 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>}
-   */
-  private query<T>(endpoint: string, params: URLSearchParams): Promise<T> {
-    return fetcher<T>(
-      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" })
-   */
-  public companies(
-    options?: RLLQueryConfig.Companies
-  ): Promise<RLLResponse<RLLEntity.Company[]>> {
-    return queryOptionsValidator(RLLEndPoint.COMPANIES, options).then(
-      (params) =>
-        this.query<RLLResponse<RLLEntity.Company[]>>(
-          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") })
-   */
-  public launches(
-    options?: RLLQueryConfig.Launches
-  ): Promise<RLLResponse<RLLEntity.Launch[]>> {
-    return queryOptionsValidator(RLLEndPoint.LAUNCHES, options).then((params) =>
-      this.query<RLLResponse<RLLEntity.Launch[]>>(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" })
-   */
-  public locations(
-    options?: RLLQueryConfig.Locations
-  ): Promise<RLLResponse<RLLEntity.Location[]>> {
-    return queryOptionsValidator(RLLEndPoint.LOCATIONS, options).then(
-      (params) =>
-        this.query<RLLResponse<RLLEntity.Location[]>>(
-          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" })
-   */
-  public missions(
-    options?: RLLQueryConfig.Missions
-  ): Promise<RLLResponse<RLLEntity.Mission[]>> {
-    return queryOptionsValidator(RLLEndPoint.MISSIONS, options).then((params) =>
-      this.query<RLLResponse<RLLEntity.Mission[]>>(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" })
-   */
-  public pads(
-    options?: RLLQueryConfig.Pads
-  ): Promise<RLLResponse<RLLEntity.Pad[]>> {
-    return queryOptionsValidator(RLLEndPoint.PADS, options).then((params) =>
-      this.query<RLLResponse<RLLEntity.Pad[]>>(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" })
-   */
-  public tags(
-    options?: RLLQueryConfig.Tags
-  ): Promise<RLLResponse<RLLEntity.Tag[]>> {
-    return queryOptionsValidator(RLLEndPoint.TAGS, options).then((params) =>
-      this.query<RLLResponse<RLLEntity.Tag[]>>(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" })
-   */
-  public vehicles(
-    options?: RLLQueryConfig.Vehicles
-  ): Promise<RLLResponse<RLLEntity.Vehicle[]>> {
-    return queryOptionsValidator(RLLEndPoint.VEHICLES, options).then((params) =>
-      this.query<RLLResponse<RLLEntity.Vehicle[]>>(RLLEndPoint.VEHICLES, params)
-    );
-  }
-}
-
-export default RLLClient;

package/src/fetcher.ts

@@ -1,50 +0,0 @@
-const https = require("node:https");
-
-const BASE_URL = "https://fdo.rocketlaunch.live";
-
-export const fetcher = <T>(
-  apiKey: string,
-  endpoint: string,
-  params: URLSearchParams,
-  keyInQueryParams: boolean
-): Promise<T> => {
-  const url = new URL("json/" + endpoint, BASE_URL);
-  let headers: HeadersInit | undefined;
-
-  if (keyInQueryParams) {
-    params.set("key", apiKey);
-  } else {
-    headers = { authorization: `Bearer ${apiKey}` };
-  }
-
-  params.forEach((v, k) => url.searchParams.set(k, v));
-
-  return query<T>(url, headers);
-};
-
-const query = <T>(url: URL, headers?: HeadersInit): Promise<T> => {
-  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);
-  });
-};

package/src/index.ts

@@ -1,29 +0,0 @@
-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 })
- */
-const clientGenerator = (
-  apiKey: string,
-  options?: RLLClientOptions
-): RLLClient => {
-  return new RLLClient(apiKey, options);
-};
-
-export default clientGenerator;

package/src/types/application.ts

@@ -1,193 +0,0 @@
-import { ISO3166Alpha2 } from "./standards";
-
-export enum RLLEndPoint {
-  COMPANIES = "companies",
-  LAUNCHES = "launches",
-  LOCATIONS = "locations",
-  MISSIONS = "missions",
-  PADS = "pads",
-  TAGS = "tags",
-  VEHICLES = "vehicles",
-}
-
-interface RLLRecord {
-  id: number;
-}
-
-export 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; // original API had a typo which was preserved for backwards compatibility
-    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">;
-  }
-}
-
-interface RLLBaseQueryConfig {
-  id?: number | string;
-  page?: number | string;
-}
-
-export namespace RLLQueryConfig {
-  export interface Companies extends RLLBaseQueryConfig {
-    name?: string | number;
-    country_code?: ISO3166Alpha2.CountryCode;
-    inactive?: boolean;
-  }
-
-  export 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;
-  }
-
-  export interface Locations extends RLLBaseQueryConfig {
-    name?: string | number;
-    state_abbr?: ISO3166Alpha2.StateCodeUS;
-    country_code?: ISO3166Alpha2.CountryCode;
-  }
-
-  export interface Missions extends RLLBaseQueryConfig {
-    name?: string | number;
-  }
-
-  export interface Pads extends RLLBaseQueryConfig {
-    name?: string | number;
-    state_abbr?: ISO3166Alpha2.StateCodeUS;
-    country_code?: ISO3166Alpha2.CountryCode;
-  }
-
-  export interface Tags extends RLLBaseQueryConfig {
-    text?: string | number;
-  }
-
-  export interface Vehicles extends RLLBaseQueryConfig {
-    name?: string | number;
-  }
-
-  export 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;
-};

package/src/types/standards.ts

@@ -1,317 +0,0 @@
-export const 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",
-};
-
-export const 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",
-};
-
-export namespace ISO3166Alpha2 {
-  export type CountryCode = keyof typeof countryCodes;
-
-  export type StateCodeUS = keyof typeof usStateCodes;
-}

package/src/utils.ts

@@ -1,294 +0,0 @@
-import { RLLEndPoint, RLLQueryConfig } from "./types/application";
-import { countryCodes, usStateCodes } from "./types/standards";
-
-const getLeadingZero = (month: number, offset: number = 0): string => {
-  const str = "0".concat((month + offset).toString());
-  return str.slice(-2);
-};
-
-export const apiKeyValidator = (apiKey: any): void => {
-  if (apiKey === undefined) {
-    error("RLL Client requires API Key", "type");
-  }
-
-  if (typeof apiKey !== "string") {
-    error("RLL Client API Key must be a string", "type");
-  }
-
-  if (apiKey === "") {
-    error("RLL Client API Key cannot be an empty string", "type");
-  }
-
-  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) {
-    error(
-      "RLL Client API Key appears malformed. RLL Client API Keys are in UUID format.",
-      "type"
-    );
-  }
-};
-
-export const optionsValidator = (options: {}): void => {
-  for (const option in options) {
-    if (option !== "keyInQueryParams") {
-      warn(
-        `RLL Client options do not accept a "${option}" property. This property will be ignored.`
-      );
-    } else {
-      if (typeof options[option] !== "boolean") {
-        error(
-          "RLL Client configuration option 'keyInQueryParams' must be a boolean.",
-          "type"
-        );
-      }
-    }
-  }
-};
-
-const validators = {
-  string: (option: any): Promise<string> => {
-    return new Promise((resolve, reject) => {
-      if (typeof option === "number") {
-        resolve(option.toString());
-      }
-      if (typeof option !== "string") {
-        return reject("Must be a string");
-      }
-      if (option.length <= 0) {
-        return reject("String must have length greater than 0");
-      }
-      resolve(option);
-    });
-  },
-  boolean: (option: any): Promise<number> => {
-    return new Promise((resolve, reject) => {
-      if (typeof option !== "boolean") {
-        return reject("Must be a boolean");
-      }
-      resolve(option === true ? 1 : 0);
-    });
-  },
-  number: (option: any): Promise<number> => {
-    return new Promise((resolve, reject) => {
-      if (typeof option === "number") {
-        return resolve(option);
-      }
-      if (
-        typeof option !== "string" ||
-        option === "" ||
-        isNaN(Number(option))
-      ) {
-        return reject("Must be a number");
-      } else {
-        resolve(Number(option));
-      }
-    });
-  },
-  countryCode: (option: any): Promise<string> => {
-    return new Promise((resolve, reject) => {
-      if (typeof option !== "string") {
-        return reject("Must be a string");
-      }
-      if (!countryCodes[option]) {
-        return reject(
-          "Invalid country code. Country codes should follow ISO 3166-1 A2 convention, like 'US'."
-        );
-      }
-      resolve(option);
-    });
-  },
-  stateCode: (option: any): Promise<string> => {
-    return new Promise((resolve, reject) => {
-      if (typeof option !== "string") {
-        return reject("Must be a string");
-      }
-      if (!usStateCodes[option]) {
-        return reject(
-          "Invalid United States State Code. State Codes should follow ISO 3166-2 convention, like 'FL'."
-        );
-      }
-      resolve(option);
-    });
-  },
-  cosparId: (option: any): Promise<string> => {
-    return new Promise((resolve, reject) => {
-      if (typeof option !== "string") {
-        return reject("Must be a string");
-      }
-      if (!option.match(/^\d{4}\-\d{3}$/g)) {
-        return reject(
-          "Cospar IDs must be in the format of YYYY-NNN (eg. 2023-123)"
-        );
-      }
-      resolve(option);
-    });
-  },
-  shortDate: (option: any): Promise<string> => {
-    return new Promise((resolve, reject) => {
-      if (typeof option === "string" || option instanceof Date) {
-        let date: Date;
-
-        if (typeof option === "string") {
-          const parsed = Date.parse(option);
-          if (isNaN(parsed)) {
-            return reject("Must be an ISO 8601 Date String");
-          }
-          date = new Date(parsed);
-        } else {
-          date = option;
-        }
-
-        resolve(
-          `${date.getUTCFullYear()}-${getLeadingZero(
-            date.getUTCMonth(),
-            1
-          )}-${getLeadingZero(date.getUTCDate())}`
-        );
-      }
-      return reject("Must be a JavaScript Date Object or ISO 8601 Date String");
-    });
-  },
-  isoDate: (option: any): Promise<string> => {
-    return new Promise((resolve, reject) => {
-      if (typeof option === "string" || option instanceof Date) {
-        let date: Date;
-
-        if (typeof option === "string") {
-          const parsed = Date.parse(option);
-          if (isNaN(parsed)) {
-            return reject("Must be an ISO 8601 Date String");
-          }
-          date = new Date(parsed);
-        } else {
-          date = option;
-        }
-
-        resolve(date.toISOString().slice(0, 19).concat("Z"));
-      }
-      return reject("Must be a JavaScript Date Object or ISO 8601 Date String");
-    });
-  },
-};
-
-const optionsMap = {
-  companies: {
-    page: validators.number,
-    id: validators.number,
-    name: validators.string,
-    country_code: validators.countryCode,
-    inactive: validators.boolean,
-  },
-  launches: {
-    page: validators.number,
-    id: validators.number,
-    cospar_id: validators.cosparId,
-    after_date: validators.shortDate,
-    before_date: validators.shortDate,
-    modified_since: validators.isoDate,
-    location_id: validators.number,
-    pad_id: validators.number,
-    provider_id: validators.number,
-    tag_id: validators.number,
-    vehicle_id: validators.number,
-    state_abbr: validators.stateCode,
-    country_code: validators.countryCode,
-    search: validators.string,
-    slug: validators.string,
-  },
-  locations: {
-    page: validators.number,
-    id: validators.number,
-    name: validators.string,
-    state_abbr: validators.stateCode,
-    country_code: validators.countryCode,
-  },
-  missions: {
-    page: validators.number,
-    id: validators.number,
-    name: validators.string,
-  },
-  pads: {
-    page: validators.number,
-    id: validators.number,
-    name: validators.string,
-    state_abbr: validators.stateCode,
-    country_code: validators.countryCode,
-  },
-  tags: {
-    page: validators.number,
-    id: validators.number,
-    text: validators.string,
-  },
-  vehicles: {
-    page: validators.number,
-    id: validators.number,
-    name: validators.string,
-  },
-};
-
-export const queryOptionsValidator = (
-  resource: RLLEndPoint,
-  options?: RLLQueryConfig.All
-): Promise<URLSearchParams> => {
-  const params = new URLSearchParams();
-  const paramsPromises = [];
-
-  if (!options) {
-    return Promise.resolve(params);
-  }
-
-  if (
-    (options.id || options.slug || options.cospar_id) &&
-    Object.keys(options).length > 1
-  ) {
-    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."
-    );
-  }
-
-  for (const option in options) {
-    if (!optionsMap[resource][option]) {
-      warn(
-        `Parameter "${option}" is not a valid option for the ${resource} endpoint. It will be ignored.`
-      );
-      continue;
-    }
-
-    if (options[option] === undefined) {
-      warn(`Parameter "${option}" is undefined and will be ignored.`);
-      continue;
-    }
-
-    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);
-  }
-
-  return Promise.all(paramsPromises).then(() => params);
-};
-
-export const warn = (msg: string) => console.warn(`[RLL Client]: ${msg}`);
-
-export const error = (
-  msg: string,
-  type: "type" | "range" | "error" = "error"
-) => {
-  switch (type) {
-    case "error": {
-      throw new Error(`[RLL Client]: ${msg}`);
-    }
-    case "type": {
-      throw new TypeError(`[RLL Client]: ${msg}`);
-    }
-    case "range": {
-      throw new RangeError(`[RLL Client]: ${msg}`);
-    }
-  }
-};