thrustcurve-db 1.0.2 → 2.0.0

package/README.md

@@ -1,71 +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 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.
+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.
 
-The format of this data is identical to that of the TC [/api/v1/search response](https://github.com/JohnCoker/thrustcurve3/blob/8bd8571fe0791fb9a68a6a96eb36c276d58c339b/config/api_v1.yml#L428-L526), with one additional field (where available):
+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).
 
-* `samples`: `Array[[number, number]]` of thrust`samples`. This is the `samples` data from the TC "/api/vi/download" endpoint 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.
-
-See also, the included [TypeScript definition`](./thrustcurve.d.ts).
+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.
 
+See also, the included [TypeScript definition](./thrustcurve.d.ts).
 
 ## Installation
 
 ```
 npm i thrustcurve-db
-```
-
-... or with `yarn`:
-```
 yarn add thrustcurve-db
 ```
 
 ## Usage
 
-ES Modules
-
-```js
-import MOTORS from 'thrustcurve-db';
-```
+### Import with ESM or CommonJS:
 
-... or for CommonJS:
 ```js
-const MOTORS = require('thrustcurve-db');
+import MOTORS from "thrustcurve-db"; // ESM
+const MOTORS = require("thrustcurve-db"); // CommonJS
 ```
 
-... or for 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');
-```
-
-... or to fetch from jsDelvr CDN:
-
-```js
-const MOTORS = await fetch('https://cdn.jsdelivr.net/npm/thrustcurve-db@latest/thrustcurve-db.json')
-  .then(res => res.json());
+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
+## 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
+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.2",
+  "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 :  '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;
-}
+  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;