@thetechfossil/upfiles 0.1.0 → 0.1.1

package/README.md

@@ -1,6 +1,6 @@
-# @upfiles/uploader
+# @thetechfossil/upfiles
 
-Lightweight JavaScript client and React component to upload files to an UpFiles server (presigned S3 under the hood). Similar to UploadThing-like DX.
+Lightweight JavaScript client and React component to upload files via a presigned S3 flow. Similar to UploadThing-like DX.
 
 - Client: get presigned URLs and PUT to S3
 - React `<Uploader />`: drag/drop, progress, single/multiple, accepts/types, size limits
@@ -8,11 +8,17 @@ Lightweight JavaScript client and React component to upload files to an UpFiles
 ## Installation
 
 ```bash
-npm install @upfiles/uploader
-# or
-pnpm add @upfiles/uploader
-# or
-yarn add @upfiles/uploader
+# Bun (recommended)
+bun add @thetechfossil/upfiles
+
+# npm
+npm install @thetechfossil/upfiles
+
+# pnpm
+pnpm add @thetechfossil/upfiles
+
+# yarn
+yarn add @thetechfossil/upfiles
 ```
 
 ## Server prerequisites
@@ -20,27 +26,22 @@ yarn add @upfiles/uploader
 Your server must expose a presign endpoint compatible with:
 
 - Method: `POST`
-- Path: `/api/upload/presigned-url` (configurable via `clientOptions.presignPath`)
+- Path: `/api/upload/presigned-url` (default; configurable)
 - Body: `{ fileName, fileType, fileSize? }`
 - Response: `{ presignedUrl, fileKey, publicUrl }`
 
-This repository already provides that at `src/app/api/upload/presigned-url/route.ts`.
+This repository already provides a Next.js route at `src/app/api/upload/presigned-url/route.ts`.
 
-If your server requires auth, pass cookies (withCredentials) or an Authorization header in `clientOptions.headers`.
+If your server requires auth, you may need cookies (`withCredentials`) or an Authorization header.
 
 ## Basic usage (React)
 
 ```tsx
-import { Uploader } from '@upfiles/uploader';
+import { Uploader } from '@thetechfossil/upfiles';
 
 export default function Page() {
   return (
     <Uploader
-      clientOptions={{
-        baseUrl: process.env.NEXT_PUBLIC_APP_URL || 'http://localhost:4000',
-        // headers: { Authorization: `Bearer ${token}` },
-        withCredentials: true, // if your server uses NextAuth session cookies
-      }}
       multiple
       accept={["image/*", "application/pdf"]}
       maxFileSize={100 * 1024 * 1024}
@@ -60,11 +61,14 @@ export default function Page() {
 ## Basic usage (vanilla JS)
 
 ```ts
-import { UpfilesClient } from '@upfiles/uploader';
+import { UpfilesClient } from '@thetechfossil/upfiles';
 
+// Same-origin by default; only set these when needed:
 const client = new UpfilesClient({
-  baseUrl: 'http://localhost:4000',
-  withCredentials: true,
+  // presignUrl: 'https://api.example.com/api/upload/presigned-url', // full override
+  // baseUrl: 'https://api.example.com', // used with presignPath
+  // presignPath: '/api/upload/presigned-url', // default
+  // withCredentials: true,
 });
 
 async function upload(file) {
@@ -82,15 +86,17 @@ async function upload(file) {
 ## API
 
 - `new UpfilesClient(options)`
-  - `baseUrl` (required): your UpFiles app base URL
-  - `presignPath` (optional): default `/api/upload/presigned-url`
-  - `headers` (optional): headers for your server, e.g. Authorization
-  - `withCredentials` (optional): `true` to send cookies
+  - `presignUrl` (optional): full absolute URL to presign endpoint. Highest priority.
+  - `baseUrl` (optional): API base origin. Used with `presignPath`.
+  - `presignPath` (optional): relative path, default `/api/upload/presigned-url`.
+  - `headers` (optional): headers for your server, e.g. Authorization.
+  - `withCredentials` (optional): `true` to send cookies.
+  - Defaults: same-origin requests to `/api/upload/presigned-url`.
 - `client.getPresignedUrl({ fileName, fileType, fileSize? })`
 - `client.uploadToS3(presignedUrl, file)`
 
 - `<Uploader />` props
-  - `clientOptions`: same as `UpfilesClient` options
+  - `clientOptions` (optional): same as `UpfilesClient` options (only needed for cross-origin or auth customization)
   - `multiple` (default true)
   - `accept` (array of MIME patterns)
   - `maxFileSize` (bytes, default 100MB)
@@ -101,6 +107,7 @@ async function upload(file) {
 
 ## Notes
 
-- Ensure CORS for your app domain (S3 bucket CORS and your server CORS as needed).
-- For cross-origin usage with cookies (NextAuth), set `withCredentials: true` and configure your server to allow credentials.
+- Dev with Vite: configure a proxy so `/api/*` maps to your backend (e.g., `http://localhost:4000`), then `<Uploader />` works with no config.
+- Ensure CORS where applicable (S3 bucket CORS; server CORS only when using cross-origin calls).
+- For cross-origin with cookies (NextAuth), set `withCredentials: true` and configure your server to allow credentials.
 - Consider adding API token auth if distributing the SDK publicly.

package/dist/index.d.mts

@@ -6,14 +6,16 @@ type PresignResponse = {
     publicUrl: string;
 };
 type UpfilesClientOptions = {
-    baseUrl: string;
+    baseUrl?: string;
     presignPath?: string;
+    presignUrl?: string;
     headers?: Record<string, string>;
     withCredentials?: boolean;
 };
 declare class UpfilesClient {
-    private baseUrl;
+    private baseUrl?;
     private presignPath;
+    private presignUrl?;
     private headers?;
     private withCredentials?;
     constructor(opts: UpfilesClientOptions);
@@ -40,7 +42,7 @@ type UploaderFile = {
     fileKey?: string;
 };
 type UploaderProps = {
-    clientOptions: UpfilesClientOptions;
+    clientOptions?: UpfilesClientOptions;
     multiple?: boolean;
     accept?: string[];
     maxFileSize?: number;

package/dist/index.d.ts

@@ -6,14 +6,16 @@ type PresignResponse = {
     publicUrl: string;
 };
 type UpfilesClientOptions = {
-    baseUrl: string;
+    baseUrl?: string;
     presignPath?: string;
+    presignUrl?: string;
     headers?: Record<string, string>;
     withCredentials?: boolean;
 };
 declare class UpfilesClient {
-    private baseUrl;
+    private baseUrl?;
     private presignPath;
+    private presignUrl?;
     private headers?;
     private withCredentials?;
     constructor(opts: UpfilesClientOptions);
@@ -40,7 +42,7 @@ type UploaderFile = {
     fileKey?: string;
 };
 type UploaderProps = {
-    clientOptions: UpfilesClientOptions;
+    clientOptions?: UpfilesClientOptions;
     multiple?: boolean;
     accept?: string[];
     maxFileSize?: number;

package/dist/index.js

@@ -28,13 +28,15 @@ module.exports = __toCommonJS(index_exports);
 // src/client.ts
 var UpfilesClient = class {
   constructor(opts) {
-    this.baseUrl = opts.baseUrl.replace(/\/$/, "");
+    this.baseUrl = opts.baseUrl?.replace(/\/$/, "");
     this.presignPath = opts.presignPath ?? "/api/upload/presigned-url";
+    this.presignUrl = opts.presignUrl;
     this.headers = opts.headers;
     this.withCredentials = opts.withCredentials;
   }
   async getPresignedUrl(params) {
-    const res = await fetch(`${this.baseUrl}${this.presignPath}`, {
+    const target = this.presignUrl ? this.presignUrl : this.baseUrl ? `${this.baseUrl}${this.presignPath}` : this.presignPath;
+    const res = await fetch(target, {
       method: "POST",
       headers: {
         "Content-Type": "application/json",
@@ -84,7 +86,7 @@ var Uploader = ({
   folderPath
 }) => {
   const inputRef = (0, import_react.useRef)(null);
-  const client = (0, import_react.useMemo)(() => new UpfilesClient(clientOptions), [clientOptions]);
+  const client = (0, import_react.useMemo)(() => new UpfilesClient(clientOptions ?? {}), [clientOptions]);
   const [files, setFiles] = (0, import_react.useState)([]);
   const [isUploading, setIsUploading] = (0, import_react.useState)(false);
   const [isDragOver, setIsDragOver] = (0, import_react.useState)(false);

package/dist/index.mjs

@@ -1,13 +1,15 @@
 // src/client.ts
 var UpfilesClient = class {
   constructor(opts) {
-    this.baseUrl = opts.baseUrl.replace(/\/$/, "");
+    this.baseUrl = opts.baseUrl?.replace(/\/$/, "");
     this.presignPath = opts.presignPath ?? "/api/upload/presigned-url";
+    this.presignUrl = opts.presignUrl;
     this.headers = opts.headers;
     this.withCredentials = opts.withCredentials;
   }
   async getPresignedUrl(params) {
-    const res = await fetch(`${this.baseUrl}${this.presignPath}`, {
+    const target = this.presignUrl ? this.presignUrl : this.baseUrl ? `${this.baseUrl}${this.presignPath}` : this.presignPath;
+    const res = await fetch(target, {
       method: "POST",
       headers: {
         "Content-Type": "application/json",
@@ -57,7 +59,7 @@ var Uploader = ({
   folderPath
 }) => {
   const inputRef = useRef(null);
-  const client = useMemo(() => new UpfilesClient(clientOptions), [clientOptions]);
+  const client = useMemo(() => new UpfilesClient(clientOptions ?? {}), [clientOptions]);
   const [files, setFiles] = useState([]);
   const [isUploading, setIsUploading] = useState(false);
   const [isDragOver, setIsDragOver] = useState(false);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thetechfossil/upfiles",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Lightweight client and React components to upload files to UpFiles API (presigned S3)",
   "license": "MIT",
   "author": "UpFiles",