@allegria/aws-file-manager 1.0.1 → 1.0.3

package/dist/examples/02-upload-multer.js

@@ -1,63 +0,0 @@
-/**
- * 02-upload-multer.ts
- *
- * Uploading files from an Express route that uses multer for multipart parsing.
- *
- * Key points:
- *   - Use `fromMulterFile()` to normalise multer's file shape into FileInput.
- *   - `upload()` returns an UploadResult with the S3 key — persist this key
- *     to your database, NOT a signed URL (URLs expire).
- *   - Generate a signed URL on demand at request time via `getSignedUrl()`.
- */
-import express from "express";
-import multer from "multer";
-import { AwsFileManager, fromMulterFile, } from "@lib/aws-file-manager";
-const app = express();
-const upload = multer({ storage: multer.memoryStorage() });
-const fileManager = new AwsFileManager({
-    region: process.env.AWS_REGION ?? "us-east-1",
-    bucketName: process.env.S3_BUCKET_NAME,
-    basePath: "uploads",
-});
-// POST /upload — accepts a single file field named 'file'
-app.post("/upload", upload.single("file"), async (req, res) => {
-    if (!req.file) {
-        return res.status(400).json({ error: "No file provided" });
-    }
-    // Normalise multer's file into a FileInput
-    const fileInput = fromMulterFile(req.file);
-    // Upload to S3 with a UUID-based filename to prevent collisions
-    const result = await fileManager.upload(fileInput, {
-        folder: "avatars",
-        generateUniqueFileName: true,
-        metadata: {
-            uploadedBy: req.body.userId ?? "anonymous",
-        },
-    });
-    // Persist result.key to your database — never store the signed URL
-    // await db.files.create({ s3Key: result.key, ... });
-    // Return a short-lived signed URL for the client to use immediately
-    const url = await fileManager.getSignedUrl(result.key, {
-        disposition: "inline",
-    });
-    return res.json({
-        key: result.key,
-        url,
-        size: result.size,
-        contentType: result.contentType,
-    });
-});
-// POST /upload-many — accepts up to 5 files in a 'files' field
-app.post("/upload-many", upload.array("files", 5), async (req, res) => {
-    const files = req.files;
-    if (!files?.length) {
-        return res.status(400).json({ error: "No files provided" });
-    }
-    const results = await Promise.all(files.map((file) => fileManager.upload(fromMulterFile(file), {
-        folder: "documents",
-        generateUniqueFileName: true,
-    })));
-    return res.json(results.map((r) => ({ key: r.key, size: r.size })));
-});
-export { app };
-//# sourceMappingURL=02-upload-multer.js.map

package/dist/examples/02-upload-multer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"02-upload-multer.js","sourceRoot":"","sources":["../../examples/02-upload-multer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EACL,cAAc,EACd,cAAc,GACf,MAAM,uBAAuB,CAAC;AAE/B,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;AACtB,MAAM,MAAM,GAAG,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;AAE3D,MAAM,WAAW,GAAG,IAAI,cAAc,CAAC;IACrC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,WAAW;IAC7C,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,cAAe;IACvC,QAAQ,EAAE,SAAS;CACpB,CAAC,CAAC;AAEH,0DAA0D;AAC1D,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;IAC5D,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QACd,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,2CAA2C;IAC3C,MAAM,SAAS,GAAG,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAE3C,gEAAgE;IAChE,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE;QACjD,MAAM,EAAE,SAAS;QACjB,sBAAsB,EAAE,IAAI;QAC5B,QAAQ,EAAE;YACR,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,WAAW;SAC3C;KACF,CAAC,CAAC;IAEH,mEAAmE;IACnE,qDAAqD;IAErD,oEAAoE;IACpE,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE;QACrD,WAAW,EAAE,QAAQ;KACtB,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC,IAAI,CAAC;QACd,GAAG,EAAE,MAAM,CAAC,GAAG;QACf,GAAG;QACH,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,WAAW,EAAE,MAAM,CAAC,WAAW;KAChC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,+DAA+D;AAC/D,GAAG,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;IACpE,MAAM,KAAK,GAAG,GAAG,CAAC,KAA8B,CAAC;IACjD,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,CAAC;QACnB,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,mBAAmB,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACjB,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE;QACvC,MAAM,EAAE,WAAW;QACnB,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CACH,CACF,CAAC;IAEF,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AACtE,CAAC,CAAC,CAAC;AAEH,OAAO,EAAE,GAAG,EAAE,CAAC"}

package/dist/examples/03-upload-web.d.ts

@@ -1,12 +0,0 @@
-/**
- * 03-upload-web.ts
- *
- * Uploading files from a Next.js App Router route handler (or any environment
- * where you receive a Web API `File` object from FormData).
- *
- * Key points:
- *   - `fromWebFile()` is async because it calls `file.arrayBuffer()`.
- *   - Everything else is the same as the multer path.
- */
-import { NextRequest } from "next/server";
-export declare function POST(request: NextRequest): Promise<any>;

package/dist/examples/03-upload-web.js

@@ -1,38 +0,0 @@
-/**
- * 03-upload-web.ts
- *
- * Uploading files from a Next.js App Router route handler (or any environment
- * where you receive a Web API `File` object from FormData).
- *
- * Key points:
- *   - `fromWebFile()` is async because it calls `file.arrayBuffer()`.
- *   - Everything else is the same as the multer path.
- */
-import { NextResponse } from "next/server";
-import { AwsFileManager, fromWebFile } from "@lib/aws-file-manager";
-const fileManager = new AwsFileManager({
-    region: process.env.AWS_REGION ?? "us-east-1",
-    bucketName: process.env.S3_BUCKET_NAME,
-    basePath: "uploads",
-});
-// app/api/upload/route.ts
-export async function POST(request) {
-    const formData = await request.formData();
-    const file = formData.get("file");
-    if (!(file instanceof File)) {
-        return NextResponse.json({ error: "No file provided" }, { status: 400 });
-    }
-    // Normalise the Web API File into a FileInput
-    const fileInput = await fromWebFile(file);
-    const result = await fileManager.upload(fileInput, {
-        folder: "profile-photos",
-        generateUniqueFileName: true,
-    });
-    // Persist result.key to your database
-    // await db.users.update({ id: userId, avatarKey: result.key });
-    const url = await fileManager.getSignedUrl(result.key, {
-        disposition: "inline",
-    });
-    return NextResponse.json({ key: result.key, url });
-}
-//# sourceMappingURL=03-upload-web.js.map

package/dist/examples/03-upload-web.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"03-upload-web.js","sourceRoot":"","sources":["../../examples/03-upload-web.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAe,YAAY,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpE,MAAM,WAAW,GAAG,IAAI,cAAc,CAAC;IACrC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,WAAW;IAC7C,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,cAAe;IACvC,QAAQ,EAAE,SAAS;CACpB,CAAC,CAAC;AAEH,0BAA0B;AAC1B,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAAoB;IAC7C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC;IAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAElC,IAAI,CAAC,CAAC,IAAI,YAAY,IAAI,CAAC,EAAE,CAAC;QAC5B,OAAO,YAAY,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,8CAA8C;IAC9C,MAAM,SAAS,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,CAAC;IAE1C,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE;QACjD,MAAM,EAAE,gBAAgB;QACxB,sBAAsB,EAAE,IAAI;KAC7B,CAAC,CAAC;IAEH,sCAAsC;IACtC,gEAAgE;IAEhE,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE;QACrD,WAAW,EAAE,QAAQ;KACtB,CAAC,CAAC;IAEH,OAAO,YAAY,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;AACrD,CAAC"}

package/dist/examples/04-signed-urls.d.ts

@@ -1,12 +0,0 @@
-/**
- * 04-signed-urls.ts
- *
- * Generating signed URLs for private S3 objects.
- *
- * Key points:
- *   - Call `getSignedUrl()` at request time — never store the returned URL.
- *   - Use `disposition: 'inline'`  for images and PDFs rendered in the browser.
- *   - Use `disposition: 'attachment'` to force a file download with a filename.
- *   - Signed URLs are credentials — treat them accordingly (HTTPS only, short TTL).
- */
-export {};

package/dist/examples/04-signed-urls.js

@@ -1,48 +0,0 @@
-/**
- * 04-signed-urls.ts
- *
- * Generating signed URLs for private S3 objects.
- *
- * Key points:
- *   - Call `getSignedUrl()` at request time — never store the returned URL.
- *   - Use `disposition: 'inline'`  for images and PDFs rendered in the browser.
- *   - Use `disposition: 'attachment'` to force a file download with a filename.
- *   - Signed URLs are credentials — treat them accordingly (HTTPS only, short TTL).
- */
-import { AwsFileManager } from "@lib/aws-file-manager";
-const fileManager = new AwsFileManager({
-    region: process.env.AWS_REGION ?? "us-east-1",
-    bucketName: process.env.S3_BUCKET_NAME,
-    urlExpirationSeconds: 3600, // 1 hour default
-});
-async function examples() {
-    const s3Key = "uploads/avatars/f47ac10b-58cc-4372-a567-0e02b2c3d479.jpg";
-    // ─── Inline (browser renders the file) ───────────────────────────────────
-    const inlineUrl = await fileManager.getSignedUrl(s3Key, {
-        disposition: "inline",
-    });
-    console.log("Inline URL:", inlineUrl);
-    // → https://my-bucket.s3.amazonaws.com/uploads/avatars/...?X-Amz-Signature=...
-    // ─── Attachment (forced download with a suggested filename) ───────────────
-    const downloadUrl = await fileManager.getSignedUrl(s3Key, {
-        disposition: "attachment",
-        fileName: "my-photo.jpg", // Suggested filename in Content-Disposition
-    });
-    console.log("Download URL:", downloadUrl);
-    // ─── Custom TTL ───────────────────────────────────────────────────────────
-    // Override the instance default for a short-lived share link
-    const shortLivedUrl = await fileManager.getSignedUrl(s3Key, {
-        disposition: "inline",
-        expiresIn: 300, // 5 minutes
-    });
-    console.log("Short-lived URL:", shortLivedUrl);
-    // ─── Serve from an API route ──────────────────────────────────────────────
-    // Typical pattern: look up the key from your DB, then redirect to the URL.
-    //
-    // GET /api/files/:id
-    // const file = await db.files.findById(req.params.id);
-    // const url = await fileManager.getSignedUrl(file.s3Key, { disposition: 'inline' });
-    // return res.redirect(302, url);
-}
-examples().catch(console.error);
-//# sourceMappingURL=04-signed-urls.js.map

package/dist/examples/04-signed-urls.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"04-signed-urls.js","sourceRoot":"","sources":["../../examples/04-signed-urls.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,MAAM,WAAW,GAAG,IAAI,cAAc,CAAC;IACrC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,WAAW;IAC7C,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,cAAe;IACvC,oBAAoB,EAAE,IAAI,EAAE,iBAAiB;CAC9C,CAAC,CAAC;AAEH,KAAK,UAAU,QAAQ;IACrB,MAAM,KAAK,GAAG,0DAA0D,CAAC;IAEzE,4EAA4E;IAC5E,MAAM,SAAS,GAAG,MAAM,WAAW,CAAC,YAAY,CAAC,KAAK,EAAE;QACtD,WAAW,EAAE,QAAQ;KACtB,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IACtC,+EAA+E;IAE/E,6EAA6E;IAC7E,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,YAAY,CAAC,KAAK,EAAE;QACxD,WAAW,EAAE,YAAY;QACzB,QAAQ,EAAE,cAAc,EAAE,4CAA4C;KACvE,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;IAE1C,6EAA6E;IAC7E,6DAA6D;IAC7D,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,YAAY,CAAC,KAAK,EAAE;QAC1D,WAAW,EAAE,QAAQ;QACrB,SAAS,EAAE,GAAG,EAAE,YAAY;KAC7B,CAAC,CAAC;IACH,OAAO,CAAC,GAAG,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAC;IAE/C,6EAA6E;IAC7E,2EAA2E;IAC3E,EAAE;IACF,qBAAqB;IACrB,uDAAuD;IACvD,qFAAqF;IACrF,iCAAiC;AACnC,CAAC;AAED,QAAQ,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC"}

package/dist/examples/05-download.d.ts

@@ -1,14 +0,0 @@
-/**
- * 05-download.ts
- *
- * Downloading S3 objects as a Buffer or a Node.js Readable stream.
- *
- * Key points:
- *   - `download()` returns `null` when the object does not exist (no throw).
- *   - Use `'stream'` (default) when piping to an HTTP response or writing to disk.
- *   - Use `'buffer'` when you need the full bytes in memory (e.g. image processing).
- */
-declare const app: import("express-serve-static-core").Express;
-declare function processImage(s3Key: string): Promise<void>;
-declare function saveToDisk(s3Key: string, outputPath: string): Promise<void>;
-export { app, processImage, saveToDisk };

package/dist/examples/05-download.js

@@ -1,53 +0,0 @@
-/**
- * 05-download.ts
- *
- * Downloading S3 objects as a Buffer or a Node.js Readable stream.
- *
- * Key points:
- *   - `download()` returns `null` when the object does not exist (no throw).
- *   - Use `'stream'` (default) when piping to an HTTP response or writing to disk.
- *   - Use `'buffer'` when you need the full bytes in memory (e.g. image processing).
- */
-import { createWriteStream } from "fs";
-import { pipeline } from "stream/promises";
-import express from "express";
-import { AwsFileManager } from "@lib/aws-file-manager";
-const fileManager = new AwsFileManager({
-    region: process.env.AWS_REGION ?? "us-east-1",
-    bucketName: process.env.S3_BUCKET_NAME,
-});
-const app = express();
-// ─── Stream directly to HTTP response ────────────────────────────────────────
-app.get("/files/:key(*)", async (req, res) => {
-    const result = await fileManager.download(req.params.key, "stream");
-    if (!result) {
-        return res.status(404).json({ error: "File not found" });
-    }
-    const { stream, metadata } = result;
-    if (metadata.contentType)
-        res.setHeader("Content-Type", metadata.contentType);
-    if (metadata.contentLength)
-        res.setHeader("Content-Length", metadata.contentLength);
-    stream.pipe(res);
-});
-// ─── Download to a Buffer (for in-memory processing) ─────────────────────────
-async function processImage(s3Key) {
-    const result = await fileManager.download(s3Key, "buffer");
-    if (!result) {
-        throw new Error(`File not found: ${s3Key}`);
-    }
-    const { buffer, metadata } = result;
-    console.log(`Downloaded ${buffer.length} bytes, type: ${metadata.contentType}`);
-    // Pass the buffer to an image processing library, compression pipeline, etc.
-    // const compressed = await sharp(buffer).jpeg({ quality: 80 }).toBuffer();
-}
-// ─── Stream to disk ───────────────────────────────────────────────────────────
-async function saveToDisk(s3Key, outputPath) {
-    const result = await fileManager.download(s3Key, "stream");
-    if (!result)
-        throw new Error(`File not found: ${s3Key}`);
-    await pipeline(result.stream, createWriteStream(outputPath));
-    console.log(`Saved to ${outputPath}`);
-}
-export { app, processImage, saveToDisk };
-//# sourceMappingURL=05-download.js.map

package/dist/examples/05-download.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"05-download.js","sourceRoot":"","sources":["../../examples/05-download.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,IAAI,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,MAAM,WAAW,GAAG,IAAI,cAAc,CAAC;IACrC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,WAAW;IAC7C,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,cAAe;CACxC,CAAC,CAAC;AAEH,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;AAEtB,gFAAgF;AAChF,GAAG,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;IAC3C,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAEpE,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,gBAAgB,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAEpC,IAAI,QAAQ,CAAC,WAAW;QAAE,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,QAAQ,CAAC,WAAW,CAAC,CAAC;IAC9E,IAAI,QAAQ,CAAC,aAAa;QAAE,GAAG,CAAC,SAAS,CAAC,gBAAgB,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;IAEpF,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnB,CAAC,CAAC,CAAC;AAEH,gFAAgF;AAChF,KAAK,UAAU,YAAY,CAAC,KAAa;IACvC,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAE3D,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,mBAAmB,KAAK,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IACpC,OAAO,CAAC,GAAG,CAAC,cAAc,MAAM,CAAC,MAAM,iBAAiB,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;IAEhF,6EAA6E;IAC7E,2EAA2E;AAC7E,CAAC;AAED,iFAAiF;AACjF,KAAK,UAAU,UAAU,CAAC,KAAa,EAAE,UAAkB;IACzD,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC3D,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,KAAK,EAAE,CAAC,CAAC;IAEzD,MAAM,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC7D,OAAO,CAAC,GAAG,CAAC,YAAY,UAAU,EAAE,CAAC,CAAC;AACxC,CAAC;AAED,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC"}

package/dist/examples/06-delete.d.ts

@@ -1,17 +0,0 @@
-/**
- * 06-delete.ts
- *
- * Deleting one or many S3 objects.
- *
- * Key points:
- *   - `delete()` is idempotent — calling it on a missing key does not throw.
- *   - Always soft-delete your DB record first, then call `delete()` as cleanup.
- *     A crash between the two steps leaves a recoverable S3 orphan rather than
- *     a missing file with an intact DB row.
- *   - `deleteMany()` is for removing a file and all its variants in one call.
- *     It chunks automatically at 1 000 keys to respect the S3 limit.
- */
-declare function deleteFile(s3Key: string): Promise<void>;
-declare function deleteWithVariants(originalKey: string, thumbnailKey: string, compressedKey: string): Promise<void>;
-declare function deleteOrphans(orphanKeys: string[]): Promise<void>;
-export { deleteFile, deleteWithVariants, deleteOrphans };

package/dist/examples/06-delete.js

@@ -1,44 +0,0 @@
-/**
- * 06-delete.ts
- *
- * Deleting one or many S3 objects.
- *
- * Key points:
- *   - `delete()` is idempotent — calling it on a missing key does not throw.
- *   - Always soft-delete your DB record first, then call `delete()` as cleanup.
- *     A crash between the two steps leaves a recoverable S3 orphan rather than
- *     a missing file with an intact DB row.
- *   - `deleteMany()` is for removing a file and all its variants in one call.
- *     It chunks automatically at 1 000 keys to respect the S3 limit.
- */
-import { AwsFileManager } from "@lib/aws-file-manager";
-const fileManager = new AwsFileManager({
-    region: process.env.AWS_REGION ?? "us-east-1",
-    bucketName: process.env.S3_BUCKET_NAME,
-});
-// ─── Delete a single file ─────────────────────────────────────────────────────
-async function deleteFile(s3Key) {
-    // 1. Soft-delete the DB record first
-    // await db.files.update({ id: fileId, deletedAt: new Date() });
-    // 2. Remove the S3 object as a cleanup step
-    await fileManager.delete(s3Key);
-    console.log(`Deleted: ${s3Key}`);
-}
-// ─── Delete a file and all its variants ──────────────────────────────────────
-// After uploading, your pipeline may generate additional variants (thumbnails,
-// compressed copies). Store all their keys and delete them together.
-async function deleteWithVariants(originalKey, thumbnailKey, compressedKey) {
-    await fileManager.deleteMany([originalKey, thumbnailKey, compressedKey]);
-    console.log("Deleted original + all variants");
-}
-// ─── Batch delete from a reconciliation job ───────────────────────────────────
-// If you have a list of orphaned keys (e.g. found by `list()` but absent from
-// your DB), delete them all at once. `deleteMany` handles chunking internally.
-async function deleteOrphans(orphanKeys) {
-    if (orphanKeys.length === 0)
-        return;
-    await fileManager.deleteMany(orphanKeys);
-    console.log(`Deleted ${orphanKeys.length} orphaned objects`);
-}
-export { deleteFile, deleteWithVariants, deleteOrphans };
-//# sourceMappingURL=06-delete.js.map

package/dist/examples/06-delete.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"06-delete.js","sourceRoot":"","sources":["../../examples/06-delete.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,MAAM,WAAW,GAAG,IAAI,cAAc,CAAC;IACrC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,WAAW;IAC7C,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,cAAe;CACxC,CAAC,CAAC;AAEH,iFAAiF;AACjF,KAAK,UAAU,UAAU,CAAC,KAAa;IACrC,qCAAqC;IACrC,gEAAgE;IAEhE,4CAA4C;IAC5C,MAAM,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAChC,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,EAAE,CAAC,CAAC;AACnC,CAAC;AAED,gFAAgF;AAChF,+EAA+E;AAC/E,qEAAqE;AACrE,KAAK,UAAU,kBAAkB,CAC/B,WAAmB,EACnB,YAAoB,EACpB,aAAqB;IAErB,MAAM,WAAW,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,YAAY,EAAE,aAAa,CAAC,CAAC,CAAC;IACzE,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;AACjD,CAAC;AAED,iFAAiF;AACjF,8EAA8E;AAC9E,+EAA+E;AAC/E,KAAK,UAAU,aAAa,CAAC,UAAoB;IAC/C,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO;IACpC,MAAM,WAAW,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IACzC,OAAO,CAAC,GAAG,CAAC,WAAW,UAAU,CAAC,MAAM,mBAAmB,CAAC,CAAC;AAC/D,CAAC;AAED,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,aAAa,EAAE,CAAC"}

package/dist/examples/07-copy.d.ts

@@ -1,14 +0,0 @@
-/**
- * 07-copy.ts
- *
- * Copying an S3 object within the same bucket.
- *
- * Key points:
- *   - `copy()` is a server-side operation — no bytes move through your server.
- *   - Use it when duplicating entities that own files (e.g. cloning a template).
- *   - Pass `metadata` to override the copied object's metadata; omit it to
- *     inherit the source object's metadata (MetadataDirective=COPY).
- */
-declare function cloneDocument(sourceKey: string, targetOwnerId: string): Promise<string>;
-declare function moveObject(sourceKey: string, destKey: string): Promise<void>;
-export { cloneDocument, moveObject };

package/dist/examples/07-copy.js

@@ -1,35 +0,0 @@
-/**
- * 07-copy.ts
- *
- * Copying an S3 object within the same bucket.
- *
- * Key points:
- *   - `copy()` is a server-side operation — no bytes move through your server.
- *   - Use it when duplicating entities that own files (e.g. cloning a template).
- *   - Pass `metadata` to override the copied object's metadata; omit it to
- *     inherit the source object's metadata (MetadataDirective=COPY).
- */
-import { AwsFileManager } from "@lib/aws-file-manager";
-import { randomUUID } from "crypto";
-const fileManager = new AwsFileManager({
-    region: process.env.AWS_REGION ?? "us-east-1",
-    bucketName: process.env.S3_BUCKET_NAME,
-    basePath: "uploads",
-});
-// ─── Clone a template document ───────────────────────────────────────────────
-async function cloneDocument(sourceKey, targetOwnerId) {
-    const ext = sourceKey.substring(sourceKey.lastIndexOf("."));
-    const destKey = `uploads/${targetOwnerId}/${randomUUID()}${ext}`;
-    await fileManager.copy(sourceKey, destKey);
-    console.log(`Copied ${sourceKey} → ${destKey}`);
-    return destKey;
-}
-// ─── Reorganise a key (rename/move) ──────────────────────────────────────────
-// S3 has no rename — copy to the new key, then delete the old one.
-async function moveObject(sourceKey, destKey) {
-    await fileManager.copy(sourceKey, destKey);
-    await fileManager.delete(sourceKey);
-    console.log(`Moved ${sourceKey} → ${destKey}`);
-}
-export { cloneDocument, moveObject };
-//# sourceMappingURL=07-copy.js.map

package/dist/examples/07-copy.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"07-copy.js","sourceRoot":"","sources":["../../examples/07-copy.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEpC,MAAM,WAAW,GAAG,IAAI,cAAc,CAAC;IACrC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,WAAW;IAC7C,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,cAAe;IACvC,QAAQ,EAAE,SAAS;CACpB,CAAC,CAAC;AAEH,gFAAgF;AAChF,KAAK,UAAU,aAAa,CAC1B,SAAiB,EACjB,aAAqB;IAErB,MAAM,GAAG,GAAG,SAAS,CAAC,SAAS,CAAC,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,WAAW,aAAa,IAAI,UAAU,EAAE,GAAG,GAAG,EAAE,CAAC;IAEjE,MAAM,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAE3C,OAAO,CAAC,GAAG,CAAC,UAAU,SAAS,MAAM,OAAO,EAAE,CAAC,CAAC;IAChD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,gFAAgF;AAChF,mEAAmE;AACnE,KAAK,UAAU,UAAU,CACvB,SAAiB,EACjB,OAAe;IAEf,MAAM,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC3C,MAAM,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACpC,OAAO,CAAC,GAAG,CAAC,SAAS,SAAS,MAAM,OAAO,EAAE,CAAC,CAAC;AACjD,CAAC;AAED,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC"}

package/dist/examples/08-list-paginated.d.ts

@@ -1,16 +0,0 @@
-/**
- * 08-list-paginated.ts
- *
- * Listing objects under a prefix, with pagination.
- *
- * Key points:
- *   - Each call returns up to 1 000 entries (S3 maximum per request).
- *   - `hasMore` and `continuationToken` drive the pagination loop.
- *   - Primarily used for nightly storage reconciliation jobs that walk the
- *     bucket and verify byte counts against the database.
- */
-import { ListEntry } from "@lib/aws-file-manager";
-declare function listAll(folder: string): Promise<ListEntry[]>;
-declare function reconcileStorage(folder: string): Promise<void>;
-declare function listByPrefix(folder: string, prefix: string): Promise<ListEntry[]>;
-export { listAll, reconcileStorage, listByPrefix };

package/dist/examples/08-list-paginated.js

@@ -1,60 +0,0 @@
-/**
- * 08-list-paginated.ts
- *
- * Listing objects under a prefix, with pagination.
- *
- * Key points:
- *   - Each call returns up to 1 000 entries (S3 maximum per request).
- *   - `hasMore` and `continuationToken` drive the pagination loop.
- *   - Primarily used for nightly storage reconciliation jobs that walk the
- *     bucket and verify byte counts against the database.
- */
-import { AwsFileManager } from "@lib/aws-file-manager";
-const fileManager = new AwsFileManager({
-    region: process.env.AWS_REGION ?? "us-east-1",
-    bucketName: process.env.S3_BUCKET_NAME,
-    basePath: "uploads",
-});
-// ─── Collect all entries under a folder ──────────────────────────────────────
-async function listAll(folder) {
-    const allEntries = [];
-    let token;
-    do {
-        const result = await fileManager.list({
-            folder,
-            continuationToken: token,
-        });
-        allEntries.push(...result.entries);
-        token = result.continuationToken;
-    } while (token);
-    console.log(`Found ${allEntries.length} objects in '${folder}'`);
-    return allEntries;
-}
-// ─── Process large result sets in pages ──────────────────────────────────────
-// Avoid accumulating everything in memory when the bucket is very large.
-async function reconcileStorage(folder) {
-    let token;
-    let totalBytes = 0;
-    let pageCount = 0;
-    do {
-        const result = await fileManager.list({
-            folder,
-            maxResults: 500, // smaller pages for memory-constrained jobs
-            continuationToken: token,
-        });
-        pageCount++;
-        for (const entry of result.entries) {
-            totalBytes += entry.size;
-            // Compare entry.key / entry.size against your database here
-        }
-        token = result.continuationToken;
-    } while (token);
-    console.log(`Reconciled ${pageCount} page(s), total: ${totalBytes} bytes`);
-}
-// ─── Filter by prefix within a folder ────────────────────────────────────────
-async function listByPrefix(folder, prefix) {
-    const result = await fileManager.list({ folder, prefix });
-    return result.entries;
-}
-export { listAll, reconcileStorage, listByPrefix };
-//# sourceMappingURL=08-list-paginated.js.map

package/dist/examples/08-list-paginated.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"08-list-paginated.js","sourceRoot":"","sources":["../../examples/08-list-paginated.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,cAAc,EAAa,MAAM,uBAAuB,CAAC;AAElE,MAAM,WAAW,GAAG,IAAI,cAAc,CAAC;IACrC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,WAAW;IAC7C,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,cAAe;IACvC,QAAQ,EAAE,SAAS;CACpB,CAAC,CAAC;AAEH,gFAAgF;AAChF,KAAK,UAAU,OAAO,CAAC,MAAc;IACnC,MAAM,UAAU,GAAgB,EAAE,CAAC;IACnC,IAAI,KAAyB,CAAC;IAE9B,GAAG,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC;YACpC,MAAM;YACN,iBAAiB,EAAE,KAAK;SACzB,CAAC,CAAC;QACH,UAAU,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QACnC,KAAK,GAAG,MAAM,CAAC,iBAAiB,CAAC;IACnC,CAAC,QAAQ,KAAK,EAAE;IAEhB,OAAO,CAAC,GAAG,CAAC,SAAS,UAAU,CAAC,MAAM,gBAAgB,MAAM,GAAG,CAAC,CAAC;IACjE,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,gFAAgF;AAChF,yEAAyE;AACzE,KAAK,UAAU,gBAAgB,CAAC,MAAc;IAC5C,IAAI,KAAyB,CAAC;IAC9B,IAAI,UAAU,GAAG,CAAC,CAAC;IACnB,IAAI,SAAS,GAAG,CAAC,CAAC;IAElB,GAAG,CAAC;QACF,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC;YACpC,MAAM;YACN,UAAU,EAAE,GAAG,EAAE,4CAA4C;YAC7D,iBAAiB,EAAE,KAAK;SACzB,CAAC,CAAC;QAEH,SAAS,EAAE,CAAC;QACZ,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnC,UAAU,IAAI,KAAK,CAAC,IAAI,CAAC;YACzB,4DAA4D;QAC9D,CAAC;QAED,KAAK,GAAG,MAAM,CAAC,iBAAiB,CAAC;IACnC,CAAC,QAAQ,KAAK,EAAE;IAEhB,OAAO,CAAC,GAAG,CAAC,cAAc,SAAS,oBAAoB,UAAU,QAAQ,CAAC,CAAC;AAC7E,CAAC;AAED,gFAAgF;AAChF,KAAK,UAAU,YAAY,CAAC,MAAc,EAAE,MAAc;IACxD,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1D,OAAO,MAAM,CAAC,OAAO,CAAC;AACxB,CAAC;AAED,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,CAAC"}

package/dist/examples/09-exists.d.ts

@@ -1,13 +0,0 @@
-/**
- * 09-exists.ts
- *
- * Checking whether an S3 object exists at a given key.
- *
- * Key points:
- *   - `exists()` returns `false` for missing keys; it does not throw.
- *   - Useful as a lightweight data integrity check before an operation.
- *   - Not a replacement for proper error handling — network errors still throw.
- */
-declare function assertFileExists(s3Key: string): Promise<void>;
-declare function uploadIfAbsent(s3Key: string, uploadFn: () => Promise<void>): Promise<void>;
-export { assertFileExists, uploadIfAbsent };

package/dist/examples/09-exists.js

@@ -1,32 +0,0 @@
-/**
- * 09-exists.ts
- *
- * Checking whether an S3 object exists at a given key.
- *
- * Key points:
- *   - `exists()` returns `false` for missing keys; it does not throw.
- *   - Useful as a lightweight data integrity check before an operation.
- *   - Not a replacement for proper error handling — network errors still throw.
- */
-import { AwsFileManager } from "@lib/aws-file-manager";
-const fileManager = new AwsFileManager({
-    region: process.env.AWS_REGION ?? "us-east-1",
-    bucketName: process.env.S3_BUCKET_NAME,
-});
-// ─── Guard before serving a file ─────────────────────────────────────────────
-async function assertFileExists(s3Key) {
-    const found = await fileManager.exists(s3Key);
-    if (!found) {
-        throw new Error(`Storage integrity error: file missing at key "${s3Key}"`);
-    }
-}
-// ─── Skip re-uploading if the file is already there ──────────────────────────
-async function uploadIfAbsent(s3Key, uploadFn) {
-    if (await fileManager.exists(s3Key)) {
-        console.log(`Skipping upload — key already exists: ${s3Key}`);
-        return;
-    }
-    await uploadFn();
-}
-export { assertFileExists, uploadIfAbsent };
-//# sourceMappingURL=09-exists.js.map

package/dist/examples/09-exists.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"09-exists.js","sourceRoot":"","sources":["../../examples/09-exists.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,MAAM,WAAW,GAAG,IAAI,cAAc,CAAC;IACrC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,WAAW;IAC7C,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,cAAe;CACxC,CAAC,CAAC;AAEH,gFAAgF;AAChF,KAAK,UAAU,gBAAgB,CAAC,KAAa;IAC3C,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9C,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,KAAK,CAAC,iDAAiD,KAAK,GAAG,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC;AAED,gFAAgF;AAChF,KAAK,UAAU,cAAc,CAC3B,KAAa,EACb,QAA6B;IAE7B,IAAI,MAAM,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,yCAAyC,KAAK,EAAE,CAAC,CAAC;QAC9D,OAAO;IACT,CAAC;IACD,MAAM,QAAQ,EAAE,CAAC;AACnB,CAAC;AAED,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAAE,CAAC"}

package/dist/tests/aws-file-manager.test.d.ts

@@ -1 +0,0 @@
-export {};