feat: better errors

src/browser.ts

@@ -1,51 +1,32 @@
 import {downloadFileBrowser, DownloadFileBrowserOptions, downloadSequenceBrowser} from "./download/browser-download.js";
-import DownloadEngineBrowser, {DownloadEngineOptionsBrowser} from "./download/download-engine/engine/download-engine-browser.js";
-import DownloadEngineFile, {DownloadEngineFileOptionsWithDefaults} from "./download/download-engine/download-engine-file.js";
-import ProgressStatusFile from "./download/download-engine/progress-status-file.js";
-import TransferStatistics, {TransferProgressInfo} from "./download/transfer-visualize/transfer-statistics.js";
-import {truncateText} from "./utils/truncate-text.js";
-import DownloadEngineWriteStreamBrowser, {
-    DownloadEngineWriteStreamBrowserWriter
-} from "./download/download-engine/streams/download-engine-write-stream/download-engine-write-stream-browser.js";
+import DownloadEngineBrowser from "./download/download-engine/engine/download-engine-browser.js";
 import EmptyResponseError from "./download/download-engine/streams/download-engine-fetch-stream/errors/empty-response-error.js";
 import StatusCodeError from "./download/download-engine/streams/download-engine-fetch-stream/errors/status-code-error.js";
 import XhrError from "./download/download-engine/streams/download-engine-fetch-stream/errors/xhr-error.js";
-import BaseDownloadEngineFetchStream, {
-    BaseDownloadEngineFetchStreamOptions
-} from "./download/download-engine/streams/download-engine-fetch-stream/base-download-engine-fetch-stream.js";
-import DownloadEngineFetchStreamFetch
-    from "./download/download-engine/streams/download-engine-fetch-stream/download-engine-fetch-stream-fetch.js";
-import DownloadEngineFetchStreamXhr
-    from "./download/download-engine/streams/download-engine-fetch-stream/download-engine-fetch-stream-xhr.js";
-import BaseDownloadEngineWriteStream
-    from "./download/download-engine/streams/download-engine-write-stream/base-download-engine-write-stream.js";
-import ProgressStatisticsBuilder, {TransferProgressWithStatus} from "./download/transfer-visualize/progress-statistics-builder.js";
+import {TransferProgressWithStatus} from "./download/transfer-visualize/progress-statistics-builder.js";
+import {SaveProgressInfo} from "./download/download-engine/types.js";
+import InvalidContentLengthError
+    from "./download/download-engine/streams/download-engine-fetch-stream/errors/invalid-content-length-error.js";
+import FetchStreamError from "./download/download-engine/streams/download-engine-fetch-stream/errors/fetch-stream-error.js";
+import IpullError from "./errors/ipull-error.js";
+import EngineError from "./download/download-engine/engine/error/engine-error.js";
 
 export {
-    DownloadEngineBrowser,
-    DownloadEngineFile,
-    TransferStatistics,
-    ProgressStatisticsBuilder,
-    ProgressStatusFile,
     downloadFileBrowser,
     downloadSequenceBrowser,
-    truncateText,
     EmptyResponseError,
     StatusCodeError,
     XhrError,
-    BaseDownloadEngineFetchStream,
-    DownloadEngineFetchStreamFetch,
-    DownloadEngineFetchStreamXhr,
-    BaseDownloadEngineWriteStream,
-    DownloadEngineWriteStreamBrowser
+    InvalidContentLengthError,
+    FetchStreamError,
+    IpullError,
+    EngineError
 };
 
+
 export type {
-    TransferProgressInfo,
     DownloadFileBrowserOptions,
-    DownloadEngineOptionsBrowser,
-    DownloadEngineWriteStreamBrowserWriter,
-    DownloadEngineFileOptionsWithDefaults as DownloadEngineFileOptions,
-    BaseDownloadEngineFetchStreamOptions,
-    TransferProgressWithStatus
+    DownloadEngineBrowser,
+    TransferProgressWithStatus,
+    SaveProgressInfo
 };

src/download/download-engine/download-engine-file.ts

@@ -1,6 +1,6 @@
 import {PromisePool, Stoppable} from "@supercharge/promise-pool";
 import ProgressStatusFile from "./progress-status-file.js";
-import {ChunkStatus, DownloadFile, DownloadProgressInfo} from "./types.js";
+import {ChunkStatus, DownloadFile, SaveProgressInfo} from "./types.js";
 import BaseDownloadEngineFetchStream from "./streams/download-engine-fetch-stream/base-download-engine-fetch-stream.js";
 import BaseDownloadEngineWriteStream from "./streams/download-engine-write-stream/base-download-engine-write-stream.js";
 import retry from "async-retry";
@@ -27,7 +27,7 @@ export type DownloadEngineFileEvents = {
     paused: () => void
     resumed: () => void
     progress: (progress: ProgressStatusFile) => void
-    save: (progress: DownloadProgressInfo) => void
+    save: (progress: SaveProgressInfo) => void
     finished: () => void
     closed: () => void
     [key: string]: any
@@ -42,7 +42,7 @@ export default class DownloadEngineFile extends EventEmitter<DownloadEngineFileE
     public readonly file: DownloadFile;
     public options: DownloadEngineFileOptionsWithDefaults;
 
-    protected _progress: DownloadProgressInfo = {
+    protected _progress: SaveProgressInfo = {
         part: 0,
         chunks: [],
         chunkSize: 0

src/download/download-engine/engine/base-download-engine.ts

@@ -1,4 +1,4 @@
-import {DownloadFile, DownloadProgressInfo} from "../types.js";
+import {DownloadFile, SaveProgressInfo} from "../types.js";
 import DownloadEngineFile, {DownloadEngineFileOptions} from "../download-engine-file.js";
 import BaseDownloadEngineFetchStream, {
     BaseDownloadEngineFetchStreamOptions
@@ -23,7 +23,7 @@ export type BaseDownloadEngineEvents = {
     paused: () => void
     resumed: () => void
     progress: (progress: TransferProgressWithStatus) => void
-    save: (progress: DownloadProgressInfo) => void
+    save: (progress: SaveProgressInfo) => void
     finished: () => void
     closed: () => void
     [key: string]: any

src/download/download-engine/engine/download-engine-browser.ts

@@ -1,4 +1,4 @@
-import {DownloadProgressInfo} from "../types.js";
+import {SaveProgressInfo} from "../types.js";
 import DownloadEngineFile from "../download-engine-file.js";
 import DownloadEngineFetchStreamFetch from "../streams/download-engine-fetch-stream/download-engine-fetch-stream-fetch.js";
 import DownloadEngineFetchStreamXhr from "../streams/download-engine-fetch-stream/download-engine-fetch-stream-xhr.js";
@@ -11,7 +11,7 @@ import BaseDownloadEngineFetchStream from "../streams/download-engine-fetch-stre
 
 export type DownloadEngineOptionsBrowser = BaseDownloadEngineOptions & {
     onWrite?: DownloadEngineWriteStreamBrowserWriter,
-    progress?: DownloadProgressInfo,
+    progress?: SaveProgressInfo,
     fetchStrategy?: "xhr" | "fetch",
 };
 

src/download/download-engine/engine/error/download-already-started-error.ts

@@ -1,4 +1,6 @@
-export default class DownloadAlreadyStartedError extends Error {
+import EngineError from "./engine-error.js";
+
+export default class DownloadAlreadyStartedError extends EngineError {
     public constructor() {
         super("Download already started");
     }

src/download/download-engine/engine/error/engine-error.ts

@@ -0,0 +1,3 @@
+import IpullError from "../../../../errors/ipull-error.js";
+
+export default class EngineError extends IpullError {}

src/download/download-engine/engine/error/missing-event-error.ts

@@ -1 +1,3 @@
-export default class MissingEventError extends Error {}
+import EngineError from "./engine-error.js";
+
+export default class MissingEventError extends EngineError {}

src/download/download-engine/engine/error/save-path-error.ts

@@ -1,4 +1,6 @@
-export default class SavePathError extends Error {
+import EngineError from "./engine-error.js";
+
+export default class SavePathError extends EngineError {
     constructor(message: string) {
         super(message);
     }

src/download/download-engine/engine/error/url-input-error.ts

@@ -1,4 +1,6 @@
-export default class UrlInputError extends Error {
+import EngineError from "./engine-error.js";
+
+export default class UrlInputError extends EngineError {
     constructor(message: string) {
         super(message);
     }

src/download/download-engine/streams/download-engine-fetch-stream/errors/empty-response-error.ts

@@ -1,4 +1,6 @@
-export default class EmptyResponseError extends Error {
+import FetchStreamError from "./fetch-stream-error.js";
+
+export default class EmptyResponseError extends FetchStreamError {
     constructor(url: string, public readonly headers: { [key: string]: string | string[] }) {
         super("Empty response error: " + url);
     }

src/download/download-engine/streams/download-engine-fetch-stream/errors/fetch-stream-error.ts

@@ -0,0 +1,3 @@
+import IpullError from "../../../../../errors/ipull-error.js";
+
+export default class FetchStreamError extends IpullError {}

src/download/download-engine/streams/download-engine-fetch-stream/errors/invalid-content-length-error.ts

@@ -1,4 +1,6 @@
-export default class InvalidContentLengthError extends Error {
+import FetchStreamError from "./fetch-stream-error.js";
+
+export default class InvalidContentLengthError extends FetchStreamError {
     constructor(expectedLength: number, gotLength: number) {
         super(`Expected ${expectedLength} bytes, but got ${gotLength} bytes. If you on browser try to set "ignoreIfRangeWithQueryParams" to true, this will add a "_ignore" query parameter to the URL to avoid chrome "if-range" header.`);
     }

src/download/download-engine/streams/download-engine-fetch-stream/errors/path-not-a-file-error.ts

@@ -1,4 +1,6 @@
-export default class PathNotAFileError extends Error {
+import FetchStreamError from "./fetch-stream-error.js";
+
+export default class PathNotAFileError extends FetchStreamError {
     constructor(path: string) {
         super(`Path is not a file: ${path}`);
     }

src/download/download-engine/streams/download-engine-fetch-stream/errors/status-code-error.ts

@@ -1,4 +1,6 @@
-export default class StatusCodeError extends Error {
+import FetchStreamError from "./fetch-stream-error.js";
+
+export default class StatusCodeError extends FetchStreamError {
     constructor(
         public readonly url: string,
         public readonly statusCode: number,

src/download/download-engine/streams/download-engine-fetch-stream/errors/xhr-error.ts

@@ -1 +1,3 @@
-export default class XhrError extends Error {}
+import FetchStreamError from "./fetch-stream-error.js";
+
+export default class XhrError extends FetchStreamError {}

src/download/download-engine/types.ts

@@ -10,7 +10,7 @@ export enum ChunkStatus {
     COMPLETE
 }
 
-export type DownloadProgressInfo = {
+export type SaveProgressInfo = {
     part: number,
     chunks: ChunkStatus[],
     chunkSize: number,
@@ -20,5 +20,5 @@ export type DownloadFile = {
     totalSize: number
     localFileName: string
     parts: DownloadFilePart[]
-    downloadProgress?: DownloadProgressInfo
+    downloadProgress?: SaveProgressInfo
 };

src/download/node-download.ts

@@ -13,7 +13,7 @@ export type CliProgressDownloadEngineOptions = {
     cliAction?: string;
 };
 
-export type DownloadEngineOptionsCLI = DownloadEngineOptionsNodejs & CliProgressDownloadEngineOptions;
+export type DownloadFileOptions = DownloadEngineOptionsNodejs & CliProgressDownloadEngineOptions;
 
 function createCliProgressForDownloadEngine(options: CliProgressDownloadEngineOptions) {
     const cliOptions: TransferCliOptions = {...options};
@@ -35,7 +35,7 @@ function createCliProgressForDownloadEngine(options: CliProgressDownloadEngineOp
 /**
  * Download one file with CLI progress
  */
-export async function downloadFile(options: DownloadEngineOptionsCLI) {
+export async function downloadFile(options: DownloadFileOptions) {
     const downloader = await DownloadEngineNodejs.createFromOptions(options);
 
     if (options.cliProgress) {

src/errors/ipull-error.ts

@@ -0,0 +1 @@
+export default class IpullError extends Error {}

src/index.ts

@@ -1,47 +1,36 @@
-import {truncateText} from "./utils/truncate-text.js";
-import TransferStatistics, {TransferProgressInfo} from "./download/transfer-visualize/transfer-statistics.js";
-import TransferCli, {TransferCliOptions, TransferCliStatus} from "./download/transfer-visualize/transfer-cli/transfer-cli.js";
-import DownloadEngineNodejs, {DownloadEngineOptionsNodejs} from "./download/download-engine/engine/download-engine-nodejs.js";
-import DownloadEngineFile, {DownloadEngineFileOptionsWithDefaults} from "./download/download-engine/download-engine-file.js";
-import {downloadFile, downloadSequence} from "./download/node-download.js";
-import BaseDownloadEngine from "./download/download-engine/engine/base-download-engine.js";
-import BaseDownloadEngineFetchStream, {
-    BaseDownloadEngineFetchStreamOptions
-} from "./download/download-engine/streams/download-engine-fetch-stream/base-download-engine-fetch-stream.js";
-import DownloadEngineFetchStreamFetch
-    from "./download/download-engine/streams/download-engine-fetch-stream/download-engine-fetch-stream-fetch.js";
-import DownloadEngineFetchStreamLocalFile
-    from "./download/download-engine/streams/download-engine-fetch-stream/download-engine-fetch-stream-local-file.js";
-import BaseDownloadEngineWriteStream
-    from "./download/download-engine/streams/download-engine-write-stream/base-download-engine-write-stream.js";
-import DownloadEngineWriteStreamNodejs
-    from "./download/download-engine/streams/download-engine-write-stream/download-engine-write-stream-nodejs.js";
-import ProgressStatisticsBuilder, {TransferProgressWithStatus} from "./download/transfer-visualize/progress-statistics-builder.js";
+import DownloadEngineNodejs from "./download/download-engine/engine/download-engine-nodejs.js";
+import {downloadFile, DownloadFileOptions, downloadSequence, DownloadSequenceOptions} from "./download/node-download.js";
+import {TransferProgressWithStatus} from "./download/transfer-visualize/progress-statistics-builder.js";
+import {SaveProgressInfo} from "./download/download-engine/types.js";
+import PathNotAFileError from "./download/download-engine/streams/download-engine-fetch-stream/errors/path-not-a-file-error.js";
+import EmptyResponseError from "./download/download-engine/streams/download-engine-fetch-stream/errors/empty-response-error.js";
+import StatusCodeError from "./download/download-engine/streams/download-engine-fetch-stream/errors/status-code-error.js";
+import XhrError from "./download/download-engine/streams/download-engine-fetch-stream/errors/xhr-error.js";
+import InvalidContentLengthError
+    from "./download/download-engine/streams/download-engine-fetch-stream/errors/invalid-content-length-error.js";
+import FetchStreamError from "./download/download-engine/streams/download-engine-fetch-stream/errors/fetch-stream-error.js";
+import IpullError from "./errors/ipull-error.js";
+import EngineError from "./download/download-engine/engine/error/engine-error.js";
 
 export {
-    TransferStatistics,
-    TransferCli,
-    ProgressStatisticsBuilder,
-    DownloadEngineNodejs,
-    BaseDownloadEngine,
-    DownloadEngineFile,
-    truncateText,
     downloadFile,
     downloadSequence,
-    BaseDownloadEngineFetchStream,
-    DownloadEngineFetchStreamFetch,
-    DownloadEngineFetchStreamLocalFile,
-    BaseDownloadEngineWriteStream,
-    DownloadEngineWriteStreamNodejs
+    PathNotAFileError,
+    EmptyResponseError,
+    StatusCodeError,
+    XhrError,
+    InvalidContentLengthError,
+    FetchStreamError,
+    IpullError,
+    EngineError
 };
 
 export type {
-    TransferProgressInfo,
-    TransferCliOptions,
-    TransferCliStatus,
-    DownloadEngineOptionsNodejs,
-    DownloadEngineFileOptionsWithDefaults as DownloadEngineFileOptions,
-    BaseDownloadEngineFetchStreamOptions,
-    TransferProgressWithStatus
+    DownloadFileOptions,
+    DownloadSequenceOptions,
+    DownloadEngineNodejs,
+    TransferProgressWithStatus,
+    SaveProgressInfo
 };
 
+