Upgrading to rs-0.46

.github/workflows/docs.yaml

@@ -14,7 +14,7 @@ jobs:
       - name: Install latest Rust nightly
         uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: nightly-2024-11-28
+          toolchain: nightly-2025-01-05
           components: rustfmt, clippy
       - name: Install ghp-import
         uses: actions/setup-python@v5

.github/workflows/test-js.yaml

@@ -20,7 +20,7 @@ jobs:
       - name: Install latest Rust nightly
         uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: nightly-2024-11-28
+          toolchain: nightly-2025-01-05
           components: rustfmt, clippy
       - name: Check yarn version
         run: yarn --version
@@ -46,7 +46,7 @@ jobs:
       - name: Install latest Rust nightly
         uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: nightly-2024-11-28
+          toolchain: nightly-2025-01-05
           components: rustfmt, clippy
       - name: Bun version
         uses: oven-sh/setup-bun@v1

.yarnrc.yml

@@ -4,4 +4,4 @@ enableGlobalCache: false
 
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-4.5.3.cjs
+yarnPath: .yarn/releases/yarn-4.7.0.cjs

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "nodejs-polars"
-version = "0.17.0"
+version = "0.18.0"
 authors = ["Cory Grinstead"]
 documentation = "https://pola-rs.github.io/polars-book/"
 edition = "2021"
@@ -15,14 +15,16 @@ crate-type = ["cdylib", "lib"]
 [dependencies]
 ahash = "0.8.11"
 bincode = "1.3.3"
-napi = { version = "2.16.13", default-features = false, features = [
+napi = { version = "2.16.16", default-features = false, features = [
     "napi8",
     "serde-json",
 ] }
 napi-derive = { version = "2.16.13", default-features = false }
-polars-core = { git = "https://github.com/pola-rs/polars.git", rev = "58a38af21dccaf3326514494a1db118601c8c2ca", default-features = false }
-polars-io = { git = "https://github.com/pola-rs/polars.git", rev = "58a38af21dccaf3326514494a1db118601c8c2ca", default-features = false }
-polars-lazy = { git = "https://github.com/pola-rs/polars.git", rev = "58a38af21dccaf3326514494a1db118601c8c2ca", default-features = false }
+polars-core = { git = "https://github.com/pola-rs/polars.git", rev = "f298ace880b238fb5793eaf0cdeb6b418e2ba583", default-features = false }
+polars-io = { git = "https://github.com/pola-rs/polars.git", rev = "f298ace880b238fb5793eaf0cdeb6b418e2ba583", default-features = false }
+polars-lazy = { git = "https://github.com/pola-rs/polars.git", rev = "f298ace880b238fb5793eaf0cdeb6b418e2ba583", default-features = false }
+polars-ops = { git = "https://github.com/pola-rs/polars.git", rev = "f298ace880b238fb5793eaf0cdeb6b418e2ba583", default-features = false }
+polars-arrow = { git = "https://github.com/pola-rs/polars.git", rev = "f298ace880b238fb5793eaf0cdeb6b418e2ba583", default-features = false }
 thiserror = "1"
 smartstring = { version = "1" }
 serde_json = { version = "1" }
@@ -162,10 +164,10 @@ features = [
   "azure"
 ]
 git = "https://github.com/pola-rs/polars.git"
-rev = "58a38af21dccaf3326514494a1db118601c8c2ca"
+rev = "f298ace880b238fb5793eaf0cdeb6b418e2ba583"
 
 [build-dependencies]
-napi-build = "2.1.3"
+napi-build = "2.1.4"
 
 [profile.release]
 codegen-units = 1

README.md

@@ -121,13 +121,14 @@ Install the latest polars version with:
 ```sh
 $ yarn add nodejs-polars # yarn
 $ npm i -s nodejs-polars # npm
+$ bun i -D nodejs-polars # Bun
 ```
 
 Releases happen quite often (weekly / every few days) at the moment, so updating polars regularly to get the latest bugfixes / features might not be a bad idea.
 
 ### Minimum Requirements
 - Node version `>=18`
-- Rust version `>=1.59` - *Only needed for development*
+- Rust version `>=1.86` - *Only needed for development*
 
 
 ## Deno
@@ -142,7 +143,7 @@ With Deno 1.37, you can use the `display` function to display a `DataFrame` in t
 
 ```typescript
 import pl from "npm:nodejs-polars";
-import { display } from "https://deno.land/x/[email protected].1/mod.ts";
+import { display } from "https://deno.land/x/[email protected].2/mod.ts";
 
 let response = await fetch(
   "https://cdn.jsdelivr.net/npm/world-atlas@1/world/110m.tsv",
@@ -171,24 +172,22 @@ ___
 
 ## Documentation
 
-Want to know about all the features Polars supports? Read the docs!
+Want to know about all the features Polars supports? Read the [docs](https://docs.pola.rs)!
 
 #### Python
 
 - Installation guide: `$ pip3 install polars`
 - [Python documentation](https://pola-rs.github.io/polars/py-polars/html/reference/index.html)
-- [User guide](https://pola-rs.github.io/polars-book/)
+- [User guide](https://docs.pola.rs)
 
 #### Rust
 
-- [Rust documentation (master branch)](https://pola-rs.github.io/polars/polars/index.html)
-- [User guide](https://pola-rs.github.io/polars-book/)
+- [Rust documentation](https://docs.rs/polars/latest/polars/)
 
 #### Node
 
   * Installation guide: `$ yarn install nodejs-polars`
   * [Node documentation](https://pola-rs.github.io/nodejs-polars/)
-  * [User guide](https://pola-rs.github.io/polars-book/)
 
 ## Contribution
 

__tests__/dataframe.test.ts

@@ -44,7 +44,7 @@ describe("dataframe", () => {
     const actual = expected.clone();
     expect(actual).toFrameEqual(expected);
   });
-  test.skip("describe", () => {
+  test("describe", () => {
     const actual = pl
       .DataFrame({
         a: [1, 2, 3],
@@ -1829,26 +1829,12 @@ describe("io", () => {
   });
   test("JSON.stringify", () => {
     const df = pl.DataFrame({
-      foo: [1],
-      bar: ["a"],
-    });
-    const expected = JSON.stringify({
-      columns: [
-        {
-          name: "foo",
-          datatype: "Float64",
-          bit_settings: "",
-          values: [1.0],
-        },
-        {
-          name: "bar",
-          datatype: "String",
-          bit_settings: "",
-          values: ["a"],
-        },
-      ],
+      foo: [1, 2, 3],
+      bar: ["a", "b", "c"],
     });
-    const actual = JSON.stringify(df);
+    const expected =
+      '[{"foo":1.0,"bar":"a"},{"foo":2.0,"bar":"b"},{"foo":3.0,"bar":"c"}]';
+    const actual = df.toJSON();
     expect(actual).toEqual(expected);
   });
   test("toRecords", () => {

__tests__/lazyframe.test.ts

@@ -44,7 +44,7 @@ describe("lazyframe", () => {
       })
       .lazy();
     let actual = df.describeOptimizedPlan().replace(/\s+/g, " ");
-    const expected = `DF ["foo", "bar"]; PROJECT */2 COLUMNS; SELECTION: None`;
+    const expected = `DF ["foo", "bar"]; PROJECT */2 COLUMNS`;
     expect(actual).toEqual(expected);
     actual = df.describePlan().replace(/\s+/g, " ");
     expect(actual).toEqual(expected);

__tests__/series.test.ts

@@ -918,7 +918,7 @@ describe("generics", () => {
     const arr2 = [...series];
     expect<number[]>(arr2).toStrictEqual([1, 2, 3]);
   });
-  test("to object", () => {
+  test.skip("to object", () => {
     const obj = series.toObject();
     expect<{ name: string; datatype: "Float64"; values: number[] }>(
       obj,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodejs-polars",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "repository": "https://github.com/pola-rs/nodejs-polars.git",
   "license": "MIT",
   "main": "bin/index.js",
@@ -58,16 +58,16 @@
     "@napi-rs/cli": "^2.18.4",
     "@types/chance": "^1.1.6",
     "@types/jest": "^29.5.14",
-    "@types/node": "^22.10.1",
+    "@types/node": "^22.13.8",
     "chance": "^1.1.12",
     "jest": "^29.7.0",
     "source-map-support": "^0.5.21",
-    "ts-jest": "^29.2.5",
+    "ts-jest": "^29.2.6",
     "ts-node": "^10.9.2",
-    "typedoc": "^0.27.3",
-    "typescript": "5.7.2"
+    "typedoc": "^0.27.9",
+    "typescript": "5.8.2"
   },
-  "packageManager": "yarn@4.5.3",
+  "packageManager": "yarn@4.7.0",
   "workspaces": [
     "benches"
   ]

polars/dataframe.ts

@@ -1253,7 +1253,7 @@ export interface DataFrame<T extends Record<string, Series> = any>
   /**
    * Replace a column at an index location.
    *
-   * @warning typescript cannot encode type mutation,
+   * Warning: typescript cannot encode type mutation,
    * so the type of the DataFrame will be incorrect. cast the type of dataframe manually.
    * ___
    * @param index - Column index
@@ -1484,7 +1484,7 @@ export interface DataFrame<T extends Record<string, Series> = any>
    * Sort the DataFrame by column.
    * ___
    * @param by - Column(s) to sort by. Accepts expression input, including selectors. Strings are parsed as column names.
-   * @param reverse - Reverse/descending sort.
+   * @param @deprecated reverse - Reverse/descending sort. Use {@link param.descending} instead
    * @param descending - Sort in descending order. When sorting by multiple columns, can be specified per column by passing a sequence of booleans.
    * @param nullsLast - Place null values last; can specify a single boolean applying to all columns or a sequence of booleans for per-column control.
    * @param maintainOrder - Whether the order should be maintained if elements are equal.
@@ -1501,7 +1501,7 @@ export interface DataFrame<T extends Record<string, Series> = any>
     maintainOrder,
   }: {
     by: ColumnsOrExpr;
-    /** @deprecated *since 0.16.0* @use descending */
+    /** @deprecated *since 0.16.0* Use {@link descending} instead */
     reverse?: boolean; // deprecated
     nullsLast?: boolean;
     maintainOrder?: boolean;
@@ -2022,9 +2022,7 @@ function mapPolarsTypeToJSONSchema(colType: DataType): string {
   return typeMapping[dataType] || "string";
 }
 
-/**
- * @ignore
- */
+/** @ignore */
 export const _DataFrame = (_df: any): DataFrame => {
   const unwrap = (method: string, ...args: any[]) => {
     return _df[method as any](...args);
@@ -2536,13 +2534,8 @@ export const _DataFrame = (_df: any): DataFrame => {
     toRecords() {
       return _df.toObjects();
     },
-    toJSON(...args: any[]) {
-      // this is passed by `JSON.stringify` when calling `toJSON()`
-      if (args[0] === "") {
-        return _df.toJs();
-      }
-
-      return _df.serialize("json").toString();
+    toJSON() {
+      return _df.toJson().toString();
     },
     toHTML(): string {
       let htmlTable = "<table>";

polars/index.ts

@@ -146,9 +146,8 @@ export namespace pl {
   /**
    * Run SQL queries against DataFrame/LazyFrame data.
    *
-   * @warning This functionality is considered **unstable**, although it is close to being
-   * considered stable. It may be changed at any point without it being considered
-   * a breaking change.
+   * @experimental This functionality is considered **unstable**, although it is close to being
+   * considered stable. It may be changed at any point without it being considered a breaking change.
    */
   export function SQLContext(
     frames?: Record<string, DataFrame | LazyDataFrame>,
@@ -290,9 +289,8 @@ export const Decimal = DataType.Decimal;
 /**
  * Run SQL queries against DataFrame/LazyFrame data.
  *
- * @warning This functionality is considered **unstable**, although it is close to being
- * considered stable. It may be changed at any point without it being considered
- * a breaking change.
+ * @experimental This functionality is considered **unstable**, although it is close to being
+ * considered stable. It may be changed at any point without it being considered a breaking change.
  */
 export function SQLContext(
   frames?: Record<string, DataFrame | LazyDataFrame>,

polars/lazy/expr/index.ts

@@ -257,8 +257,6 @@ export interface Expr
   argMin(): Expr;
   /**
    * Get the index values that would sort this column.
-   * @deprecated *since 0.16.0* @use descending
-   * @param reverse - Reverse/descending sort.
    * @param descending
    *     - false -> order from small to large.
    *     - true -> order from large to small.
@@ -738,8 +736,8 @@ export interface Expr
   quantile(quantile: number | Expr): Expr;
   /**
    * Assign ranks to data, dealing with ties appropriately.
-   * @param - method : {'average', 'min', 'max', 'dense', 'ordinal', 'random'}
-   * @param - descending - Rank in descending order.
+   * @param method : {'average', 'min', 'max', 'dense', 'ordinal', 'random'}
+   * @param descending - Rank in descending order.
    * */
   rank(method?: RankMethod, descending?: boolean): Expr;
   rank({ method, descending }: { method: string; descending: boolean }): Expr;
@@ -1040,8 +1038,6 @@ export interface Expr
   }: { offset: number | Expr; length: number | Expr }): Expr;
   /**
    * Sort this column. In projection/ selection context the whole column is sorted.
-   * @deprecated *since 0.16.0* @use descending
-   * @param reverse - Reverse/descending sort.
    * @param descending
    * * false -> order from small to large.
    * * true -> order from large to small.
@@ -1064,8 +1060,6 @@ export interface Expr
       Parameters
       ----------
       @param by The column(s) used for sorting.
-      @deprecated *since 0.16.0* @use descending
-      @param reverse - Reverse/descending sort.
       @param descending
           false -> order from small to large.
           true -> order from large to small.
@@ -1088,7 +1082,6 @@ export interface Expr
   suffix(suffix: string): Expr;
   /**
    * Get sum value.
-   * @note
    * Dtypes in {Int8, UInt8, Int16, UInt16} are cast to Int64 before summing to prevent overflow issues.
    */
   sum(): Expr;
@@ -1144,7 +1137,7 @@ export interface Expr
   /** Alias for filter: @see {@link filter} */
   where(predicate: Expr): Expr;
 }
-
+/** @ignore */
 export const _Expr = (_expr: any): Expr => {
   const unwrap = (method: string, ...args: any[]) => {
     return _expr[method as any](...args);

polars/lazy/expr/string.ts

@@ -111,7 +111,6 @@ export interface StringNamespace extends StringFunctions<Expr> {
   /**
   * Parse string values as JSON.
   * Throw errors if encounter invalid JSON strings.
-  * @params Not implemented ATM
   * @returns DF with struct
   * @example
 
@@ -184,7 +183,7 @@ export interface StringNamespace extends StringFunctions<Expr> {
    * If string is longer or equal to given length no modifications will be done
    * @param {number} length  - of the final string
    * @param {string} fillChar  - that will fill the string.
-   * @note If a string longer than 1 character is provided only the first character will be used
+   * If a string longer than 1 character is provided only the first character will be used
    * @example
    * ```
    * > df = pl.DataFrame({
@@ -249,7 +248,7 @@ export interface StringNamespace extends StringFunctions<Expr> {
    * If string is longer or equal to given length no modifications will be done
    * @param {number} length  - of the final string
    * @param {string} fillChar  - that will fill the string.
-   * @note If a string longer than 1 character is provided only the first character will be used
+   * If a string longer than 1 character is provided only the first character will be used
    *    * @example
    * ```
    * > df = pl.DataFrame({