René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Better File Upload/Download operations in oRPC thanks to builtin integration of TUS","articleBody":"This is just an idea; I haven't thought about how it will work or what the API will look like yet.\n\nAs told in the [documentation](https://orpc.unnoq.com/docs/file-upload-download):\n> For files larger than 10MB, it is recommended to use a dedicated solution for performance and reliability.\n\nFrom my understanding, it is not recommended for \"big\" files, because under the hood, it encodes/decodes in base64 (haven't tested it)?\nEven, file upload is much more than only 1 API request, it's not the same thing as basic JSON api call. Performance and resumable file uploads are crucial + good UX client side to show how much kb has been uploaded and much need to be uploaded still etc.\n\n[tus - Open Protocol for Resumable File Uploads](https://tus.io) makes file uploads more reliable and performant for any size of files.\n\nWhile, we can already use [@tus/server](https://www.npmjs.com/package/@tus/server) in combination with oRPC, I believe there might be a better way that keep type-safety, zod goodness and simplicity while preserving tus goodness too.\n\nWould be great to define oRPC route as \"tus route\" and then call them with the RPCClient like normal routes with more features like [tus-js-client](https://www.npmjs.com/package/tus-js-client), for example:\n\n```ts\nconst handleUpload = async (file: File): Promise\u003cvoid> => {\n  const upload = new tus.Upload(file, {\n    retryDelays: [0, 1_000, 3_000, 5_000],\n    metadata: {\n      filename: file.name,\n      mimetype: file.type\n    },\n    onError: (error) => {\n      console.error(error)\n    },\n    onProgress: (bytesUploaded, bytesTotal) =>{\n      const percentage = (bytesUploaded / bytesTotal * 100).toFixed(2)\n      console.log(bytesUploaded, bytesTotal, percentage + \"%\")\n    },\n    onSuccess: () => {\n    console.log(\"Download %s from %s\", upload.file.name, upload.url)\n    }\n  })\n  const [previousUpload] = await upload.findPreviousUploads()\n  if (previousUpload != null) {\n    upload.resumeFromPreviousUpload(previousUpload)\n  }\n  upload.start()\n}\n```\n\nThe good thing, is that we can have a `onProgress` and regularly tell the user, how much bytes uploaded, how much still needed, percentage.\n\nAlso we have out of the box, resumability so for example, if the internet connection of the user is bad, and is interrupted, they can try to upload again the file, without the need of uploading the file from scratch, especially useful for big files, or really bad connection, like mobile network.\n\nWe could have a way to do it, with oRPC, the same type-safety, and APIs to define middleware.","author":{"url":"https://github.com/theoludwig","@type":"Person","name":"theoludwig"},"datePublished":"2025-05-09T14:20:01Z","url":"https://github.com/middleapi/orpc/issues/482"}