@fluxfiles/node 0.1.7 → 0.1.9

package/dist/index.d.mts

@@ -5,7 +5,7 @@ type FluxPermission = 'read' | 'write' | 'delete' | 'audit';
  * decrypted only at runtime by the FluxFiles server. Only S3-compatible
  * storage is allowed — the server rejects the `local` driver.
  */
-interface ByobDiskConfig {
+interface ByobS3DiskConfig {
     driver: 's3';
     key: string;
     secret: string;
@@ -17,6 +17,22 @@ interface ByobDiskConfig {
     /** Public base URL for direct (unsigned) object links on a public disk. */
     public_url?: string;
 }
+/**
+ * A BYOB SFTP disk — a user's own SFTP server (e.g. a VPS). Auth is a password OR
+ * a private key. The server SSRF-checks the host (no loopback/private/metadata
+ * targets). SFTP files are streamed through the app (no static/presigned URL).
+ */
+interface ByobSftpDiskConfig {
+    driver: 'sftp';
+    host: string;
+    username: string;
+    password?: string;
+    private_key?: string;
+    private_key_passphrase?: string;
+    port?: number;
+    root?: string;
+}
+type ByobDiskConfig = ByobS3DiskConfig | ByobSftpDiskConfig;
 /** Options shared by all token builders. */
 interface BaseTokenOptions {
     /** HS256 signing secret. Defaults to `process.env.FLUXFILES_SECRET`. Must be ≥ 32 bytes. */
@@ -69,6 +85,8 @@ interface BaseTokenOptions {
     /** May this token mint clean original download URLs? Default true. `false` = preview-only
      *  (list withholds url/permanent_url/variants; GET presign is denied — only watermarked img_base). */
     allowDownload?: boolean;
+    /** Allow chmod (POST /api/fm/chmod) on an SFTP disk. Default true; `false` = read-only permissions. */
+    allowChmod?: boolean;
     /** Enable on-the-fly watermark on `/api/fm/img` (source file is never modified). Default off. */
     watermarkEnabled?: boolean;
     /** Watermark kind: 'text' or 'logo' (a PNG path in storage). Default 'text'. */

package/dist/index.d.ts

@@ -5,7 +5,7 @@ type FluxPermission = 'read' | 'write' | 'delete' | 'audit';
  * decrypted only at runtime by the FluxFiles server. Only S3-compatible
  * storage is allowed — the server rejects the `local` driver.
  */
-interface ByobDiskConfig {
+interface ByobS3DiskConfig {
     driver: 's3';
     key: string;
     secret: string;
@@ -17,6 +17,22 @@ interface ByobDiskConfig {
     /** Public base URL for direct (unsigned) object links on a public disk. */
     public_url?: string;
 }
+/**
+ * A BYOB SFTP disk — a user's own SFTP server (e.g. a VPS). Auth is a password OR
+ * a private key. The server SSRF-checks the host (no loopback/private/metadata
+ * targets). SFTP files are streamed through the app (no static/presigned URL).
+ */
+interface ByobSftpDiskConfig {
+    driver: 'sftp';
+    host: string;
+    username: string;
+    password?: string;
+    private_key?: string;
+    private_key_passphrase?: string;
+    port?: number;
+    root?: string;
+}
+type ByobDiskConfig = ByobS3DiskConfig | ByobSftpDiskConfig;
 /** Options shared by all token builders. */
 interface BaseTokenOptions {
     /** HS256 signing secret. Defaults to `process.env.FLUXFILES_SECRET`. Must be ≥ 32 bytes. */
@@ -69,6 +85,8 @@ interface BaseTokenOptions {
     /** May this token mint clean original download URLs? Default true. `false` = preview-only
      *  (list withholds url/permanent_url/variants; GET presign is denied — only watermarked img_base). */
     allowDownload?: boolean;
+    /** Allow chmod (POST /api/fm/chmod) on an SFTP disk. Default true; `false` = read-only permissions. */
+    allowChmod?: boolean;
     /** Enable on-the-fly watermark on `/api/fm/img` (source file is never modified). Default off. */
     watermarkEnabled?: boolean;
     /** Watermark kind: 'text' or 'logo' (a PNG path in storage). Default 'text'. */

package/dist/index.js

@@ -158,6 +158,7 @@ function applyTenantOverrides(payload, opts) {
   if (opts.webpMaxWidth && opts.webpMaxWidth > 0) payload.webp_max_width = Math.trunc(opts.webpMaxWidth);
   if (opts.webpDefaultQuality && opts.webpDefaultQuality > 0) payload.webp_default_quality = Math.trunc(opts.webpDefaultQuality);
   if (opts.allowDownload !== void 0) payload.allow_download = !!opts.allowDownload;
+  if (opts.allowChmod !== void 0) payload.allow_chmod = !!opts.allowChmod;
   if (opts.watermarkEnabled) {
     payload.watermark_enabled = true;
     if (opts.watermarkType) payload.watermark_type = opts.watermarkType;
@@ -174,8 +175,19 @@ function applyTenantOverrides(payload, opts) {
   if (opts.usageFolderDepth && opts.usageFolderDepth > 0) payload.usage_folder_depth = Math.trunc(opts.usageFolderDepth);
 }
 function validateByobDisk(name, config) {
-  if (!config || config.driver !== "s3") {
-    throw new Error(`FluxFiles BYOB disk "${name}": driver must be "s3" (the server rejects "local").`);
+  if (!config || config.driver !== "s3" && config.driver !== "sftp") {
+    throw new Error(`FluxFiles BYOB disk "${name}": driver must be "s3" or "sftp" (the server rejects "local").`);
+  }
+  if (config.driver === "sftp") {
+    for (const field of ["host", "username"]) {
+      if (!config[field]) {
+        throw new Error(`FluxFiles BYOB disk "${name}": missing required "${field}".`);
+      }
+    }
+    if (!config.password && !config.private_key) {
+      throw new Error(`FluxFiles BYOB disk "${name}": needs a "password" or "private_key".`);
+    }
+    return;
   }
   for (const field of ["key", "secret", "bucket"]) {
     if (!config[field]) {

package/dist/index.mjs

@@ -136,6 +136,7 @@ function applyTenantOverrides(payload, opts) {
   if (opts.webpMaxWidth && opts.webpMaxWidth > 0) payload.webp_max_width = Math.trunc(opts.webpMaxWidth);
   if (opts.webpDefaultQuality && opts.webpDefaultQuality > 0) payload.webp_default_quality = Math.trunc(opts.webpDefaultQuality);
   if (opts.allowDownload !== void 0) payload.allow_download = !!opts.allowDownload;
+  if (opts.allowChmod !== void 0) payload.allow_chmod = !!opts.allowChmod;
   if (opts.watermarkEnabled) {
     payload.watermark_enabled = true;
     if (opts.watermarkType) payload.watermark_type = opts.watermarkType;
@@ -152,8 +153,19 @@ function applyTenantOverrides(payload, opts) {
   if (opts.usageFolderDepth && opts.usageFolderDepth > 0) payload.usage_folder_depth = Math.trunc(opts.usageFolderDepth);
 }
 function validateByobDisk(name, config) {
-  if (!config || config.driver !== "s3") {
-    throw new Error(`FluxFiles BYOB disk "${name}": driver must be "s3" (the server rejects "local").`);
+  if (!config || config.driver !== "s3" && config.driver !== "sftp") {
+    throw new Error(`FluxFiles BYOB disk "${name}": driver must be "s3" or "sftp" (the server rejects "local").`);
+  }
+  if (config.driver === "sftp") {
+    for (const field of ["host", "username"]) {
+      if (!config[field]) {
+        throw new Error(`FluxFiles BYOB disk "${name}": missing required "${field}".`);
+      }
+    }
+    if (!config.password && !config.private_key) {
+      throw new Error(`FluxFiles BYOB disk "${name}": needs a "password" or "private_key".`);
+    }
+    return;
   }
   for (const field of ["key", "secret", "bucket"]) {
     if (!config[field]) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluxfiles/node",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "Server-side Node/TypeScript SDK for minting FluxFiles JWTs (plain + BYOB), byte-compatible with the PHP core",
   "license": "MIT",
   "sideEffects": false,

package/src/token.ts

@@ -128,6 +128,7 @@ function applyTenantOverrides(payload: Record<string, unknown>, opts: BaseTokenO
 
   // Download gate + watermark.
   if (opts.allowDownload !== undefined) payload.allow_download = !!opts.allowDownload;
+  if (opts.allowChmod !== undefined) payload.allow_chmod = !!opts.allowChmod;
   if (opts.watermarkEnabled) {
     payload.watermark_enabled = true;
     if (opts.watermarkType) payload.watermark_type = opts.watermarkType;
@@ -151,8 +152,19 @@ function applyTenantOverrides(payload: Record<string, unknown>, opts: BaseTokenO
  * SSRF checks on the endpoint), so this only catches obvious mistakes early.
  */
 function validateByobDisk(name: string, config: ByobDiskConfig): void {
-  if (!config || config.driver !== 's3') {
-    throw new Error(`FluxFiles BYOB disk "${name}": driver must be "s3" (the server rejects "local").`);
+  if (!config || (config.driver !== 's3' && config.driver !== 'sftp')) {
+    throw new Error(`FluxFiles BYOB disk "${name}": driver must be "s3" or "sftp" (the server rejects "local").`);
+  }
+  if (config.driver === 'sftp') {
+    for (const field of ['host', 'username'] as const) {
+      if (!config[field]) {
+        throw new Error(`FluxFiles BYOB disk "${name}": missing required "${field}".`);
+      }
+    }
+    if (!config.password && !config.private_key) {
+      throw new Error(`FluxFiles BYOB disk "${name}": needs a "password" or "private_key".`);
+    }
+    return;
   }
   for (const field of ['key', 'secret', 'bucket'] as const) {
     if (!config[field]) {

package/src/types.ts

@@ -6,7 +6,7 @@ export type FluxPermission = 'read' | 'write' | 'delete' | 'audit';
  * decrypted only at runtime by the FluxFiles server. Only S3-compatible
  * storage is allowed — the server rejects the `local` driver.
  */
-export interface ByobDiskConfig {
+export interface ByobS3DiskConfig {
   driver: 's3';
   key: string;
   secret: string;
@@ -19,6 +19,24 @@ export interface ByobDiskConfig {
   public_url?: string;
 }
 
+/**
+ * A BYOB SFTP disk — a user's own SFTP server (e.g. a VPS). Auth is a password OR
+ * a private key. The server SSRF-checks the host (no loopback/private/metadata
+ * targets). SFTP files are streamed through the app (no static/presigned URL).
+ */
+export interface ByobSftpDiskConfig {
+  driver: 'sftp';
+  host: string;
+  username: string;
+  password?: string;
+  private_key?: string;
+  private_key_passphrase?: string;
+  port?: number;
+  root?: string;
+}
+
+export type ByobDiskConfig = ByobS3DiskConfig | ByobSftpDiskConfig;
+
 /** Options shared by all token builders. */
 export interface BaseTokenOptions {
   /** HS256 signing secret. Defaults to `process.env.FLUXFILES_SECRET`. Must be ≥ 32 bytes. */
@@ -71,6 +89,8 @@ export interface BaseTokenOptions {
   /** May this token mint clean original download URLs? Default true. `false` = preview-only
    *  (list withholds url/permanent_url/variants; GET presign is denied — only watermarked img_base). */
   allowDownload?: boolean;
+  /** Allow chmod (POST /api/fm/chmod) on an SFTP disk. Default true; `false` = read-only permissions. */
+  allowChmod?: boolean;
   /** Enable on-the-fly watermark on `/api/fm/img` (source file is never modified). Default off. */
   watermarkEnabled?: boolean;
   /** Watermark kind: 'text' or 'logo' (a PNG path in storage). Default 'text'. */