thrustcurve-db 0.3.13 → 1.0.1

package/README.md

@@ -3,63 +3,69 @@
 ThrustCurve.org model rocket motor data as a static data structure (plus misc.
 utility functions).
 
-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 a motor has more than one thrust sample file the first "cert"(ified) file found is used, otherwise the samples are from whichever file the API returned first.  (This typically isn't an issue since most thrust curves are very similar, but there are some cases where they differ significantly).
+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**
+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):
 
-* 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.
+* `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).
 
-## Installation
 
-You know the drill ...
+## Installation
 
 ```
 npm i thrustcurve-db
 ```
 
+... or with `yarn`:
+```
+yarn add thrustcurve-db
+```
+
 ## Usage
 
+ES Modules
+
 ```js
-import MOTORS, {parseDelays, unparseDelays} from 'thrustcurve-db';
-
-// `MOTORS` is a Motor[] array.
-
-for (const motor of MOTORS) {
-  // See `thrustcurve-db.d.ts` for Motor structure details.
-  console.log(motor); // Spew data for ~1,100 motors to console
-}
-
-// parseDelays() parses a motor `delays` value to determine the
-// delay options. The returned Object has the following properties:
-//
-//    times: Number[] array of possible delay times (seconds)
-//  plugged: true if motor has a "Plugged" configuration
-//
-// Aerotech delays (S, M, L, X) are transformed as follows:
-// S -> 0-6
-// M -> 0-10
-// L -> 0-14
-// X -> 0-18
-//
-// Note: `times` are guaranteed to be unique and in ascending order.
-// E.g.  `parseDelays('L, S')` and `parseDelays('1, 5, M, L')` will
-// produce the same result.
-
-parseDelays('S, 16, P'); // -> {
-                         //   times: [0,1,2,3,4,5,6,16],
-                         //   plugged: true
-                         // }
-
-// unparseDelays(parsed) is the inverse operation of parseDelays() (sort of).
-
-unparseDelays({
-  times: [0,1,2,3,4,5,6,16],
-  plugged: true
-}); // -> "0-6,16,P"
+import MOTORS from 'thrustcurve-db';
 ```
+
+... or for CommonJS:
+```js
+const MOTORS = require('thrustcurve-db');
+```
+
+... or for CommonJS w/ `import()` (NodeJS):
+
+Note: At present this requires you run `node` with the  `--experimental-json-modules` flag
+
+```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());
+```
+
+## Example
+
+After importing (above)...
+
+```js
+// Find all J motors currently in production
+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/index.js

@@ -1,5 +1 @@
-// Should be able to do `export default from './thrustcurve-db.json'` from
-// here, right?
-import MOTORS from './thrustcurve-db.json';
-export default MOTORS;
-export * from './util.js'
+export {default} from './thrustcurve-db.json';

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "thrustcurve-db",
-  "version": "0.3.13",
+  "version": "1.0.1",
   "type": "module",
   "description": "ThrustCurve.org model rocket motor and thrust curve data as a single JSON file",
-  "main": "./index.js",
+  "exports": {
+    "import": "./index.js",
+    "require": "./index.cjs"
+  },
   "types": "thrustcurve-db.d.ts",
   "files": [
     "index.js",

package/thrustcurve-db.d.ts

@@ -1,16 +1,7 @@
 type ThrustPoint = [number, number];
 
-type Samples = ThrustPoint[];
-
-type ParsedDelays = {
-  times: Number[],
-  plugged: Boolean
-};
-
-export function parseDelays(string) : ParsedDelays;
-export function unparseDelays(ParsedDelays) : string;
-
 export declare type Motor = {
+    availability :  'regular' | 'OOP';
     avgThrustN :  number;
     burnTimeS :  number;
     certOrg :  string;
@@ -19,8 +10,7 @@ export declare type Motor = {
     delays :  string;
     designation :  string;
     diameter :  number;
-    discontinued ?:  boolean;
-    impulseClass :  string;
+    impulseClass :  'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O';
     infoUrl :  string;
     length :  number;
     manufacturer :  string;
@@ -29,11 +19,11 @@ export declare type Motor = {
     motorId :  string;
     propInfo :  string;
     propWeightG :  number;
-    samples ?:  Samples;
+    samples ?:  ThrustPoint[];
     sparky ?:  boolean;
     totImpulseNs :  number;
     totalWeightG :  number;
-    type :  string;
+    type :  'SU' | 'hybrid' | 'reload';
     updatedOn :  string;
 }