ByteStream is no longer Readable in 1.13.1

[chadw-dpr]

• I have checked that the [SDK documentation][sdk-docs] doesn't solve my issue.
• I have checked that the [API documentation][api-docs] doesn't solve my issue.
• I have searched the [Box Developer Forums][dev-forums] and my issue isn't already reported (or if it has been reported, I have attached a link to it, for reference).
• I have searched [Issues in this repo][github-repo] and my issue isn't already reported.

Description of the Issue

It seems there was an intentional change with 1.13.1 in commit bb5a857, it seems that ByteStream is no longer Readable and breaks piping into classes implementing stream.Transform.

Is there supposed to be another npm package for NodeJS? Behavior in 1.13.0 and prior is ByteStream was compatible with stream.Transform and was exported as a Readable.

Steps to Reproduce

1. Pipe boxClient.downloads.downloadFile() into a Readable Stream.
2. Compile
3. See errors:

error TS2339: Property 'pipe' does not exist on type 'ByteStream'.

349                         (await boxClient.downloads.downloadFile(item.id))?.pipe(parser);
                                                                               ~~~~

error TS2740: Type 'Stringifier' is missing the following properties from type 'ReadableStream<any>': locked, cancel, getReader, pipeThrough, and 3 more.

375                                 "file": stringifier
                                    ~~~~~~

  node_modules/box-typescript-sdk-gen/lib/managers/uploads.generated.d.ts:210:14
    210     readonly file: ByteStream;
                     ~~~~
    The expected type comes from property 'file' which is declared here on type 'UploadFileRequestBody'

Expected Behavior

Same behavior as 1.13.0 and earlier.

Versions Used

Typescript SDK: 1.13.1
Platform: Node.js
Node.js (if applicable): 22.10.0

[mwwoda]

Hello,
Could you provide sample app that we could use to replicate this issue?

[chadw-dpr]

Clarified the issue is 1.13.1 is a ReadableStream, and 1.13.0 was Readable, and therefore has the pipe method.

[chadw-dpr]

Untested, but this should work it downloads a CSV file from a box folder and pipe's it into csv.parser which implements the stream.Transform API.

/* eslint-disable no-console */
import assert from "assert";
import { BoxClient, BoxDeveloperTokenAuth } from "box-typescript-sdk-gen";
import * as csv from "csv";

(async () => {
    /****************************************************************************
     * MAIN
     ****************************************************************************/
    const boxClient = new BoxClient({
        "auth": new BoxDeveloperTokenAuth({
            "token": process.env.BOX_API_KEY
        })
    });

    const inputFolderItems = await boxClient.folders.getFolderItems(process.env.BOX_FOLDER_ID_IN);
    assert(inputFolderItems.entries);
    for (const item of inputFolderItems.entries) {
        try {
            if (item.type === "file") {
                console.log(`fileName: ${item.name}`);

                // csv parser instance
                const parser = csv.parse({
                    "delimiter": ",",
                    "bom": true
                });

                // download file from cloud storage, and pipe stream into csv parser instance
                (await boxClient.downloads.downloadFile(item.id))?.pipe(parser);

                for await (const record of parser) {
                    console.log(record);
                }
            }
        } catch (error) {
            console.error(error);
        }
    }
})();

[mwwoda]

What kind of environment are you running this app ij? Would it be possible to post the whole project that can be used to reproduce this issue (including package.json and other files)? That would step up the investigation

[chadw-dpr]

It runs in Azure Functions, would not be able to provide the whole project. Here is a simple project using 1.13.0, bumping to 1.13.1 breaks compilation.

1. npm run build
2. set environment variables:
   BOX_API_KEY
   BOX_FOLDER_ID_IN (folder id where CSV files are contained).
3. node dist\box.js

It should download each file, pipe into csv.parser, and write to console the record arrays.

box-testing.zip

[chadw-dpr]

The workaround could be using Readable.from/Readable.toWeb to convert. I did test on the downloadFile that Readable.from works. This also affects the uploadFile API. That's the other error complaining about csv.stringifier.

What we do is parse a CSV file from a Box folder, and then add a column to the csv.parser record output for the "error" and upload that to another folder on Box. So the full path is:
downloadFile => csv.parser => csv.stringifier => uploadFile

[chadw-dpr]

Here is the uploadFile.ts case, you can just drop that into the project folder I uploaded, and you would have to set an additional environment variable:
BOX_FOLDER_ID_OUT

import assert from "assert";
import { BoxClient, BoxDeveloperTokenAuth } from "box-typescript-sdk-gen";
import * as csv from "csv";

(async () => {
    /****************************************************************************
     * MAIN
     ****************************************************************************/
    const boxClient = new BoxClient({
        "auth": new BoxDeveloperTokenAuth({
            "token": process.env.BOX_API_KEY
        })
    });

    const stringifier = csv.stringify({
        "header": true,
        "bom": true,
        // header, original column record + new column for error
        "columns": [
            "dummy"
        ]
    });

    stringifier.write(["123"]);
    stringifier.write(["456"]);
    stringifier.end();

    const outputFolderItems = await boxClient.folders.getFolderItems(process.env.BOX_FOLDER_ID_OUT);
    assert(outputFolderItems.entries);
    try {
        const fileId = outputFolderItems.entries?.find((e) => e.type === "file" && e.name === "test.csv")?.id;
        if (fileId) {
            // delete duplicate file name
            await boxClient.files.deleteFileById(fileId);
        }

        await boxClient.uploads.uploadFile({
            "attributes": {
                "name": "test.csv",
                "parent": { "id": process.env.BOX_FOLDER_ID_OUT }
            },
            "file": stringifier
        });
    } catch (error) {
        console.error(error);
    }
})();

[mwwoda]

Looks like it could be cause by rollup that overrides some files with the browser version and these files are published (instead of original ones generated by the tsc). We'll looking how to fix this

[chadw-dpr]

OK, that's what I was thinking, but I kind of got lost in what I was looking at. :) Thanks!