#!/usr/bin/env node
// merge-enums.js
// Usage: node merge-enums.js
// Reads a preamble from docs/api-reference/enums_pre.mdx,
// fetches and parses all enums (with '///' block comments) from the three .proto files,
// and writes the combined MDX to docs/api-reference/enums.mdx, including links to each enum's definition line.

const https = require("https");
const fs = require("fs");
const path = require("path");

// Paths
const PREAMBLE_PATH = path.resolve(
  __dirname,
  "docs/api-reference/enums_pre.mdx"
);
const OUTPUT_PATH = path.resolve(__dirname, "docs/api-reference/enums.mdx");

// Proto file specifications with raw and repo URLs
const PROTO_SPECS = [
  {
    name: "common.proto",
    rawUrl:
      "https://raw.githubusercontent.com/QFEX-org/proto/main/proto/common.proto",
    repoUrl: "https://github.com/QFEX-org/proto/blob/main/proto/common.proto",
  },
  {
    name: "market_data.proto",
    rawUrl:
      "https://raw.githubusercontent.com/QFEX-org/proto/main/proto/market_data.proto",
    repoUrl:
      "https://github.com/QFEX-org/proto/blob/main/proto/market_data.proto",
  },
  {
    name: "port.proto",
    rawUrl:
      "https://raw.githubusercontent.com/QFEX-org/proto/main/proto/port.proto",
    repoUrl: "https://github.com/QFEX-org/proto/blob/main/proto/port.proto",
  },
];

// Fetch text over HTTPS
function fetchText(url) {
  return new Promise((resolve, reject) => {
    https
      .get(url, (res) => {
        if (res.statusCode !== 200) {
          return reject(new Error(`HTTP ${res.statusCode} for ${url}`));
        }
        let data = "";
        res.on("data", (chunk) => (data += chunk));
        res.on("end", () => resolve(data));
      })
      .on("error", reject);
  });
}

// Parse enums with '///' description blocks, capturing file and line number
function parseEnums(protoText, fileSpec) {
  const lines = protoText.split(/\r?\n/);
  const enums = [];

  lines.forEach((line, idx) => {
    const trimmed = line.trim();
    if (trimmed.startsWith("enum ")) {
      const name = trimmed.split(/\s+/)[1];
      // Gather leading '///' description lines
      const descLines = [];
      let k = idx - 1;
      while (k >= 0 && lines[k].trim().startsWith("///")) {
        descLines.unshift(lines[k].trim().slice(3).trim());
        k--;
      }
      const description = descLines.join(" ");
      // Parse enum members until closing '}'
      const values = [];
      for (let j = idx + 1; j < lines.length && !lines[j].includes("}"); j++) {
        const m = lines[j]
          .trim()
          .match(/^([A-Z0-9_]+)\s*=\s*(\d+)\s*;(?:\s*\/\/\s*(.*))?/);
        if (m) {
          const [, valName, valNum, inlineDesc] = m;
          values.push({
            name: valName,
            number: valNum,
            description: inlineDesc || "",
          });
        }
      }
      enums.push({
        name,
        description,
        values,
        file: fileSpec.name,
        line: idx + 1,
        repoUrl: fileSpec.repoUrl,
      });
    }
  });

  return enums;
}

// Generate MDX sections for enums, including file link
function generateSections(enums) {
  return enums.map((e) => {
    const header = [`## [${e.name}](${e.repoUrl}#L${e.line})`, ""];
    // Link to definition
    // const link = `${e.repoUrl}#L${e.line}`;
    // header.push(`<Note>[${e.name}](${e.repoUrl}#L${e.line})</Note>`, "");
    if (e.description) header.push(e.description, "");

    const table = [
      "| Name | Value | Description |",
      "| ---- | ----- | ----------- |",
      ...e.values.map(
        (v) => `| \`${v.name}\` | ${v.number} | ${v.description} |`
      ),
    ];

    return [...header, ...table].join("\n");
  });
}

(async () => {
  try {
    // Read preamble
    const preamble = fs.readFileSync(PREAMBLE_PATH, "utf8").trim();

    // Fetch and parse enums from all protos
    let allEnums = [];
    for (const spec of PROTO_SPECS) {
      const text = await fetchText(spec.rawUrl);
      allEnums = allEnums.concat(parseEnums(text, spec));
    }

    // Build output MDX
    const sections = generateSections(allEnums).join("\n\n");
    const output = `${preamble}\n\n${sections}\n`;

    // Write to file
    fs.writeFileSync(OUTPUT_PATH, output, "utf8");
    console.log(`✅ Written ${OUTPUT_PATH}`);
  } catch (err) {
    console.error("❌ Error:", err.message);
    process.exit(1);
  }
})();


OrderType

OrderDirection

OrderTimeInForce

OrderAction

OrderStatus

SymbolStatus

CandlesInterval

Enums

QFEX API Documentation

Introduction

WebSocket Playground

Stream prices and account updates over a single multiplexed socket.

WebSocket Reference

gRPC Overview

Name	Value	Description
`LIMIT`	0	Limit order
`MARKET`	1	Market order
`ALO`	3	Add Liquidity Order. If the order would cross the book, the order will be rejected.

Name	Value	Description
`BUY`	0	Buy order
`SELL`	1	Sell order

Name	Value	Description
`GTC`	0	Good till canceled. This order will stay in the book until it is filled or canceled.
`IOC`	1	Immediate or cancel. This order will fill as much as possible and then be canceled. If the order cannot be filled immediately, the remaining quantity will be canceled.
`FOK`	2	Fill or kill. This order will be canceled if it cannot be filled immediately. If the order cannot be filled immediately, the entire order will be canceled.

Name	Value	Description
`NEW`	0	Order was added
`MODIFY`	1	Order was modified
`CANCEL`	2	Order was canceled
`FILL`	4	Order was filled

Name	Value	Description
`ACK`	0	Order accepted.
`FILLED`	2	Order filled, this could be partially filled.
`MODIFIED`	20	Order successfully modified.
`CANCELLED`	30	Order successfully cancelled.
`CANCELLED_STP`	31	Order cancelled by self trade prevention.
`REJECTED`	50	Order rejected
`NO_SUCH_ORDER`	52	Cancel rejected, no such order exists.
`INVALID_ORDER_TYPE`	53	Invalid order type.
`BAD_SYMBOL`	54	Invalid symbol.
`PRICE_LESS_THAN_MIN_PRICE`	55	Price less than minimum price for this symbol.
`PRICE_GREATER_THAN_MAX_PRICE`	56	Price greater than maximum price for this symbol.
`CANNOT_MODIFY_PARTIAL_FILL`	58	Cannot modify partially filled order. Please cancel your current order and place a new order.
`FAILED_MARGIN_CHECK`	60	Failed margin check. Please check your available balance.
`INVALID_TICK_SIZE_PRECISION_PRICE`	63	Invalid tick size for this symbol. Check the price tick size in the reference data.
`INVALID_TICK_SIZE_PRECISION_QUANTITY`	64	Invalid lot size for this symbol. Check the lot size in the reference data.
`QUANTITY_LESS_THAN_MIN_QUANTITY`	65	Quantity less than minimum for this symbol. Check the minimum quantity in the reference data.
`QUANTITY_GREATER_THAN_MAX_QUANTITY`	66	Quantity greater than maximum for this symbol. Check the maximum quantity in the reference data.
`REJECTED_GREATER_THAN_MAX_PRICE_BAND`	67	Price greater than max price. Check the max price in the reference data.
`REJECTED_LESS_THAN_MIN_PRICE_BAND`	68	Price less than min price. Check the min price in the reference data.
`INVALID_TIME_IN_FORCE`	69	Invalid time in force for this order type.
`REJECTED_WOULD_BREACH_MAX_POSITION`	70	Would breach max position. Check the max position for your account in gRPC PortService.GetUserLeverage.
`CANNOT_MODIFY_NO_SUCH_ORDER`	71	Failed to modify this order. Order does not exist.
`REJECTED_MARKET_CLOSED`	72	QFEX is currently not accepting orders for this symbol.
`RATE_LIMITED`	97	You have sent too many requests to trade.pfex.io. Please contact support@qfex.com to raise your limits.

Name	Value	Description
`ACTIVE`	0	Symbol is active.
`INACTIVE`	1	Symbol is temporarily suspended.
`DELISTED`	2	Symbol is permanently suspended.

Name	Value	Description
`ONE_MINUTE`	0	1 minute candle.
`FIVE_MINUTES`	2	5 minute candle.
`FIFTEEN_MINUTES`	3	15 minute candle.
`THIRTY_MINUTES`	4	30 minute candle.
`ONE_HOUR`	5	1 hour candle.
`FOUR_HOURS`	6	4 hour candle.
`ONE_DAY`	7	1 day candle.

API Documentation

WebSocket

gRPC

​OrderType

​OrderDirection

​OrderTimeInForce

​OrderAction

​OrderStatus

​SymbolStatus

​CandlesInterval