brk-client 0.1.0 → 0.1.2

package/index.js

@@ -838,15 +838,120 @@ class BrkError extends Error {
   }
 }
 
+// Date conversion constants and helpers
+const _GENESIS = new Date(2009, 0, 3);  // dateindex 0, weekindex 0
+const _DAY_ONE = new Date(2009, 0, 9);  // dateindex 1 (6 day gap after genesis)
+const _MS_PER_DAY = 24 * 60 * 60 * 1000;
+const _MS_PER_WEEK = 7 * _MS_PER_DAY;
+const _DATE_INDEXES = new Set(['dateindex', 'weekindex', 'monthindex', 'yearindex', 'quarterindex', 'semesterindex', 'decadeindex']);
+
+/** @param {number} months @returns {globalThis.Date} */
+const _addMonths = (months) => new Date(2009, months, 1);
+
+/**
+ * Convert an index value to a Date for date-based indexes.
+ * @param {Index} index - The index type
+ * @param {number} i - The index value
+ * @returns {globalThis.Date}
+ */
+function indexToDate(index, i) {
+  switch (index) {
+    case 'dateindex': return i === 0 ? _GENESIS : new Date(_DAY_ONE.getTime() + (i - 1) * _MS_PER_DAY);
+    case 'weekindex': return new Date(_GENESIS.getTime() + i * _MS_PER_WEEK);
+    case 'monthindex': return _addMonths(i);
+    case 'yearindex': return new Date(2009 + i, 0, 1);
+    case 'quarterindex': return _addMonths(i * 3);
+    case 'semesterindex': return _addMonths(i * 6);
+    case 'decadeindex': return new Date(2009 + i * 10, 0, 1);
+    default: throw new Error(`${index} is not a date-based index`);
+  }
+}
+
+/**
+ * Check if an index type is date-based.
+ * @param {Index} index
+ * @returns {boolean}
+ */
+function isDateIndex(index) {
+  return _DATE_INDEXES.has(index);
+}
+
+/**
+ * Wrap raw metric data with helper methods.
+ * @template T
+ * @param {MetricData<T>} raw - Raw JSON response
+ * @returns {MetricData<T>}
+ */
+function _wrapMetricData(raw) {
+  const { index, start, end, data } = raw;
+  return /** @type {MetricData<T>} */ ({
+    ...raw,
+    dates() {
+      /** @type {globalThis.Date[]} */
+      const result = [];
+      for (let i = start; i < end; i++) result.push(indexToDate(index, i));
+      return result;
+    },
+    indexes() {
+      /** @type {number[]} */
+      const result = [];
+      for (let i = start; i < end; i++) result.push(i);
+      return result;
+    },
+    toDateMap() {
+      /** @type {Map<globalThis.Date, T>} */
+      const map = new Map();
+      for (let i = 0; i < data.length; i++) map.set(indexToDate(index, start + i), data[i]);
+      return map;
+    },
+    toIndexMap() {
+      /** @type {Map<number, T>} */
+      const map = new Map();
+      for (let i = 0; i < data.length; i++) map.set(start + i, data[i]);
+      return map;
+    },
+    dateEntries() {
+      /** @type {Array<[globalThis.Date, T]>} */
+      const result = [];
+      for (let i = 0; i < data.length; i++) result.push([indexToDate(index, start + i), data[i]]);
+      return result;
+    },
+    indexEntries() {
+      /** @type {Array<[number, T]>} */
+      const result = [];
+      for (let i = 0; i < data.length; i++) result.push([start + i, data[i]]);
+      return result;
+    },
+    *iter() {
+      for (let i = 0; i < data.length; i++) yield [start + i, data[i]];
+    },
+    *iterDates() {
+      for (let i = 0; i < data.length; i++) yield [indexToDate(index, start + i), data[i]];
+    },
+    [Symbol.iterator]() {
+      return this.iter();
+    },
+  });
+}
+
 /**
  * @template T
  * @typedef {Object} MetricData
  * @property {number} version - Version of the metric data
+ * @property {Index} index - The index type used for this query
  * @property {number} total - Total number of data points
  * @property {number} start - Start index (inclusive)
  * @property {number} end - End index (exclusive)
  * @property {string} stamp - ISO 8601 timestamp of when the response was generated
  * @property {T[]} data - The metric data
+ * @property {() => globalThis.Date[]} dates - Convert index range to dates (date-based indexes only)
+ * @property {() => number[]} indexes - Get index range as array
+ * @property {() => Map<globalThis.Date, T>} toDateMap - Return data as Map keyed by date (date-based only)
+ * @property {() => Map<number, T>} toIndexMap - Return data as Map keyed by index
+ * @property {() => Array<[globalThis.Date, T]>} dateEntries - Return data as [date, value] pairs (date-based only)
+ * @property {() => Array<[number, T]>} indexEntries - Return data as [index, value] pairs
+ * @property {() => IterableIterator<[number, T]>} iter - Iterate over [index, value] pairs
+ * @property {() => IterableIterator<[globalThis.Date, T]>} iterDates - Iterate over [date, value] pairs (date-based only)
  */
 /** @typedef {MetricData<any>} AnyMetricData */
 
@@ -940,18 +1045,18 @@ function _endpoint(client, name, index) {
    * @returns {RangeBuilder<T>}
    */
   const rangeBuilder = (start, end) => ({
-    fetch(onUpdate) { return client.getJson(buildPath(start, end), onUpdate); },
+    fetch(onUpdate) { return client._fetchMetricData(buildPath(start, end), onUpdate); },
     fetchCsv() { return client.getText(buildPath(start, end, 'csv')); },
     then(resolve, reject) { return this.fetch().then(resolve, reject); },
   });
 
   /**
-   * @param {number} index
+   * @param {number} idx
    * @returns {SingleItemBuilder<T>}
    */
-  const singleItemBuilder = (index) => ({
-    fetch(onUpdate) { return client.getJson(buildPath(index, index + 1), onUpdate); },
-    fetchCsv() { return client.getText(buildPath(index, index + 1, 'csv')); },
+  const singleItemBuilder = (idx) => ({
+    fetch(onUpdate) { return client._fetchMetricData(buildPath(idx, idx + 1), onUpdate); },
+    fetchCsv() { return client.getText(buildPath(idx, idx + 1, 'csv')); },
     then(resolve, reject) { return this.fetch().then(resolve, reject); },
   });
 
@@ -961,19 +1066,19 @@ function _endpoint(client, name, index) {
    */
   const skippedBuilder = (start) => ({
     take(n) { return rangeBuilder(start, start + n); },
-    fetch(onUpdate) { return client.getJson(buildPath(start, undefined), onUpdate); },
+    fetch(onUpdate) { return client._fetchMetricData(buildPath(start, undefined), onUpdate); },
     fetchCsv() { return client.getText(buildPath(start, undefined, 'csv')); },
     then(resolve, reject) { return this.fetch().then(resolve, reject); },
   });
 
   /** @type {MetricEndpointBuilder<T>} */
   const endpoint = {
-    get(index) { return singleItemBuilder(index); },
+    get(idx) { return singleItemBuilder(idx); },
     slice(start, end) { return rangeBuilder(start, end); },
     first(n) { return rangeBuilder(undefined, n); },
     last(n) { return n === 0 ? rangeBuilder(undefined, 0) : rangeBuilder(-n, undefined); },
     skip(n) { return skippedBuilder(n); },
-    fetch(onUpdate) { return client.getJson(buildPath(), onUpdate); },
+    fetch(onUpdate) { return client._fetchMetricData(buildPath(), onUpdate); },
     fetchCsv() { return client.getText(buildPath(undefined, undefined, 'csv')); },
     then(resolve, reject) { return this.fetch().then(resolve, reject); },
     get path() { return p; },
@@ -1053,6 +1158,19 @@ class BrkClientBase {
     const res = await this.get(path);
     return res.text();
   }
+
+  /**
+   * Fetch metric data and wrap with helper methods (internal)
+   * @template T
+   * @param {string} path
+   * @param {(value: MetricData<T>) => void} [onUpdate]
+   * @returns {Promise<MetricData<T>>}
+   */
+  async _fetchMetricData(path, onUpdate) {
+    const wrappedOnUpdate = onUpdate ? (/** @type {MetricData<T>} */ raw) => onUpdate(_wrapMetricData(raw)) : undefined;
+    const raw = await this.getJson(path, wrappedOnUpdate);
+    return _wrapMetricData(raw);
+  }
 }
 
 /**
@@ -1953,18 +2071,18 @@ function createPeriodDaysInLossPattern(client, acc) {
  */
 function createClassDaysInLossPattern(client, acc) {
   return {
-    _2015: createMetricPattern4(client, _m(acc, '2015_max_drawdown')),
-    _2016: createMetricPattern4(client, _m(acc, '2016_max_drawdown')),
-    _2017: createMetricPattern4(client, _m(acc, '2017_max_drawdown')),
-    _2018: createMetricPattern4(client, _m(acc, '2018_max_drawdown')),
-    _2019: createMetricPattern4(client, _m(acc, '2019_max_drawdown')),
-    _2020: createMetricPattern4(client, _m(acc, '2020_max_drawdown')),
-    _2021: createMetricPattern4(client, _m(acc, '2021_max_drawdown')),
-    _2022: createMetricPattern4(client, _m(acc, '2022_max_drawdown')),
-    _2023: createMetricPattern4(client, _m(acc, '2023_max_drawdown')),
-    _2024: createMetricPattern4(client, _m(acc, '2024_max_drawdown')),
-    _2025: createMetricPattern4(client, _m(acc, '2025_max_drawdown')),
-    _2026: createMetricPattern4(client, _m(acc, '2026_max_drawdown')),
+    _2015: createMetricPattern4(client, _m(acc, '2015_returns')),
+    _2016: createMetricPattern4(client, _m(acc, '2016_returns')),
+    _2017: createMetricPattern4(client, _m(acc, '2017_returns')),
+    _2018: createMetricPattern4(client, _m(acc, '2018_returns')),
+    _2019: createMetricPattern4(client, _m(acc, '2019_returns')),
+    _2020: createMetricPattern4(client, _m(acc, '2020_returns')),
+    _2021: createMetricPattern4(client, _m(acc, '2021_returns')),
+    _2022: createMetricPattern4(client, _m(acc, '2022_returns')),
+    _2023: createMetricPattern4(client, _m(acc, '2023_returns')),
+    _2024: createMetricPattern4(client, _m(acc, '2024_returns')),
+    _2025: createMetricPattern4(client, _m(acc, '2025_returns')),
+    _2026: createMetricPattern4(client, _m(acc, '2026_returns')),
   };
 }
 
@@ -2044,41 +2162,6 @@ function createDollarsPattern(client, acc) {
   };
 }
 
-/**
- * @typedef {Object} RelativePattern2
- * @property {MetricPattern1<StoredF32>} negUnrealizedLossRelToOwnMarketCap
- * @property {MetricPattern1<StoredF32>} negUnrealizedLossRelToOwnTotalUnrealizedPnl
- * @property {MetricPattern1<StoredF32>} netUnrealizedPnlRelToOwnMarketCap
- * @property {MetricPattern1<StoredF32>} netUnrealizedPnlRelToOwnTotalUnrealizedPnl
- * @property {MetricPattern1<StoredF64>} supplyInLossRelToOwnSupply
- * @property {MetricPattern1<StoredF64>} supplyInProfitRelToOwnSupply
- * @property {MetricPattern1<StoredF32>} unrealizedLossRelToOwnMarketCap
- * @property {MetricPattern1<StoredF32>} unrealizedLossRelToOwnTotalUnrealizedPnl
- * @property {MetricPattern1<StoredF32>} unrealizedProfitRelToOwnMarketCap
- * @property {MetricPattern1<StoredF32>} unrealizedProfitRelToOwnTotalUnrealizedPnl
- */
-
-/**
- * Create a RelativePattern2 pattern node
- * @param {BrkClientBase} client
- * @param {string} acc - Accumulated metric name
- * @returns {RelativePattern2}
- */
-function createRelativePattern2(client, acc) {
-  return {
-    negUnrealizedLossRelToOwnMarketCap: createMetricPattern1(client, _m(acc, 'neg_unrealized_loss_rel_to_own_market_cap')),
-    negUnrealizedLossRelToOwnTotalUnrealizedPnl: createMetricPattern1(client, _m(acc, 'neg_unrealized_loss_rel_to_own_total_unrealized_pnl')),
-    netUnrealizedPnlRelToOwnMarketCap: createMetricPattern1(client, _m(acc, 'net_unrealized_pnl_rel_to_own_market_cap')),
-    netUnrealizedPnlRelToOwnTotalUnrealizedPnl: createMetricPattern1(client, _m(acc, 'net_unrealized_pnl_rel_to_own_total_unrealized_pnl')),
-    supplyInLossRelToOwnSupply: createMetricPattern1(client, _m(acc, 'supply_in_loss_rel_to_own_supply')),
-    supplyInProfitRelToOwnSupply: createMetricPattern1(client, _m(acc, 'supply_in_profit_rel_to_own_supply')),
-    unrealizedLossRelToOwnMarketCap: createMetricPattern1(client, _m(acc, 'unrealized_loss_rel_to_own_market_cap')),
-    unrealizedLossRelToOwnTotalUnrealizedPnl: createMetricPattern1(client, _m(acc, 'unrealized_loss_rel_to_own_total_unrealized_pnl')),
-    unrealizedProfitRelToOwnMarketCap: createMetricPattern1(client, _m(acc, 'unrealized_profit_rel_to_own_market_cap')),
-    unrealizedProfitRelToOwnTotalUnrealizedPnl: createMetricPattern1(client, _m(acc, 'unrealized_profit_rel_to_own_total_unrealized_pnl')),
-  };
-}
-
 /**
  * @typedef {Object} RelativePattern
  * @property {MetricPattern1<StoredF32>} negUnrealizedLossRelToMarketCap
@@ -2114,6 +2197,41 @@ function createRelativePattern(client, acc) {
   };
 }
 
+/**
+ * @typedef {Object} RelativePattern2
+ * @property {MetricPattern1<StoredF32>} negUnrealizedLossRelToOwnMarketCap
+ * @property {MetricPattern1<StoredF32>} negUnrealizedLossRelToOwnTotalUnrealizedPnl
+ * @property {MetricPattern1<StoredF32>} netUnrealizedPnlRelToOwnMarketCap
+ * @property {MetricPattern1<StoredF32>} netUnrealizedPnlRelToOwnTotalUnrealizedPnl
+ * @property {MetricPattern1<StoredF64>} supplyInLossRelToOwnSupply
+ * @property {MetricPattern1<StoredF64>} supplyInProfitRelToOwnSupply
+ * @property {MetricPattern1<StoredF32>} unrealizedLossRelToOwnMarketCap
+ * @property {MetricPattern1<StoredF32>} unrealizedLossRelToOwnTotalUnrealizedPnl
+ * @property {MetricPattern1<StoredF32>} unrealizedProfitRelToOwnMarketCap
+ * @property {MetricPattern1<StoredF32>} unrealizedProfitRelToOwnTotalUnrealizedPnl
+ */
+
+/**
+ * Create a RelativePattern2 pattern node
+ * @param {BrkClientBase} client
+ * @param {string} acc - Accumulated metric name
+ * @returns {RelativePattern2}
+ */
+function createRelativePattern2(client, acc) {
+  return {
+    negUnrealizedLossRelToOwnMarketCap: createMetricPattern1(client, _m(acc, 'neg_unrealized_loss_rel_to_own_market_cap')),
+    negUnrealizedLossRelToOwnTotalUnrealizedPnl: createMetricPattern1(client, _m(acc, 'neg_unrealized_loss_rel_to_own_total_unrealized_pnl')),
+    netUnrealizedPnlRelToOwnMarketCap: createMetricPattern1(client, _m(acc, 'net_unrealized_pnl_rel_to_own_market_cap')),
+    netUnrealizedPnlRelToOwnTotalUnrealizedPnl: createMetricPattern1(client, _m(acc, 'net_unrealized_pnl_rel_to_own_total_unrealized_pnl')),
+    supplyInLossRelToOwnSupply: createMetricPattern1(client, _m(acc, 'supply_in_loss_rel_to_own_supply')),
+    supplyInProfitRelToOwnSupply: createMetricPattern1(client, _m(acc, 'supply_in_profit_rel_to_own_supply')),
+    unrealizedLossRelToOwnMarketCap: createMetricPattern1(client, _m(acc, 'unrealized_loss_rel_to_own_market_cap')),
+    unrealizedLossRelToOwnTotalUnrealizedPnl: createMetricPattern1(client, _m(acc, 'unrealized_loss_rel_to_own_total_unrealized_pnl')),
+    unrealizedProfitRelToOwnMarketCap: createMetricPattern1(client, _m(acc, 'unrealized_profit_rel_to_own_market_cap')),
+    unrealizedProfitRelToOwnTotalUnrealizedPnl: createMetricPattern1(client, _m(acc, 'unrealized_profit_rel_to_own_total_unrealized_pnl')),
+  };
+}
+
 /**
  * @template T
  * @typedef {Object} CountPattern2
@@ -2285,35 +2403,6 @@ function create_0satsPattern(client, acc) {
   };
 }
 
-/**
- * @typedef {Object} _0satsPattern2
- * @property {ActivityPattern2} activity
- * @property {CostBasisPattern} costBasis
- * @property {OutputsPattern} outputs
- * @property {RealizedPattern} realized
- * @property {RelativePattern4} relative
- * @property {SupplyPattern2} supply
- * @property {UnrealizedPattern} unrealized
- */
-
-/**
- * Create a _0satsPattern2 pattern node
- * @param {BrkClientBase} client
- * @param {string} acc - Accumulated metric name
- * @returns {_0satsPattern2}
- */
-function create_0satsPattern2(client, acc) {
-  return {
-    activity: createActivityPattern2(client, acc),
-    costBasis: createCostBasisPattern(client, acc),
-    outputs: createOutputsPattern(client, _m(acc, 'utxo_count')),
-    realized: createRealizedPattern(client, acc),
-    relative: createRelativePattern4(client, _m(acc, 'supply_in')),
-    supply: createSupplyPattern2(client, _m(acc, 'supply')),
-    unrealized: createUnrealizedPattern(client, acc),
-  };
-}
-
 /**
  * @typedef {Object} PeriodCagrPattern
  * @property {MetricPattern4<StoredF32>} _10y
@@ -2344,58 +2433,58 @@ function createPeriodCagrPattern(client, acc) {
 }
 
 /**
- * @typedef {Object} _10yTo12yPattern
+ * @typedef {Object} _100btcPattern
  * @property {ActivityPattern2} activity
- * @property {CostBasisPattern2} costBasis
+ * @property {CostBasisPattern} costBasis
  * @property {OutputsPattern} outputs
- * @property {RealizedPattern2} realized
- * @property {RelativePattern2} relative
+ * @property {RealizedPattern} realized
+ * @property {RelativePattern} relative
  * @property {SupplyPattern2} supply
  * @property {UnrealizedPattern} unrealized
  */
 
 /**
- * Create a _10yTo12yPattern pattern node
+ * Create a _100btcPattern pattern node
  * @param {BrkClientBase} client
  * @param {string} acc - Accumulated metric name
- * @returns {_10yTo12yPattern}
+ * @returns {_100btcPattern}
  */
-function create_10yTo12yPattern(client, acc) {
+function create_100btcPattern(client, acc) {
   return {
     activity: createActivityPattern2(client, acc),
-    costBasis: createCostBasisPattern2(client, acc),
+    costBasis: createCostBasisPattern(client, acc),
     outputs: createOutputsPattern(client, _m(acc, 'utxo_count')),
-    realized: createRealizedPattern2(client, acc),
-    relative: createRelativePattern2(client, acc),
+    realized: createRealizedPattern(client, acc),
+    relative: createRelativePattern(client, acc),
     supply: createSupplyPattern2(client, _m(acc, 'supply')),
     unrealized: createUnrealizedPattern(client, acc),
   };
 }
 
 /**
- * @typedef {Object} _100btcPattern
+ * @typedef {Object} _0satsPattern2
  * @property {ActivityPattern2} activity
  * @property {CostBasisPattern} costBasis
  * @property {OutputsPattern} outputs
  * @property {RealizedPattern} realized
- * @property {RelativePattern} relative
+ * @property {RelativePattern4} relative
  * @property {SupplyPattern2} supply
  * @property {UnrealizedPattern} unrealized
  */
 
 /**
- * Create a _100btcPattern pattern node
+ * Create a _0satsPattern2 pattern node
  * @param {BrkClientBase} client
  * @param {string} acc - Accumulated metric name
- * @returns {_100btcPattern}
+ * @returns {_0satsPattern2}
  */
-function create_100btcPattern(client, acc) {
+function create_0satsPattern2(client, acc) {
   return {
     activity: createActivityPattern2(client, acc),
     costBasis: createCostBasisPattern(client, acc),
     outputs: createOutputsPattern(client, _m(acc, 'utxo_count')),
     realized: createRealizedPattern(client, acc),
-    relative: createRelativePattern(client, acc),
+    relative: createRelativePattern4(client, _m(acc, 'supply_in')),
     supply: createSupplyPattern2(client, _m(acc, 'supply')),
     unrealized: createUnrealizedPattern(client, acc),
   };
@@ -2430,6 +2519,35 @@ function create_10yPattern(client, acc) {
   };
 }
 
+/**
+ * @typedef {Object} _10yTo12yPattern
+ * @property {ActivityPattern2} activity
+ * @property {CostBasisPattern2} costBasis
+ * @property {OutputsPattern} outputs
+ * @property {RealizedPattern2} realized
+ * @property {RelativePattern2} relative
+ * @property {SupplyPattern2} supply
+ * @property {UnrealizedPattern} unrealized
+ */
+
+/**
+ * Create a _10yTo12yPattern pattern node
+ * @param {BrkClientBase} client
+ * @param {string} acc - Accumulated metric name
+ * @returns {_10yTo12yPattern}
+ */
+function create_10yTo12yPattern(client, acc) {
+  return {
+    activity: createActivityPattern2(client, acc),
+    costBasis: createCostBasisPattern2(client, acc),
+    outputs: createOutputsPattern(client, _m(acc, 'utxo_count')),
+    realized: createRealizedPattern2(client, acc),
+    relative: createRelativePattern2(client, acc),
+    supply: createSupplyPattern2(client, _m(acc, 'supply')),
+    unrealized: createUnrealizedPattern(client, acc),
+  };
+}
+
 /**
  * @typedef {Object} UnrealizedPattern
  * @property {MetricPattern1<Dollars>} negUnrealizedLoss
@@ -2537,86 +2655,86 @@ function createSplitPattern2(client, acc) {
 }
 
 /**
- * @typedef {Object} CoinbasePattern
- * @property {BitcoinPattern} bitcoin
- * @property {DollarsPattern<Dollars>} dollars
- * @property {DollarsPattern<Sats>} sats
+ * @typedef {Object} SegwitAdoptionPattern
+ * @property {MetricPattern11<StoredF32>} base
+ * @property {MetricPattern2<StoredF32>} cumulative
+ * @property {MetricPattern2<StoredF32>} sum
  */
 
 /**
- * Create a CoinbasePattern pattern node
+ * Create a SegwitAdoptionPattern pattern node
  * @param {BrkClientBase} client
  * @param {string} acc - Accumulated metric name
- * @returns {CoinbasePattern}
+ * @returns {SegwitAdoptionPattern}
  */
-function createCoinbasePattern(client, acc) {
+function createSegwitAdoptionPattern(client, acc) {
   return {
-    bitcoin: createBitcoinPattern(client, _m(acc, 'btc')),
-    dollars: createDollarsPattern(client, _m(acc, 'usd')),
-    sats: createDollarsPattern(client, acc),
+    base: createMetricPattern11(client, acc),
+    cumulative: createMetricPattern2(client, _m(acc, 'cumulative')),
+    sum: createMetricPattern2(client, _m(acc, 'sum')),
   };
 }
 
 /**
- * @typedef {Object} CostBasisPattern2
- * @property {ActivePricePattern} max
- * @property {ActivePricePattern} min
- * @property {PercentilesPattern} percentiles
+ * @typedef {Object} ActiveSupplyPattern
+ * @property {MetricPattern1<Bitcoin>} bitcoin
+ * @property {MetricPattern1<Dollars>} dollars
+ * @property {MetricPattern1<Sats>} sats
  */
 
 /**
- * Create a CostBasisPattern2 pattern node
+ * Create a ActiveSupplyPattern pattern node
  * @param {BrkClientBase} client
  * @param {string} acc - Accumulated metric name
- * @returns {CostBasisPattern2}
+ * @returns {ActiveSupplyPattern}
  */
-function createCostBasisPattern2(client, acc) {
+function createActiveSupplyPattern(client, acc) {
   return {
-    max: createActivePricePattern(client, _m(acc, 'max_cost_basis')),
-    min: createActivePricePattern(client, _m(acc, 'min_cost_basis')),
-    percentiles: createPercentilesPattern(client, _m(acc, 'cost_basis')),
+    bitcoin: createMetricPattern1(client, _m(acc, 'btc')),
+    dollars: createMetricPattern1(client, _m(acc, 'usd')),
+    sats: createMetricPattern1(client, acc),
   };
 }
 
 /**
- * @typedef {Object} CoinbasePattern2
- * @property {BlockCountPattern<Bitcoin>} bitcoin
- * @property {BlockCountPattern<Dollars>} dollars
- * @property {BlockCountPattern<Sats>} sats
+ * @typedef {Object} _2015Pattern
+ * @property {MetricPattern4<Bitcoin>} bitcoin
+ * @property {MetricPattern4<Dollars>} dollars
+ * @property {MetricPattern4<Sats>} sats
  */
 
 /**
- * Create a CoinbasePattern2 pattern node
+ * Create a _2015Pattern pattern node
  * @param {BrkClientBase} client
  * @param {string} acc - Accumulated metric name
- * @returns {CoinbasePattern2}
+ * @returns {_2015Pattern}
  */
-function createCoinbasePattern2(client, acc) {
+function create_2015Pattern(client, acc) {
   return {
-    bitcoin: createBlockCountPattern(client, _m(acc, 'btc')),
-    dollars: createBlockCountPattern(client, _m(acc, 'usd')),
-    sats: createBlockCountPattern(client, acc),
+    bitcoin: createMetricPattern4(client, _m(acc, 'btc')),
+    dollars: createMetricPattern4(client, _m(acc, 'usd')),
+    sats: createMetricPattern4(client, acc),
   };
 }
 
 /**
- * @typedef {Object} SegwitAdoptionPattern
- * @property {MetricPattern11<StoredF32>} base
- * @property {MetricPattern2<StoredF32>} cumulative
- * @property {MetricPattern2<StoredF32>} sum
+ * @typedef {Object} CoinbasePattern
+ * @property {BitcoinPattern} bitcoin
+ * @property {DollarsPattern<Dollars>} dollars
+ * @property {DollarsPattern<Sats>} sats
  */
 
 /**
- * Create a SegwitAdoptionPattern pattern node
+ * Create a CoinbasePattern pattern node
  * @param {BrkClientBase} client
  * @param {string} acc - Accumulated metric name
- * @returns {SegwitAdoptionPattern}
+ * @returns {CoinbasePattern}
  */
-function createSegwitAdoptionPattern(client, acc) {
+function createCoinbasePattern(client, acc) {
   return {
-    base: createMetricPattern11(client, acc),
-    cumulative: createMetricPattern2(client, _m(acc, 'cumulative')),
-    sum: createMetricPattern2(client, _m(acc, 'sum')),
+    bitcoin: createBitcoinPattern(client, _m(acc, 'btc')),
+    dollars: createDollarsPattern(client, _m(acc, 'usd')),
+    sats: createDollarsPattern(client, acc),
   };
 }
 
@@ -2642,44 +2760,44 @@ function createUnclaimedRewardsPattern(client, acc) {
 }
 
 /**
- * @typedef {Object} ActiveSupplyPattern
- * @property {MetricPattern1<Bitcoin>} bitcoin
- * @property {MetricPattern1<Dollars>} dollars
- * @property {MetricPattern1<Sats>} sats
+ * @typedef {Object} CoinbasePattern2
+ * @property {BlockCountPattern<Bitcoin>} bitcoin
+ * @property {BlockCountPattern<Dollars>} dollars
+ * @property {BlockCountPattern<Sats>} sats
  */
 
 /**
- * Create a ActiveSupplyPattern pattern node
+ * Create a CoinbasePattern2 pattern node
  * @param {BrkClientBase} client
  * @param {string} acc - Accumulated metric name
- * @returns {ActiveSupplyPattern}
+ * @returns {CoinbasePattern2}
  */
-function createActiveSupplyPattern(client, acc) {
+function createCoinbasePattern2(client, acc) {
   return {
-    bitcoin: createMetricPattern1(client, _m(acc, 'btc')),
-    dollars: createMetricPattern1(client, _m(acc, 'usd')),
-    sats: createMetricPattern1(client, acc),
+    bitcoin: createBlockCountPattern(client, _m(acc, 'btc')),
+    dollars: createBlockCountPattern(client, _m(acc, 'usd')),
+    sats: createBlockCountPattern(client, acc),
   };
 }
 
 /**
- * @typedef {Object} _2015Pattern
- * @property {MetricPattern4<Bitcoin>} bitcoin
- * @property {MetricPattern4<Dollars>} dollars
- * @property {MetricPattern4<Sats>} sats
+ * @typedef {Object} CostBasisPattern2
+ * @property {ActivePricePattern} max
+ * @property {ActivePricePattern} min
+ * @property {PercentilesPattern} percentiles
  */
 
 /**
- * Create a _2015Pattern pattern node
+ * Create a CostBasisPattern2 pattern node
  * @param {BrkClientBase} client
  * @param {string} acc - Accumulated metric name
- * @returns {_2015Pattern}
+ * @returns {CostBasisPattern2}
  */
-function create_2015Pattern(client, acc) {
+function createCostBasisPattern2(client, acc) {
   return {
-    bitcoin: createMetricPattern4(client, _m(acc, 'btc')),
-    dollars: createMetricPattern4(client, _m(acc, 'usd')),
-    sats: createMetricPattern4(client, acc),
+    max: createActivePricePattern(client, _m(acc, 'max_cost_basis')),
+    min: createActivePricePattern(client, _m(acc, 'min_cost_basis')),
+    percentiles: createPercentilesPattern(client, _m(acc, 'cost_basis')),
   };
 }
 
@@ -2703,40 +2821,59 @@ function createActivePricePattern(client, acc) {
 }
 
 /**
- * @typedef {Object} CostBasisPattern
- * @property {ActivePricePattern} max
- * @property {ActivePricePattern} min
+ * @typedef {Object} _0sdUsdPattern
+ * @property {MetricPattern4<Dollars>} dollars
+ * @property {MetricPattern4<SatsFract>} sats
  */
 
 /**
- * Create a CostBasisPattern pattern node
+ * Create a _0sdUsdPattern pattern node
  * @param {BrkClientBase} client
  * @param {string} acc - Accumulated metric name
- * @returns {CostBasisPattern}
+ * @returns {_0sdUsdPattern}
  */
-function createCostBasisPattern(client, acc) {
+function create_0sdUsdPattern(client, acc) {
   return {
-    max: createActivePricePattern(client, _m(acc, 'max_cost_basis')),
-    min: createActivePricePattern(client, _m(acc, 'min_cost_basis')),
+    dollars: createMetricPattern4(client, acc),
+    sats: createMetricPattern4(client, _m(acc, 'sats')),
   };
 }
 
 /**
- * @typedef {Object} _0sdUsdPattern
- * @property {MetricPattern4<Dollars>} dollars
- * @property {MetricPattern4<SatsFract>} sats
+ * @typedef {Object} SupplyPattern2
+ * @property {ActiveSupplyPattern} halved
+ * @property {ActiveSupplyPattern} total
  */
 
 /**
- * Create a _0sdUsdPattern pattern node
+ * Create a SupplyPattern2 pattern node
  * @param {BrkClientBase} client
  * @param {string} acc - Accumulated metric name
- * @returns {_0sdUsdPattern}
+ * @returns {SupplyPattern2}
  */
-function create_0sdUsdPattern(client, acc) {
+function createSupplyPattern2(client, acc) {
   return {
-    dollars: createMetricPattern4(client, acc),
-    sats: createMetricPattern4(client, _m(acc, 'sats')),
+    halved: createActiveSupplyPattern(client, _m(acc, 'halved')),
+    total: createActiveSupplyPattern(client, acc),
+  };
+}
+
+/**
+ * @typedef {Object} CostBasisPattern
+ * @property {ActivePricePattern} max
+ * @property {ActivePricePattern} min
+ */
+
+/**
+ * Create a CostBasisPattern pattern node
+ * @param {BrkClientBase} client
+ * @param {string} acc - Accumulated metric name
+ * @returns {CostBasisPattern}
+ */
+function createCostBasisPattern(client, acc) {
+  return {
+    max: createActivePricePattern(client, _m(acc, 'max_cost_basis')),
+    min: createActivePricePattern(client, _m(acc, 'min_cost_basis')),
   };
 }
 
@@ -2779,41 +2916,43 @@ function createRelativePattern4(client, acc) {
 }
 
 /**
- * @typedef {Object} SupplyPattern2
- * @property {ActiveSupplyPattern} halved
- * @property {ActiveSupplyPattern} total
+ * @template T
+ * @typedef {Object} BlockCountPattern
+ * @property {MetricPattern1<T>} cumulative
+ * @property {MetricPattern1<T>} sum
  */
 
 /**
- * Create a SupplyPattern2 pattern node
+ * Create a BlockCountPattern pattern node
+ * @template T
  * @param {BrkClientBase} client
  * @param {string} acc - Accumulated metric name
- * @returns {SupplyPattern2}
+ * @returns {BlockCountPattern<T>}
  */
-function createSupplyPattern2(client, acc) {
+function createBlockCountPattern(client, acc) {
   return {
-    halved: createActiveSupplyPattern(client, _m(acc, 'halved')),
-    total: createActiveSupplyPattern(client, acc),
+    cumulative: createMetricPattern1(client, _m(acc, 'cumulative')),
+    sum: createMetricPattern1(client, acc),
   };
 }
 
 /**
  * @template T
- * @typedef {Object} BlockCountPattern
- * @property {MetricPattern1<T>} cumulative
+ * @typedef {Object} BitcoinPattern2
+ * @property {MetricPattern2<T>} cumulative
  * @property {MetricPattern1<T>} sum
  */
 
 /**
- * Create a BlockCountPattern pattern node
+ * Create a BitcoinPattern2 pattern node
  * @template T
  * @param {BrkClientBase} client
  * @param {string} acc - Accumulated metric name
- * @returns {BlockCountPattern<T>}
+ * @returns {BitcoinPattern2<T>}
  */
-function createBlockCountPattern(client, acc) {
+function createBitcoinPattern2(client, acc) {
   return {
-    cumulative: createMetricPattern1(client, _m(acc, 'cumulative')),
+    cumulative: createMetricPattern2(client, _m(acc, 'cumulative')),
     sum: createMetricPattern1(client, acc),
   };
 }
@@ -2834,29 +2973,25 @@ function createBlockCountPattern(client, acc) {
  */
 function createSatsPattern(client, acc) {
   return {
-    ohlc: createMetricPattern1(client, _m(acc, 'ohlc')),
-    split: createSplitPattern2(client, acc),
+    ohlc: createMetricPattern1(client, _m(acc, 'ohlc_sats')),
+    split: createSplitPattern2(client, _m(acc, 'sats')),
   };
 }
 
 /**
- * @template T
- * @typedef {Object} BitcoinPattern2
- * @property {MetricPattern2<T>} cumulative
- * @property {MetricPattern1<T>} sum
+ * @typedef {Object} RealizedPriceExtraPattern
+ * @property {MetricPattern4<StoredF32>} ratio
  */
 
 /**
- * Create a BitcoinPattern2 pattern node
- * @template T
+ * Create a RealizedPriceExtraPattern pattern node
  * @param {BrkClientBase} client
  * @param {string} acc - Accumulated metric name
- * @returns {BitcoinPattern2<T>}
+ * @returns {RealizedPriceExtraPattern}
  */
-function createBitcoinPattern2(client, acc) {
+function createRealizedPriceExtraPattern(client, acc) {
   return {
-    cumulative: createMetricPattern2(client, _m(acc, 'cumulative')),
-    sum: createMetricPattern1(client, acc),
+    ratio: createMetricPattern4(client, acc),
   };
 }
 
@@ -2877,23 +3012,6 @@ function createOutputsPattern(client, acc) {
   };
 }
 
-/**
- * @typedef {Object} RealizedPriceExtraPattern
- * @property {MetricPattern4<StoredF32>} ratio
- */
-
-/**
- * Create a RealizedPriceExtraPattern pattern node
- * @param {BrkClientBase} client
- * @param {string} acc - Accumulated metric name
- * @returns {RealizedPriceExtraPattern}
- */
-function createRealizedPriceExtraPattern(client, acc) {
-  return {
-    ratio: createMetricPattern4(client, acc),
-  };
-}
-
 // Catalog tree typedefs
 
 /**
@@ -3744,9 +3862,9 @@ function createRealizedPriceExtraPattern(client, acc) {
  * @property {MetricsTree_Market_Dca_ClassAveragePrice} classAveragePrice
  * @property {MetricsTree_Market_Dca_ClassDaysInLoss} classDaysInLoss
  * @property {MetricsTree_Market_Dca_ClassDaysInProfit} classDaysInProfit
- * @property {ClassDaysInLossPattern<StoredF32>} classMaxDrawdown
+ * @property {MetricsTree_Market_Dca_ClassMaxDrawdown} classMaxDrawdown
  * @property {MetricsTree_Market_Dca_ClassMaxReturn} classMaxReturn
- * @property {MetricsTree_Market_Dca_ClassReturns} classReturns
+ * @property {ClassDaysInLossPattern<StoredF32>} classReturns
  * @property {MetricsTree_Market_Dca_ClassStack} classStack
  * @property {MetricsTree_Market_Dca_PeriodAveragePrice} periodAveragePrice
  * @property {PeriodCagrPattern} periodCagr
@@ -3813,7 +3931,7 @@ function createRealizedPriceExtraPattern(client, acc) {
  */
 
 /**
- * @typedef {Object} MetricsTree_Market_Dca_ClassMaxReturn
+ * @typedef {Object} MetricsTree_Market_Dca_ClassMaxDrawdown
  * @property {MetricPattern4<StoredF32>} _2015
  * @property {MetricPattern4<StoredF32>} _2016
  * @property {MetricPattern4<StoredF32>} _2017
@@ -3829,7 +3947,7 @@ function createRealizedPriceExtraPattern(client, acc) {
  */
 
 /**
- * @typedef {Object} MetricsTree_Market_Dca_ClassReturns
+ * @typedef {Object} MetricsTree_Market_Dca_ClassMaxReturn
  * @property {MetricPattern4<StoredF32>} _2015
  * @property {MetricPattern4<StoredF32>} _2016
  * @property {MetricPattern4<StoredF32>} _2017
@@ -4212,8 +4330,8 @@ function createRealizedPriceExtraPattern(client, acc) {
 /**
  * @typedef {Object} MetricsTree_Price
  * @property {MetricsTree_Price_Cents} cents
- * @property {MetricsTree_Price_Sats} sats
- * @property {SatsPattern<OHLCDollars>} usd
+ * @property {SatsPattern<OHLCSats>} sats
+ * @property {MetricsTree_Price_Usd} usd
  */
 
 /**
@@ -4231,9 +4349,9 @@ function createRealizedPriceExtraPattern(client, acc) {
  */
 
 /**
- * @typedef {Object} MetricsTree_Price_Sats
- * @property {MetricPattern1<OHLCSats>} ohlc
- * @property {SplitPattern2<Sats>} split
+ * @typedef {Object} MetricsTree_Price_Usd
+ * @property {MetricPattern1<OHLCDollars>} ohlc
+ * @property {SplitPattern2<Dollars>} split
  */
 
 /**
@@ -4371,7 +4489,7 @@ function createRealizedPriceExtraPattern(client, acc) {
  * @extends BrkClientBase
  */
 class BrkClient extends BrkClientBase {
-  VERSION = "v0.1.0-beta.1";
+  VERSION = "v0.1.1";
 
   INDEXES = /** @type {const} */ ([
     "dateindex",
@@ -5265,6 +5383,25 @@ class BrkClient extends BrkClientBase {
     }
   });
 
+  /**
+   * Convert an index value to a Date for date-based indexes.
+   * @param {Index} index - The index type
+   * @param {number} i - The index value
+   * @returns {globalThis.Date}
+   */
+  indexToDate(index, i) {
+    return indexToDate(index, i);
+  }
+
+  /**
+   * Check if an index type is date-based.
+   * @param {Index} index
+   * @returns {boolean}
+   */
+  isDateIndex(index) {
+    return isDateIndex(index);
+  }
+
   /**
    * @param {BrkClientOptions|string} options
    */
@@ -5920,7 +6057,20 @@ class BrkClient extends BrkClientBase {
             _2025: createMetricPattern4(this, 'dca_class_2025_days_in_profit'),
             _2026: createMetricPattern4(this, 'dca_class_2026_days_in_profit'),
           },
-          classMaxDrawdown: createClassDaysInLossPattern(this, 'dca_class'),
+          classMaxDrawdown: {
+            _2015: createMetricPattern4(this, 'dca_class_2015_max_drawdown'),
+            _2016: createMetricPattern4(this, 'dca_class_2016_max_drawdown'),
+            _2017: createMetricPattern4(this, 'dca_class_2017_max_drawdown'),
+            _2018: createMetricPattern4(this, 'dca_class_2018_max_drawdown'),
+            _2019: createMetricPattern4(this, 'dca_class_2019_max_drawdown'),
+            _2020: createMetricPattern4(this, 'dca_class_2020_max_drawdown'),
+            _2021: createMetricPattern4(this, 'dca_class_2021_max_drawdown'),
+            _2022: createMetricPattern4(this, 'dca_class_2022_max_drawdown'),
+            _2023: createMetricPattern4(this, 'dca_class_2023_max_drawdown'),
+            _2024: createMetricPattern4(this, 'dca_class_2024_max_drawdown'),
+            _2025: createMetricPattern4(this, 'dca_class_2025_max_drawdown'),
+            _2026: createMetricPattern4(this, 'dca_class_2026_max_drawdown'),
+          },
           classMaxReturn: {
             _2015: createMetricPattern4(this, 'dca_class_2015_max_return'),
             _2016: createMetricPattern4(this, 'dca_class_2016_max_return'),
@@ -5935,20 +6085,7 @@ class BrkClient extends BrkClientBase {
             _2025: createMetricPattern4(this, 'dca_class_2025_max_return'),
             _2026: createMetricPattern4(this, 'dca_class_2026_max_return'),
           },
-          classReturns: {
-            _2015: createMetricPattern4(this, 'dca_class_2015_returns'),
-            _2016: createMetricPattern4(this, 'dca_class_2016_returns'),
-            _2017: createMetricPattern4(this, 'dca_class_2017_returns'),
-            _2018: createMetricPattern4(this, 'dca_class_2018_returns'),
-            _2019: createMetricPattern4(this, 'dca_class_2019_returns'),
-            _2020: createMetricPattern4(this, 'dca_class_2020_returns'),
-            _2021: createMetricPattern4(this, 'dca_class_2021_returns'),
-            _2022: createMetricPattern4(this, 'dca_class_2022_returns'),
-            _2023: createMetricPattern4(this, 'dca_class_2023_returns'),
-            _2024: createMetricPattern4(this, 'dca_class_2024_returns'),
-            _2025: createMetricPattern4(this, 'dca_class_2025_returns'),
-            _2026: createMetricPattern4(this, 'dca_class_2026_returns'),
-          },
+          classReturns: createClassDaysInLossPattern(this, 'dca_class'),
           classStack: {
             _2015: create_2015Pattern(this, 'dca_class_2015_stack'),
             _2016: create_2015Pattern(this, 'dca_class_2016_stack'),
@@ -6305,11 +6442,11 @@ class BrkClient extends BrkClientBase {
             open: createMetricPattern5(this, 'price_open_cents'),
           },
         },
-        sats: {
-          ohlc: createMetricPattern1(this, 'price_ohlc_sats'),
-          split: createSplitPattern2(this, 'price_sats'),
+        sats: createSatsPattern(this, 'price'),
+        usd: {
+          ohlc: createMetricPattern1(this, 'price_ohlc'),
+          split: createSplitPattern2(this, 'price'),
         },
-        usd: createSatsPattern(this, 'price'),
       },
       scripts: {
         count: {

package/package.json

@@ -34,5 +34,5 @@
     "url": "git+https://github.com/bitcoinresearchkit/brk.git"
   },
   "type": "module",
-  "version": "0.1.0"
+  "version": "0.1.2"
 }