thrustcurve-db 1.0.0 → 2.0.0

package/README.md

@@ -1,59 +1,49 @@
 # thrustcurve-db
 
-ThrustCurve.org model rocket motor data as a static data structure (plus misc.
-utility functions).
+ThrustCurve.org model rocket motor data as a single JSON file.
 
-This module is a rebundling of the rocket motor data available on John Coker's
-[thrustcurve.org](https://thrustcurve.org) website ("TC").  The dataset includes data for all motors in the [ThrustCurve API](https://www.thrustcurve.org/info/api.html) ("search" endpoint), and is a field-by-field translation of what is found in the "search" endpoint, with the following changes:
-* Motor "availability" is exposed as the `discontinued` field (see https://github.com/JohnCoker/thrustcurve3/issues/35)
-* Where available, thrust curve data (from the "download" endpoint) is included as a `samples` array.  These are normalized to always have `[0, 0]` as the first data point.  In cases where more than one sample file is available for a motor, the first "cert"(ified) file found is used.  Otherwise the samples are from whichever file the API return first.
+This module is a rebundling of the model rocket motor data found at John Coker's [thrustcurve.org](https://thrustcurve.org) website ("TC"). It is available here in JSON format, or as an ESM or CommonJS module.
 
-**License & Support**
+Data is pulled from the TC [/api/v1/search response](https://github.com/JohnCoker/thrustcurve3/blob/8bd8571fe0791fb9a68a6a96eb36c276d58c339b/config/api_v1.yml#L428-L526) API.  For brevity, not all fields are included in the dataset here, however they can be added if requested. (Just file an issue).
 
-* Please read and understand [the ThrustCurve.org license](https://www.thrustcurve.org/info/contribute.html#license)
-* This is a *snapshot* of the TC data.  It may be out of date.  File an issue here if you think it needs to be updated.
-* Issues with how motor data is translated into JSON should be filed here.
-* Issues with incorrect motor data should be directed to the TC site.
+There is one additional field, `samples`, which is the actual thrust data as provided by the TC "/api/vi/download" endpoint. This is normalized to always have `[0, 0]` as the first data point.  In cases where more than one sample file is available for a motor, the first "cert"(ified) data file is used. Otherwise it will be whichever data file the API returns first.
 
-## Installation
+See also, the included [TypeScript definition](./thrustcurve.d.ts).
 
-### NPM
+## Installation
 
 ```
 npm i thrustcurve-db
-```
-
-### Yarn
-```
 yarn add thrustcurve-db
 ```
 
 ## Usage
 
-### ES Modules
+### Import with ESM or CommonJS:
 
 ```js
-import MOTORS from 'thrustcurve-db';
+import MOTORS from "thrustcurve-db"; // ESM
+const MOTORS = require("thrustcurve-db"); // CommonJS
 ```
 
-### CommonJS
-```js
-const MOTORS = require('thrustcurve-db');
-```
-
-### CommonJS w/ `import()` (NodeJS)
+Note: At present this requires you run `node` with the `--experimental-json-modules` flag
 
-Note: At present this requires you run `node` with the  `--experimental-json-modules` flag
+### Fetch from JSDelivr CDN:
 
 ```js
-const MOTORS = await import('thrustcurve-db');
+const MOTORS = await fetch(
+  "https://cdn.jsdelivr.net/npm/thrustcurve-db@latest/thrustcurve-db.json"
+).then(res => res.json());
 ```
 
 ## Example
 
-After importing (above)...
-
 ```js
 // Find all J motors currently in production
-MOTORS.filter(m => m.availability === 'regular' && m.impulseClass === 'J');
+MOTORS.filter(m => m.availability === "regular" && m.impulseClass === "J");
 ```
+
+## Issues & Contributions
+
+The data provided here is sourced from thrustcurve.org. Omissions and errors in rocket data should be directed there. Any systematic problems or suggestions for how the data here is presented may be [reported
+here](https://github.com/broofa/thrustcurve-db/issues).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "thrustcurve-db",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "type": "module",
   "description": "ThrustCurve.org model rocket motor and thrust curve data as a single JSON file",
   "exports": {
@@ -15,8 +15,8 @@
     "thrustcurve-db.d.ts"
   ],
   "scripts": {
-    "prepare": "node build/build.js > thrustcurve-db.json",
-    "test": "node --experimental-json-modules build/test.js && exit 1"
+    "prepare": "build/build.js > thrustcurve-db.json",
+    "test": "echo \"no tests\" && exit 1"
   },
   "repository": {
     "type": "git",

package/thrustcurve-db.d.ts

@@ -1,31 +1,49 @@
-type ThrustPoint = [number, number];
+type ThrustPoint = [
+  number, // time (seconds)
+  number  // thrust (Newtons)
+];
 
 export declare type Motor = {
-    availability :  'regular' | 'OOP';
-    avgThrustN :  number;
-    burnTimeS :  number;
-    certOrg :  string;
-    commonName :  string;
-    dataFiles :  number;
-    delays :  string;
-    designation :  string;
-    diameter :  number;
-    impulseClass :  string;
-    infoUrl :  string;
-    length :  number;
-    manufacturer :  string;
-    manufacturerAbbrev :  string;
-    maxThrustN :  number;
-    motorId :  string;
-    propInfo :  string;
-    propWeightG :  number;
-    samples ?:  ThrustPoint[];
-    sparky ?:  boolean;
-    totImpulseNs :  number;
-    totalWeightG :  number;
-    type :  string;
-    updatedOn :  string;
-}
+  availability: "regular" | "OOP";
+  avgThrustN: number;
+  burnTimeS: number;
+  certOrg: string;
+  commonName: string;
+  dataFiles: number;
+  delays: string;
+  designation: string;
+  diameter: number;
+  impulseClass:
+    | "A"
+    | "B"
+    | "C"
+    | "D"
+    | "E"
+    | "F"
+    | "G"
+    | "H"
+    | "I"
+    | "J"
+    | "K"
+    | "L"
+    | "M"
+    | "N"
+    | "O";
+  infoUrl: string;
+  length: number;
+  manufacturer: string;
+  manufacturerAbbrev: string;
+  maxThrustN: number;
+  motorId: string;
+  propInfo: string;
+  propWeightG: number;
+  samples?: ThrustPoint[];
+  sparky?: boolean;
+  totImpulseNs: number;
+  totalWeightG: number;
+  type: "SU" | "hybrid" | "reload";
+  updatedOn: string;
+};
 
-declare const MOTORS : Array<Motor>;
+declare const MOTORS: Array<Motor>;
 export default MOTORS;