Merge pull request #19 from graycraft/feature/2

Feature v0.4.0-alpha

Author: graycraft

README.md

@@ -191,6 +191,14 @@ $ node response --aggregate
   Aggregated "2024-01-01T00:00:00.000Z.json" to "../collection/coinbase/currency_network_all".
 ```
 
+```bash
+$ node response --vali
+$ node response --validate
+  AJV: validation of Bybit API response snapshot 2025-02-01T23:38:48.058Z.json passed.
+  AJV: validation of Bybit API response snapshot 2025-02-01T23:38:48.532Z.json passed.
+  AJV: validation of Coinbase API response snapshot 2025-02-10T21:08:43.831Z.json passed.
+```
+
 To run a flow related to an API response, change directory:
 
 ```bash
@@ -200,15 +208,29 @@ $ cd response
 Run flow for **all responses** of a **specific API**:
 
 ```bash
-$ node bybit
+response$ node bybit --aggr
+response$ node bybit --aggregate
   Aggregated "2024-01-01T00:00:00.000Z.json" to "../collection/bybit/currency_all".
   Aggregated "2024-01-01T00:00:00.000Z.json" to "../collection/bybit/currency_network_all".
 ```
 
+```bash
+response$ node bybit --vali
+response$ node bybit --validate
+  AJV: validation of Bybit API response snapshot 2025-02-01T23:38:48.058Z.json passed.
+  AJV: validation of Bybit API response snapshot 2025-02-01T23:38:48.532Z.json passed.
+```
+
 Run **single response** aggregation (option `--aggr[egate]` is required if not enabled in settings):
 
 ```bash
-$ node bybit currencyAll --aggr
-$ node bybit currencyAll --aggregate
+response$ node bybit currencyAll --aggr
+response$ node bybit currencyAll --aggregate
   Aggregated "2024-01-01T00:00:00.000Z.json" to "../collection/bybit/currency_all".
 ```
+
+```bash
+response$ node bybit currencyAll --vali
+response$ node bybit currencyAll --validate
+  AJV: validation of Bybit API response snapshot 2025-02-01T23:38:48.058Z.json passed.
+```

library/fetch.mjs

@@ -1,6 +1,7 @@
 /**!
  * Fetch data from a REST API endpoint with parameters.
  *
+ * @typedef {import("#types/response/snapshot.d.js").default} Snapshot
  * @typedef {import("./constants.mjs").HttpStatusCode} HttpStatusCode
  * @typedef {import("./constants.mjs").HttpStatusText} HttpStatusText
  * @typedef {Object<string, string>} Dict
@@ -157,3 +158,14 @@ export const stringifyQuery = (template, data) => {
 
   return query;
 };
+
+/**
+ * Obtain JSON data from successful response snapshot.
+ * @param {Snapshot} snapshot All data from response snapshot.
+ * @returns {{}} JSON data from response snapshot.
+ */
+export const successfulJson = (snapshot) => {
+  const json = snapshot.CREATED?.json ?? snapshot.OK?.json;
+
+  return json;
+};

library/string.mjs

@@ -56,6 +56,11 @@ export const supplementary = (template, expressions) => {
   return result;
 };
 
+/**
+ * Format a string to pascal case.
+ * @param {string} string Source string in any casing.
+ * @returns {string} String formatted in pascal case.
+ */
 export const toPascalCase = (string) => {
   const result = string.replace(
     /\w+/g,

library/utility.mjs

@@ -6,10 +6,12 @@
  *   aggregate?: boolean;
  *   authentication?: boolean;
  *   debug?: boolean;
- *   exit?: string;
+ *   exit?: boolean;
  *   flow?: string;
  *   headers?: boolean;
  *   snapshot?: boolean;
+ *   throw?: boolean;
+ *   validate?: boolean;
  *   verbose?: boolean;
  * }} Options
  * @module library/utility
@@ -23,6 +25,8 @@ const OPTIONS = {
   flow: 'flow',
   head: 'headers',
   snap: 'snapshot',
+  thro: 'throw',
+  vali: 'validate',
   verb: 'verbose',
 };
 
@@ -37,6 +41,7 @@ export const obtainName = (value, dictionary) => {
 
   return name;
 };
+export const obtain = obtainName;
 
 /**
  * Parse process argument vectors from CLI to usable handler, parameters and options.
@@ -87,9 +92,12 @@ export const parseOptions = (argv) => {
           option.includes('--aggr') ||
           option.includes('--auth') ||
           option.includes('--debu') ||
+          option.includes('--exit') ||
           option.includes('--flow') ||
           option.includes('--head') ||
           option.includes('--snap') ||
+          option.includes('--thro') ||
+          option.includes('--vali') ||
           option.includes('--verb'),
       ),
     optionsExplicit = options

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "api-tools",
-  "version": "0.3.1-alpha",
+  "version": "0.4.0-alpha",
   "description": "Tools to work with a REST API and WebSockets.",
   "main": "request.js",
   "directories": {},

package.json

@@ -6,7 +6,7 @@
     "quote": "USDT"
   },
   "debug": false,
-  "enabled": ["aggregate", "parse", "snapshot", "verbose"],
+  "enabled": ["aggregate", "parse", "snapshot", "verbose", "validate"],
   "exit": false,
   "parse": [
     "BALANCE_ALL",
@@ -54,5 +54,6 @@
     "WITHDRAW_NEW",
     "WITHDRAW_ONE"
   ],
+  "validate": ["CURRENCY_ALL", "CURRENCY_NETWORK_ALL"],
   "verbose": ["ORDER_PLACE", "WITHDRAW_NEW"]
 }

preferences/bybit.json

@@ -6,7 +6,7 @@
     "quote": "USDC"
   },
   "debug": false,
-  "enabled": ["aggregate", "parse", "snapshot", "verbose"],
+  "enabled": ["aggregate", "parse", "snapshot", "verbose", "validate"],
   "exit": false,
   "parse": ["CURRENCY_ALL", "CURRENCY_ONE", "WITHDRAW_ALL"],
   "snapshot": [
@@ -37,5 +37,6 @@
     "WITHDRAW_ALL",
     "WITHDRAW_NEW"
   ],
+  "validate": ["ADDRESS_ALL", "ADDRESS_NEW", "ADDRESS_ONE", "ADDRESS_TRANSACTIONS", "CURRENCY_ALL"],
   "verbose": ["ORDER_PLACE", "WITHDRAW_NEW"]
 }

preferences/coinbase.json

@@ -16,9 +16,8 @@
 
 import { fetchData } from '#lib/fetch.mjs';
 import { obtainName } from '#lib/utility.mjs';
-
-import analyze from '../response/analyze.mjs';
-import validate from '../response/validate.mjs';
+import analyze from '#res/analyze.mjs';
+import validate from '#res/validate.mjs';
 
 /**
  * Analyze, validate, parse and snapshot response data.
@@ -40,7 +39,7 @@ const request = async (method, api, url, template, headers, schema, callback, da
     { json } = response,
     { jsonParsed, statusText } = responseParsed,
     { isKnown, isSaved, isSuccessful } = analyze(api, responseParsed),
-    isValid = validate(response.json, schema);
+    isValid = validate(response.json, schema, api.name);
 
   global.apiTools.output[statusText] = {
     headers: response.headers,

request/index.mjs

@@ -20,22 +20,22 @@ import nodePath from 'node:path';
  * @param {string} endpoint Endpoint name.
  * @param {{}[]} data An array from JSON response to map and sort.
  * @param {Callback} callback Callbacks for mapping and sorting arrays.
+ * @param {string} fileName Name of snapshot response file.
  * @returns {RSnapshot} Aggregated file data to write in the collection directory.
  */
-const aggregateJson = (name, endpoint, data, callback) => {
+const aggregateJson = (name, endpoint, data, callback, fileName) => {
   const dirName = import.meta.dirname,
-    fileName = new Date().toISOString() + '.json',
     path = `../collection/${name}/${endpoint.toLowerCase()}`,
     filePath = nodePath.join(dirName, path),
     filePathFull = nodePath.join(filePath, fileName);
+
   let array, fileData;
 
   if (endpoint === 'CURRENCY_ALL') {
     const currencies = data.map(callback.currencies);
 
     array = currencies.sort(callback.sort);
-  }
-  if (endpoint === 'CURRENCY_NETWORK_ALL') {
+  } else if (endpoint === 'CURRENCY_NETWORK_ALL') {
     const networks = data.map(callback.networks),
       arrayDupes = networks.reduce((accum, chain) => accum.concat(chain), []),
       arrayUnique = arrayDupes.filter(
@@ -44,6 +44,7 @@ const aggregateJson = (name, endpoint, data, callback) => {
 
     array = arrayUnique.sort((a, b) => a.chain.localeCompare(b.chain));
   }
+
   fileData = JSON.stringify(array, null, 2);
   nodeFs.mkdirSync(filePath, { recursive: true });
   nodeFs.writeFileSync(filePathFull, fileData);
@@ -58,9 +59,10 @@ const aggregateJson = (name, endpoint, data, callback) => {
  * @param {string} endpoint Endpoint name.
  * @param {{}[]} data An array from JSON response to map.
  * @param {Callback} callback Callbacks for mapping and sorting arrays.
+ * @param {string} fileName Name of snapshot response file.
  * @returns {RSnapshot} Aggregated file data to write in the collection directory.
  */
-const responseAggregate = (api, endpoint, data, callback) => {
+const responseAggregate = (api, endpoint, data, callback, fileName) => {
   const { options } = global.apiTools,
     { prefs } = api,
     isEnabled = prefs.enabled.includes('aggregate'),
@@ -69,14 +71,14 @@ const responseAggregate = (api, endpoint, data, callback) => {
 
   if (typeof aggregate === 'boolean') {
     if (aggregate) {
-      const { fileData, fileName } = aggregateJson(api.name, endpoint, data, callback);
+      const { fileData } = aggregateJson(api.name, endpoint, data, callback, fileName);
 
       return { fileData, fileName };
     }
   } else {
     if (isEnabled) {
       if (isAggregate) {
-        const { fileData, fileName } = aggregateJson(api.name, endpoint, data, callback);
+        const { fileData } = aggregateJson(api.name, endpoint, data, callback, fileName);
 
         return { fileData, fileName };
       } else console.info(`Aggregate: endpoint "${endpoint}" is not enabled is settings.`);

response/aggregate.mjs

@@ -5,8 +5,10 @@
  * @module response/bybit/aggregate
  */
 
+import { successfulJson } from '#lib/fetch.mjs';
 import { fileReadJson } from '#lib/file_system.mjs';
-import responseAggregate from '../aggregate.mjs';
+
+import aggregate from '../aggregate.mjs';
 
 /**
  * Aggregate a Bybit API response snapshot.
@@ -17,24 +19,30 @@ import responseAggregate from '../aggregate.mjs';
 const bybitAggregate = (directory, fileName) => {
   const { bybit } = global.apiTools,
     endpoint = directory.toUpperCase(),
-    json = fileReadJson('response/bybit/snapshot/' + directory, fileName),
-    data = json.OK.json.result.rows,
-    file = responseAggregate(bybit, endpoint, data, {
-      currencies: (item) => ({
-        chains: item.chains.map((item) => ({
-          chain: item.chain,
-          chainType: item.chainType,
-        })),
-        coin: item.coin,
-        name: item.name,
-      }),
-      networks: (row) =>
-        row.chains.map((item) => ({
-          chain: item.chain,
-          chainType: item.chainType,
-        })),
-      sort: (item1, item2) => item1['coin'].localeCompare(item2['coin']),
-    });
+    fileData = fileReadJson('response/bybit/snapshot/' + directory, fileName),
+    json = /** @type {{ result: { rows: object }}} */ (successfulJson(fileData)).result.rows,
+    file = aggregate(
+      bybit,
+      endpoint,
+      json,
+      {
+        currencies: (item) => ({
+          chains: item.chains.map((item) => ({
+            chain: item.chain,
+            chainType: item.chainType,
+          })),
+          coin: item.coin,
+          name: item.name,
+        }),
+        networks: (row) =>
+          row.chains.map((item) => ({
+            chain: item.chain,
+            chainType: item.chainType,
+          })),
+        sort: (item1, item2) => item1['coin'].localeCompare(item2['coin']),
+      },
+      fileName,
+    );
 
   return file;
 };

response/bybit/aggregate.mjs

@@ -1,29 +1,31 @@
 /**
- * Handle Bybit API currency all response aggregation.
+ * Handle Bybit API currency all response operations.
  *
  * @see https://bybit-exchange.github.io/docs/v5/asset/coin-info
  * @typedef {import("#res/snapshot.mjs").RSnapshot} RSnapshot
  * @module response/bybit/currency/all
  */
 
-import { fileNewest } from '#lib/file_system.mjs';
-import { obtainName } from '#lib/utility.mjs';
-import aggregate from '../aggregate.mjs';
+import { obtain } from '#lib/utility.mjs';
+import { currencyAll as schema } from '#res/bybit/currency/schema.mjs';
+
+import operate from '../operate.mjs';
 
 /**
- * @returns {RSnapshot} Aggregated file data written in the collection directory.
+ * Perform an operation on a specific response snapshot file data or latest created.
+ * @param {string} [snapshot] Response snapshot file name without `.json` extension.
+ * @returns {RSnapshot} File data has been operated.
  */
-const currencyAll = () => {
+const currencyAll = (snapshot) => {
   const { config } = global.apiTools.bybit,
     {
       PATH,
       PATH: { CURRENCY_ALL },
     } = config,
-    directory = obtainName(CURRENCY_ALL, PATH).toLowerCase(),
-    file = fileNewest('response/bybit/snapshot/' + directory),
-    fileAggregated = aggregate(directory, file.name);
+    endpoint = obtain(CURRENCY_ALL, PATH),
+    data = operate(endpoint, snapshot, schema);
 
-  return fileAggregated;
+  return data;
 };
 
 export default currencyAll;