df-script 1.9.0 → 2.0.0

package/dist/columnExpressions/mixins/StructExpr.d.ts

@@ -13,14 +13,21 @@ export declare class StructExprNamespace {
      * @param name Name of the field key to extract.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ user: [{ name: "Alice", id: 1 }] })
-     * >>> df.with_columns($df.col("user").struct.field("name").alias("user_name"))
+ * >>> const df = $df.data({ user: [{ name: "Alice", age: 30 }] })
+ * >>> df
+ * shape: (1, 1)
+ * ┌────────────────────────────────┐
+ * │ user                           │
+ * ├────────────────────────────────┤
+ * │ { name: "Alice", age: 30 }     │
+ * └────────────────────────────────┘
+     * >>> df.withColumns($df.col("user").struct.field("name").alias("user_name"))
      * shape: (1, 2)
-     * ┌─────────────────────────┬───────────┐
-     * │ user                    │ user_name │
-     * ├─────────────────────────┼───────────┤
-     * │ { name: "Alice", id: 1 }│ Alice     │
-     * └─────────────────────────┴───────────┘
+     * ┌───────────────────────────┬───────────┐
+     * │ user                      │ user_name │
+     * ├───────────────────────────┼───────────┤
+     * │ { name: "Alice", id: 1 }  │ Alice     │
+     * └───────────────────────────┴───────────┘
      */
     field(name: string): any;
     /**
@@ -28,37 +35,58 @@ export declare class StructExprNamespace {
      * @param mapping Key-value map of current field names to new field names.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ user: [{ first: "Alice" }] })
-     * >>> df.with_columns($df.col("user").struct.rename_fields({ first: "first_name" }).alias("user_renamed"))
+ * >>> const df = $df.data({ user: [{ name: "Alice", age: 30 }] })
+ * >>> df
+ * shape: (1, 1)
+ * ┌────────────────────────────────┐
+ * │ user                           │
+ * ├────────────────────────────────┤
+ * │ { name: "Alice", age: 30 }     │
+ * └────────────────────────────────┘
+     * >>> df.withColumns($df.col("user").struct.renameFields({ name: "first_name" }).alias("user_renamed"))
      * shape: (1, 2)
-     * ┌───────────────────┬─────────────────────────┐
-     * │ user              │ user_renamed            │
-     * ├───────────────────┼─────────────────────────┤
-     * │ { first: "Alice" }│ { first_name: "Alice" } │
-     * └───────────────────┴─────────────────────────┘
+     * ┌───────────────────────────┬────────────────────────────────┐
+     * │ user                      │ user_renamed                   │
+     * ├───────────────────────────┼────────────────────────────────┤
+     * │ { name: "Alice", id: 1 }  │ { id: 1, first_name: "Alice" } │
+     * └───────────────────────────┴────────────────────────────────┘
      */
-    rename_fields(mapping: Record<string, string>): any;
+    renameFields(mapping: Record<string, string>): any;
     /**
      * Inserts or updates fields inside structured object columns.
      * @param fields Expressions or field map defining new or updated fields.
      * @returns ColumnExpression
      * @throws {Error} If expressions passed without an alias or name.
      * @example
-     * >>> const df = $df.data({ user: [{ name: "Alice" }], age: [30] })
-     * >>> df.with_columns($df.col("user").struct.with_fields({ user_age: $df.col("age") }).alias("updated_user"))
-     * shape: (1, 3)
-     * ┌─────────────────┬─────┬───────────────────────────────┐
-     * │ user            │ age │ updated_user                  │
-     * ├─────────────────┼─────┼───────────────────────────────┤
-     * │ { name: "Alice"}│ 30  │ { name: "Alice", user_age: 30}│
-     * └─────────────────┴─────┴───────────────────────────────┘
+ * >>> const df = $df.data({ user: [{ name: "Alice", age: 30 }] })
+ * >>> df
+ * shape: (1, 1)
+ * ┌────────────────────────────────┐
+ * │ user                           │
+ * ├────────────────────────────────┤
+ * │ { name: "Alice", age: 30 }     │
+ * └────────────────────────────────┘
+     * >>> df.withColumns($df.col("user").struct.withFields({ is_active: $df.lit(true) }).alias("updated_user"))
+     * shape: (1, 2)
+     * ┌──────────────────────────────┬───────────────────────────────────────────┐
+     * │ user                         │ updated_user                              │
+     * ├──────────────────────────────┼───────────────────────────────────────────┤
+     * │ { name: "Alice", age: 30 }   │ { name: "Alice", age: 30, is_active: true }│
+     * └──────────────────────────────┴───────────────────────────────────────────┘
      */
-    with_fields(fields: IntoExpr[] | Record<string, IntoExpr>): any;
+    withFields(fields: IntoExpr[] | Record<string, IntoExpr>): any;
     /**
      * Expands nested struct attributes into distinct columns in the DataFrame schema.
      * @returns ColumnExpression
      * @example
-     * >>> const df = $df.data({ user: [{ name: "Alice", age: 30 }] })
+ * >>> const df = $df.data({ user: [{ name: "Alice", age: 30 }] })
+ * >>> df
+ * shape: (1, 1)
+ * ┌────────────────────────────────┐
+ * │ user                           │
+ * ├────────────────────────────────┤
+ * │ { name: "Alice", age: 30 }     │
+ * └────────────────────────────────┘
      * >>> df.select($df.col("user").struct.unnest())
      * shape: (1, 2)
      * ┌───────┬─────┐
@@ -80,7 +108,21 @@ export declare class StructExpr extends ExprBase {
      * @syntax $df.col(<column_name>).struct
      * @returns StructExprNamespace
      * @example
+ * >>> const df = $df.data({ user: [{ name: "Alice", age: 30 }] })
+ * >>> df
+ * shape: (1, 1)
+ * ┌────────────────────────────────┐
+ * │ user                           │
+ * ├────────────────────────────────┤
+ * │ { name: "Alice", age: 30 }     │
+ * └────────────────────────────────┘
      * >>> df.select($df.col("user").struct.field("name"))
+     * shape: (1, 1)
+     * ┌─────────┐
+     * │ name    │
+     * ├─────────┤
+     * │ "Alice" │
+     * └─────────┘
      */
     get struct(): StructExprNamespace;
 }