clients: add .len()

crates/brk_bindgen/src/generators/javascript/api.rs

@@ -4,7 +4,7 @@ use std::fmt::Write;
 
 use crate::{
     Endpoint, Parameter,
-    generators::{normalize_return_type, write_description},
+    generators::{javascript::types::jsdoc_normalize, normalize_return_type, write_description},
     to_camel_case,
 };
 
@@ -16,8 +16,9 @@ pub fn generate_api_methods(output: &mut String, endpoints: &[Endpoint]) {
         }
 
         let method_name = endpoint_to_method_name(endpoint);
-        let base_return_type =
-            normalize_return_type(endpoint.response_type.as_deref().unwrap_or("*"));
+        let base_return_type = jsdoc_normalize(&normalize_return_type(
+            endpoint.response_type.as_deref().unwrap_or("*"),
+        ));
         let return_type = if endpoint.supports_csv {
             format!("{} | string", base_return_type)
         } else {
@@ -51,20 +52,17 @@ pub fn generate_api_methods(output: &mut String, endpoints: &[Endpoint]) {
 
         for param in &endpoint.path_params {
             let desc = format_param_desc(param.description.as_deref());
-            writeln!(
-                output,
-                "   * @param {{{}}} {}{}",
-                param.param_type, param.name, desc
-            )
-            .unwrap();
+            let ty = jsdoc_normalize(&param.param_type);
+            writeln!(output, "   * @param {{{}}} {}{}", ty, param.name, desc).unwrap();
         }
         for param in &endpoint.query_params {
             let optional = if param.required { "" } else { "=" };
             let desc = format_param_desc(param.description.as_deref());
+            let ty = jsdoc_normalize(&param.param_type);
             writeln!(
                 output,
                 "   * @param {{{}{}}} [{}]{}",
-                param.param_type, optional, param.name, desc
+                ty, optional, param.name, desc
             )
             .unwrap();
         }

crates/brk_bindgen/src/generators/javascript/client.rs

@@ -198,7 +198,6 @@ function _wrapSeriesData(raw) {{
  * @property {{number}} version - Version of the series data
  * @property {{Index}} index - The index type used for this query
  * @property {{string}} type - Value type (e.g. "f32", "u64", "Sats")
- * @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
@@ -236,6 +235,8 @@ function _wrapSeriesData(raw) {{
  * @property {{(n: number) => SkippedBuilder<T>}} skip - Skip first n items, chain with take()
  * @property {{(onUpdate?: (value: SeriesData<T>) => void) => Promise<SeriesData<T>>}} fetch - Fetch all data
  * @property {{() => Promise<string>}} fetchCsv - Fetch all data as CSV
+ * @property {{() => Promise<number>}} len - Get total number of data points
+ * @property {{() => Promise<Version>}} version - Get the current version of the series
  * @property {{Thenable<T>}} then - Thenable (await endpoint)
  * @property {{string}} path - The endpoint path
  */
@@ -250,6 +251,8 @@ function _wrapSeriesData(raw) {{
  * @property {{(n: number) => DateSkippedBuilder<T>}} skip - Skip first n items, chain with take()
  * @property {{(onUpdate?: (value: DateSeriesData<T>) => void) => Promise<DateSeriesData<T>>}} fetch - Fetch all data
  * @property {{() => Promise<string>}} fetchCsv - Fetch all data as CSV
+ * @property {{() => Promise<number>}} len - Get total number of data points
+ * @property {{() => Promise<Version>}} version - Get the current version of the series
  * @property {{DateThenable<T>}} then - Thenable (await endpoint)
  * @property {{string}} path - The endpoint path
  */
@@ -308,7 +311,7 @@ function _wrapSeriesData(raw) {{
 /**
  * Create a series endpoint builder with typestate pattern.
  * @template T
- * @param {{BrkClientBase}} client
+ * @param {{BrkClient}} client
  * @param {{string}} name - The series vec name
  * @param {{Index}} index - The index name
  * @returns {{DateSeriesEndpoint<T>}}
@@ -376,6 +379,8 @@ function _endpoint(client, name, index) {{
     skip(n) {{ return skippedBuilder(n); }},
     fetch(onUpdate) {{ return client._fetchSeriesData(buildPath(), onUpdate); }},
     fetchCsv() {{ return client.getText(buildPath(undefined, undefined, 'csv')); }},
+    len() {{ return client.getSeriesLen(name, index); }},
+    version() {{ return client.getSeriesVersion(name, index); }},
     then(resolve, reject) {{ return this.fetch().then(resolve, reject); }},
     get path() {{ return p; }},
   }};
@@ -626,7 +631,7 @@ pub fn generate_index_accessors(output: &mut String, patterns: &[IndexSetPattern
         r#"/**
  * Generic series pattern factory.
  * @template T
- * @param {{BrkClientBase}} client
+ * @param {{BrkClient}} client
  * @param {{string}} name - The series vec name
  * @param {{readonly Index[]}} indexes - The supported indexes
  */
@@ -679,7 +684,7 @@ function _mp(client, name, indexes) {{
         // Generate thin wrapper that calls the generic factory
         writeln!(
             output,
-            "/** @template T @param {{BrkClientBase}} client @param {{string}} name @returns {{{}<T>}} */",
+            "/** @template T @param {{BrkClient}} client @param {{string}} name @returns {{{}<T>}} */",
             pattern.name
         )
         .unwrap();
@@ -741,7 +746,7 @@ pub fn generate_structural_patterns(
         if pattern.is_generic {
             writeln!(output, " * @template T").unwrap();
         }
-        writeln!(output, " * @param {{BrkClientBase}} client").unwrap();
+        writeln!(output, " * @param {{BrkClient}} client").unwrap();
         writeln!(output, " * @param {{string}} acc - Accumulated series name").unwrap();
         if pattern.is_templated() {
             writeln!(output, " * @param {{string}} disc - Discriminator suffix").unwrap();

crates/brk_bindgen/src/generators/javascript/types.rs

@@ -111,6 +111,25 @@ fn json_type_to_js(ty: &str, schema: &Value, current_type: Option<&str>) -> Stri
     }
 }
 
+/// JSDoc has no `integer` keyword, only `number`. Map `integer` (and `integer[]`,
+/// `Foo<integer>`, etc.) to `number` before emitting type strings to JS.
+pub fn jsdoc_normalize(ty: &str) -> String {
+    let mut out = ty.to_string();
+    let mut prev = String::new();
+    while prev != out {
+        prev = out.clone();
+        out = out.replace("integer[]", "number[]");
+        out = out.replace("<integer>", "<number>");
+        out = out.replace("(integer)", "(number)");
+        out = out.replace("integer | ", "number | ");
+        out = out.replace(" | integer", " | number");
+    }
+    if out == "integer" {
+        return "number".to_string();
+    }
+    out
+}
+
 /// Convert a JSON schema to a JavaScript type string.
 pub fn schema_to_js_type(schema: &Value, current_type: Option<&str>) -> String {
     if let Some(all_of) = schema.get("allOf").and_then(|v| v.as_array()) {

crates/brk_bindgen/src/generators/python/client.rs

@@ -221,7 +221,6 @@ class SeriesData(Generic[T]):
     version: int
     index: Index
     type: str
-    total: int
     start: int
     end: int
     stamp: str

crates/brk_bindgen/src/openapi.rs

@@ -364,7 +364,7 @@ fn single_type_to_name(t: &SchemaType, schema: &ObjectSchema) -> Option<String>
     match t {
         SchemaType::String => Some("string".to_string()),
         SchemaType::Number => Some("number".to_string()),
-        SchemaType::Integer => Some("number".to_string()),
+        SchemaType::Integer => Some("integer".to_string()),
         SchemaType::Boolean => Some("boolean".to_string()),
         SchemaType::Array => {
             let inner = match &schema.items {