naystack 1.8.11 → 1.8.13

package/dist/file/put.cjs.js

@@ -152,7 +152,7 @@ function checkClient(client2) {
   if (!client2) throw new Error("Client does not exist");
   return true;
 }
-var uploadBlob = async (file, key) => {
+var uploadBlob = async (file, key, overrides) => {
   if (!checkClient(client)) return;
   const fileBuffer = await file.arrayBuffer();
   return client.send(
@@ -162,7 +162,8 @@ var uploadBlob = async (file, key) => {
       ACL: "public-read",
       Body: Buffer.from(fileBuffer),
       ContentType: file.type,
-      ContentLength: file.size
+      ContentLength: file.size,
+      ...overrides
     })
   );
 };
@@ -185,8 +186,9 @@ var getFileUploadPutRoute = (options) => async (req) => {
   const fileKey = options.getKey ? await options.getKey(inputData) : (0, import_uuid.v4)();
   const url = getDownloadURL(fileKey);
   const blob = options.processFile ? await options.processFile(file, inputData) : file;
-  if (async) (0, import_functions.waitUntil)(uploadBlob(blob, fileKey));
-  else await uploadBlob(blob, fileKey);
+  const put = options.putOptions?.(inputData);
+  if (async) (0, import_functions.waitUntil)(uploadBlob(blob, fileKey, put));
+  else await uploadBlob(blob, fileKey, put);
   const onUploadResponse = await options.onUpload({
     ...inputData,
     url

package/dist/file/put.d.mts

@@ -1,5 +1,7 @@
 import { NextRequest, NextResponse } from 'next/server';
 import { SetupFileUploadOptions } from './setup.mjs';
+import './utils.mjs';
+import '@aws-sdk/client-s3';
 
 /**
  * Returns the PUT route handler for file upload.

package/dist/file/put.d.ts

@@ -1,5 +1,7 @@
 import { NextRequest, NextResponse } from 'next/server';
 import { SetupFileUploadOptions } from './setup.js';
+import './utils.js';
+import '@aws-sdk/client-s3';
 
 /**
  * Returns the PUT route handler for file upload.

package/dist/file/put.esm.js

@@ -132,7 +132,7 @@ function checkClient(client2) {
   if (!client2) throw new Error("Client does not exist");
   return true;
 }
-var uploadBlob = async (file, key) => {
+var uploadBlob = async (file, key, overrides) => {
   if (!checkClient(client)) return;
   const fileBuffer = await file.arrayBuffer();
   return client.send(
@@ -142,7 +142,8 @@ var uploadBlob = async (file, key) => {
       ACL: "public-read",
       Body: Buffer.from(fileBuffer),
       ContentType: file.type,
-      ContentLength: file.size
+      ContentLength: file.size,
+      ...overrides
     })
   );
 };
@@ -165,8 +166,9 @@ var getFileUploadPutRoute = (options) => async (req) => {
   const fileKey = options.getKey ? await options.getKey(inputData) : v4();
   const url = getDownloadURL(fileKey);
   const blob = options.processFile ? await options.processFile(file, inputData) : file;
-  if (async) waitUntil(uploadBlob(blob, fileKey));
-  else await uploadBlob(blob, fileKey);
+  const put = options.putOptions?.(inputData);
+  if (async) waitUntil(uploadBlob(blob, fileKey, put));
+  else await uploadBlob(blob, fileKey, put);
   const onUploadResponse = await options.onUpload({
     ...inputData,
     url

package/dist/file/setup.cjs.js

@@ -154,7 +154,7 @@ function checkClient(client2) {
   if (!client2) throw new Error("Client does not exist");
   return true;
 }
-var uploadBlob = async (file, key) => {
+var uploadBlob = async (file, key, overrides) => {
   if (!checkClient(client)) return;
   const fileBuffer = await file.arrayBuffer();
   return client.send(
@@ -164,7 +164,8 @@ var uploadBlob = async (file, key) => {
       ACL: "public-read",
       Body: Buffer.from(fileBuffer),
       ContentType: file.type,
-      ContentLength: file.size
+      ContentLength: file.size,
+      ...overrides
     })
   );
 };
@@ -187,8 +188,9 @@ var getFileUploadPutRoute = (options) => async (req) => {
   const fileKey = options.getKey ? await options.getKey(inputData) : (0, import_uuid.v4)();
   const url = getDownloadURL(fileKey);
   const blob = options.processFile ? await options.processFile(file, inputData) : file;
-  if (async) (0, import_functions.waitUntil)(uploadBlob(blob, fileKey));
-  else await uploadBlob(blob, fileKey);
+  const put = options.putOptions?.(inputData);
+  if (async) (0, import_functions.waitUntil)(uploadBlob(blob, fileKey, put));
+  else await uploadBlob(blob, fileKey, put);
   const onUploadResponse = await options.onUpload({
     ...inputData,
     url

package/dist/file/setup.d.mts

@@ -1,13 +1,24 @@
 import * as next_server from 'next/server';
+import { PutOverrides } from './utils.mjs';
+import '@aws-sdk/client-s3';
 
 /**
  * Options for setting up file upload via {@link setupFileUpload}.
  *
+ * Every callback receives the same `{ type, userId, data }` context. **`data` is
+ * optional** — it is whatever the caller passed as `config.data` to
+ * `useFileUpload`, and the client only appends the form field when a value is
+ * given, so the route parses it to `undefined` otherwise. Narrow it before use;
+ * destructuring it unguarded throws at runtime.
+ *
  * @property getKey - Optional. Given `{ type, userId, data }`, returns the S3 object key for the upload. If omitted, a UUID is generated.
  * @property processFile - Optional. Given the uploaded `file` and `{ type, userId, data }`, returns the blob to
  *   store in its place — e.g. re-encoding an image, or stripping metadata. Runs after authentication and before the
  *   S3 write, so only the returned bytes are ever stored. The blob's `type` becomes the object's `Content-Type`,
  *   so change it when the format changes. Return the file unchanged to leave it alone. Throwing fails the upload.
+ * @property putOptions - Optional. Given `{ type, userId, data }`, returns fields to set on the S3 put —
+ *   `CacheControl`, `ContentDisposition`, `Metadata` and so on. A function rather than a static object so
+ *   headers can differ per upload kind. See {@link PutOverrides}.
  * @property onUpload - **Required.** Called after each successful upload with `{ url, type, userId, data }`.
  *   The return value is included in the API response as `onUploadResponse` (e.g. save metadata to your database and return it).
  *
@@ -17,18 +28,23 @@ interface SetupFileUploadOptions {
     getKey?: (data: {
         type: string;
         userId: number;
-        data: object;
+        data?: object;
     }) => Promise<string>;
     processFile?: (file: File, data: {
         type: string;
         userId: number;
-        data: object;
+        data?: object;
     }) => Promise<Blob>;
+    putOptions?: (data: {
+        type: string;
+        userId: number;
+        data?: object;
+    }) => PutOverrides;
     onUpload: (data: {
         url: string | null;
         type: string;
         userId: number;
-        data: object;
+        data?: object;
     }) => Promise<object>;
 }
 /**
@@ -55,7 +71,9 @@ interface SetupFileUploadOptions {
  * export const { PUT } = setupFileUpload({
  *   onUpload: async ({ url, type, userId, data }) => {
  *     if (type === "DealDocument" && url) {
- *       const payload = data as { dealId: number; fileName: string };
+ *       // `data` is absent unless the client sent one — check before reading it.
+ *       const payload = data as { dealId?: number; fileName?: string } | undefined;
+ *       if (!payload?.dealId) return {};
  *       const [row] = await db.insert(DocumentsTable).values({
  *         dealId: payload.dealId, fileURL: url, fileName: payload.fileName,
  *       }).returning();

package/dist/file/setup.d.ts

@@ -1,13 +1,24 @@
 import * as next_server from 'next/server';
+import { PutOverrides } from './utils.js';
+import '@aws-sdk/client-s3';
 
 /**
  * Options for setting up file upload via {@link setupFileUpload}.
  *
+ * Every callback receives the same `{ type, userId, data }` context. **`data` is
+ * optional** — it is whatever the caller passed as `config.data` to
+ * `useFileUpload`, and the client only appends the form field when a value is
+ * given, so the route parses it to `undefined` otherwise. Narrow it before use;
+ * destructuring it unguarded throws at runtime.
+ *
  * @property getKey - Optional. Given `{ type, userId, data }`, returns the S3 object key for the upload. If omitted, a UUID is generated.
  * @property processFile - Optional. Given the uploaded `file` and `{ type, userId, data }`, returns the blob to
  *   store in its place — e.g. re-encoding an image, or stripping metadata. Runs after authentication and before the
  *   S3 write, so only the returned bytes are ever stored. The blob's `type` becomes the object's `Content-Type`,
  *   so change it when the format changes. Return the file unchanged to leave it alone. Throwing fails the upload.
+ * @property putOptions - Optional. Given `{ type, userId, data }`, returns fields to set on the S3 put —
+ *   `CacheControl`, `ContentDisposition`, `Metadata` and so on. A function rather than a static object so
+ *   headers can differ per upload kind. See {@link PutOverrides}.
  * @property onUpload - **Required.** Called after each successful upload with `{ url, type, userId, data }`.
  *   The return value is included in the API response as `onUploadResponse` (e.g. save metadata to your database and return it).
  *
@@ -17,18 +28,23 @@ interface SetupFileUploadOptions {
     getKey?: (data: {
         type: string;
         userId: number;
-        data: object;
+        data?: object;
     }) => Promise<string>;
     processFile?: (file: File, data: {
         type: string;
         userId: number;
-        data: object;
+        data?: object;
     }) => Promise<Blob>;
+    putOptions?: (data: {
+        type: string;
+        userId: number;
+        data?: object;
+    }) => PutOverrides;
     onUpload: (data: {
         url: string | null;
         type: string;
         userId: number;
-        data: object;
+        data?: object;
     }) => Promise<object>;
 }
 /**
@@ -55,7 +71,9 @@ interface SetupFileUploadOptions {
  * export const { PUT } = setupFileUpload({
  *   onUpload: async ({ url, type, userId, data }) => {
  *     if (type === "DealDocument" && url) {
- *       const payload = data as { dealId: number; fileName: string };
+ *       // `data` is absent unless the client sent one — check before reading it.
+ *       const payload = data as { dealId?: number; fileName?: string } | undefined;
+ *       if (!payload?.dealId) return {};
  *       const [row] = await db.insert(DocumentsTable).values({
  *         dealId: payload.dealId, fileURL: url, fileName: payload.fileName,
  *       }).returning();

package/dist/file/setup.esm.js

@@ -132,7 +132,7 @@ function checkClient(client2) {
   if (!client2) throw new Error("Client does not exist");
   return true;
 }
-var uploadBlob = async (file, key) => {
+var uploadBlob = async (file, key, overrides) => {
   if (!checkClient(client)) return;
   const fileBuffer = await file.arrayBuffer();
   return client.send(
@@ -142,7 +142,8 @@ var uploadBlob = async (file, key) => {
       ACL: "public-read",
       Body: Buffer.from(fileBuffer),
       ContentType: file.type,
-      ContentLength: file.size
+      ContentLength: file.size,
+      ...overrides
     })
   );
 };
@@ -165,8 +166,9 @@ var getFileUploadPutRoute = (options) => async (req) => {
   const fileKey = options.getKey ? await options.getKey(inputData) : v4();
   const url = getDownloadURL(fileKey);
   const blob = options.processFile ? await options.processFile(file, inputData) : file;
-  if (async) waitUntil(uploadBlob(blob, fileKey));
-  else await uploadBlob(blob, fileKey);
+  const put = options.putOptions?.(inputData);
+  if (async) waitUntil(uploadBlob(blob, fileKey, put));
+  else await uploadBlob(blob, fileKey, put);
   const onUploadResponse = await options.onUpload({
     ...inputData,
     url

package/dist/file/utils.cjs.js

@@ -107,14 +107,15 @@ var getDownloadURL = (keys) => {
 };
 var uploadFile = async (keys, {
   url,
-  blob
+  blob,
+  put
 }) => {
   if (!checkClient(client)) return;
   if (!blob && !url) return null;
   const fileBlob = blob || await fetch(url).then((file) => file.blob());
   if (fileBlob) {
     const key = getKey(keys);
-    await uploadBlob(fileBlob, key);
+    await uploadBlob(fileBlob, key, put);
     return getDownloadURL(key);
   }
   return null;
@@ -141,7 +142,7 @@ function checkClient(client2) {
   if (!client2) throw new Error("Client does not exist");
   return true;
 }
-var uploadBlob = async (file, key) => {
+var uploadBlob = async (file, key, overrides) => {
   if (!checkClient(client)) return;
   const fileBuffer = await file.arrayBuffer();
   return client.send(
@@ -151,7 +152,8 @@ var uploadBlob = async (file, key) => {
       ACL: "public-read",
       Body: Buffer.from(fileBuffer),
       ContentType: file.type,
-      ContentLength: file.size
+      ContentLength: file.size,
+      ...overrides
     })
   );
 };

package/dist/file/utils.d.mts

@@ -1,5 +1,18 @@
 import * as _aws_sdk_client_s3 from '@aws-sdk/client-s3';
+import { PutObjectCommandInput } from '@aws-sdk/client-s3';
 
+/**
+ * Fields a caller may set on the underlying S3 put — `CacheControl`,
+ * `ContentDisposition`, `Metadata`, `StorageClass`, and so on. Spread over the
+ * defaults, so anything given here wins.
+ *
+ * What identifies the upload — `Bucket`, `Key`, `Body` — is deliberately not
+ * overridable: those are naystack's to set, and replacing them would silently
+ * write the wrong bytes or the wrong object rather than fail.
+ *
+ * @category File
+ */
+type PutOverrides = Omit<PutObjectCommandInput, "Bucket" | "Key" | "Body">;
 /**
  * Generates a presigned PUT URL for uploading a file to the given S3 key(s).
  * The URL expires after 5 minutes.
@@ -23,12 +36,14 @@ declare const getDownloadURL: (keys: string | string[]) => string;
  * @param keys - S3 key or key path segments (array joined by `/`).
  * @param options.blob - A Blob/File to upload directly.
  * @param options.url - A remote URL to fetch and upload. Ignored if `blob` is provided.
+ * @param options.put - Fields to set on the S3 put. See {@link PutOverrides}.
  * @returns The public download URL of the uploaded file, or `null` if neither `blob` nor `url` was provided.
  * @category File
  */
-declare const uploadFile: (keys: string | string[], { url, blob, }: {
+declare const uploadFile: (keys: string | string[], { url, blob, put, }: {
     blob?: Blob;
     url?: string;
+    put?: PutOverrides;
 }) => Promise<string | null | undefined>;
 /**
  * Deletes an S3 object identified by its full public URL.
@@ -43,9 +58,10 @@ declare const deleteFile: (url: string) => Promise<boolean | undefined>;
  *
  * @param file - The Blob or File to upload.
  * @param key - The S3 object key.
+ * @param overrides - Fields to set on the put, spread over the defaults below. See {@link PutOverrides}.
  * @returns The `PutObjectCommandOutput` from S3.
  * @category File
  */
-declare const uploadBlob: (file: File | Blob, key: string) => Promise<_aws_sdk_client_s3.PutObjectCommandOutput | undefined>;
+declare const uploadBlob: (file: File | Blob, key: string, overrides?: PutOverrides) => Promise<_aws_sdk_client_s3.PutObjectCommandOutput | undefined>;
 
-export { deleteFile, getDownloadURL, getUploadURL, uploadBlob, uploadFile };
+export { type PutOverrides, deleteFile, getDownloadURL, getUploadURL, uploadBlob, uploadFile };

package/dist/file/utils.d.ts

@@ -1,5 +1,18 @@
 import * as _aws_sdk_client_s3 from '@aws-sdk/client-s3';
+import { PutObjectCommandInput } from '@aws-sdk/client-s3';
 
+/**
+ * Fields a caller may set on the underlying S3 put — `CacheControl`,
+ * `ContentDisposition`, `Metadata`, `StorageClass`, and so on. Spread over the
+ * defaults, so anything given here wins.
+ *
+ * What identifies the upload — `Bucket`, `Key`, `Body` — is deliberately not
+ * overridable: those are naystack's to set, and replacing them would silently
+ * write the wrong bytes or the wrong object rather than fail.
+ *
+ * @category File
+ */
+type PutOverrides = Omit<PutObjectCommandInput, "Bucket" | "Key" | "Body">;
 /**
  * Generates a presigned PUT URL for uploading a file to the given S3 key(s).
  * The URL expires after 5 minutes.
@@ -23,12 +36,14 @@ declare const getDownloadURL: (keys: string | string[]) => string;
  * @param keys - S3 key or key path segments (array joined by `/`).
  * @param options.blob - A Blob/File to upload directly.
  * @param options.url - A remote URL to fetch and upload. Ignored if `blob` is provided.
+ * @param options.put - Fields to set on the S3 put. See {@link PutOverrides}.
  * @returns The public download URL of the uploaded file, or `null` if neither `blob` nor `url` was provided.
  * @category File
  */
-declare const uploadFile: (keys: string | string[], { url, blob, }: {
+declare const uploadFile: (keys: string | string[], { url, blob, put, }: {
     blob?: Blob;
     url?: string;
+    put?: PutOverrides;
 }) => Promise<string | null | undefined>;
 /**
  * Deletes an S3 object identified by its full public URL.
@@ -43,9 +58,10 @@ declare const deleteFile: (url: string) => Promise<boolean | undefined>;
  *
  * @param file - The Blob or File to upload.
  * @param key - The S3 object key.
+ * @param overrides - Fields to set on the put, spread over the defaults below. See {@link PutOverrides}.
  * @returns The `PutObjectCommandOutput` from S3.
  * @category File
  */
-declare const uploadBlob: (file: File | Blob, key: string) => Promise<_aws_sdk_client_s3.PutObjectCommandOutput | undefined>;
+declare const uploadBlob: (file: File | Blob, key: string, overrides?: PutOverrides) => Promise<_aws_sdk_client_s3.PutObjectCommandOutput | undefined>;
 
-export { deleteFile, getDownloadURL, getUploadURL, uploadBlob, uploadFile };
+export { type PutOverrides, deleteFile, getDownloadURL, getUploadURL, uploadBlob, uploadFile };

package/dist/file/utils.esm.js

@@ -83,14 +83,15 @@ var getDownloadURL = (keys) => {
 };
 var uploadFile = async (keys, {
   url,
-  blob
+  blob,
+  put
 }) => {
   if (!checkClient(client)) return;
   if (!blob && !url) return null;
   const fileBlob = blob || await fetch(url).then((file) => file.blob());
   if (fileBlob) {
     const key = getKey(keys);
-    await uploadBlob(fileBlob, key);
+    await uploadBlob(fileBlob, key, put);
     return getDownloadURL(key);
   }
   return null;
@@ -117,7 +118,7 @@ function checkClient(client2) {
   if (!client2) throw new Error("Client does not exist");
   return true;
 }
-var uploadBlob = async (file, key) => {
+var uploadBlob = async (file, key, overrides) => {
   if (!checkClient(client)) return;
   const fileBuffer = await file.arrayBuffer();
   return client.send(
@@ -127,7 +128,8 @@ var uploadBlob = async (file, key) => {
       ACL: "public-read",
       Body: Buffer.from(fileBuffer),
       ContentType: file.type,
-      ContentLength: file.size
+      ContentLength: file.size,
+      ...overrides
     })
   );
 };

package/dist/index.d.mts

@@ -10,7 +10,7 @@
  * - `naystack/file` — S3 file upload setup
  * - `naystack/file/client` — Client-side file upload hook (useFileUpload)
  * - `naystack/client` — Client hooks (useVisibility, useBreakpoint) and SEO (setupSEO)
- * - `naystack/socials` — Instagram and Threads API helpers
+ * - `naystack/socials` — publish to and read from Instagram and Threads
  *
  * @module
  */

package/dist/index.d.ts

@@ -10,7 +10,7 @@
  * - `naystack/file` — S3 file upload setup
  * - `naystack/file/client` — Client-side file upload hook (useFileUpload)
  * - `naystack/client` — Client hooks (useVisibility, useBreakpoint) and SEO (setupSEO)
- * - `naystack/socials` — Instagram and Threads API helpers
+ * - `naystack/socials` — publish to and read from Instagram and Threads
  *
  * @module
  */