@fluxfiles/node 0.1.5 → 0.1.7

package/dist/index.d.mts

@@ -66,6 +66,33 @@ interface BaseTokenOptions {
     webpMaxWidth?: number;
     /** Default WebP quality when a request omits it. `0`/omitted = inherit (80). */
     webpDefaultQuality?: number;
+    /** 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;
+    /** 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'. */
+    watermarkType?: 'text' | 'logo';
+    /** Watermark text (for type 'text'). */
+    watermarkText?: string;
+    /** Storage path to the logo PNG (for type 'logo'); missing → text fallback. */
+    watermarkLogoPath?: string;
+    /** Position: top-left / top-right / bottom-left / bottom-right / center. Default bottom-right. */
+    watermarkPosition?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'center';
+    /** Opacity 0.0–1.0. Default 0.6. */
+    watermarkOpacity?: number;
+    /** Font size for text watermark. Default 24. */
+    watermarkFontSize?: number;
+    /** Usage-summary cache TTL (seconds). `0`/omitted = inherit (900). */
+    usageCacheTtl?: number;
+    /** Percent at which quota status becomes "warning". `0`/omitted = inherit (70). */
+    usageWarningThreshold?: number;
+    /** Percent at which quota status becomes "critical". `0`/omitted = inherit (90). */
+    usageCriticalThreshold?: number;
+    /** Number of largest folders the usage dashboard returns. `0`/omitted = inherit (10). */
+    usageTopFoldersCount?: number;
+    /** Folder grouping depth for the usage breakdown. `0`/omitted = inherit (1). */
+    usageFolderDepth?: number;
 }
 interface CreateTokenOptions extends BaseTokenOptions {
     /** Disk names the token may access. */

package/dist/index.d.ts

@@ -66,6 +66,33 @@ interface BaseTokenOptions {
     webpMaxWidth?: number;
     /** Default WebP quality when a request omits it. `0`/omitted = inherit (80). */
     webpDefaultQuality?: number;
+    /** 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;
+    /** 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'. */
+    watermarkType?: 'text' | 'logo';
+    /** Watermark text (for type 'text'). */
+    watermarkText?: string;
+    /** Storage path to the logo PNG (for type 'logo'); missing → text fallback. */
+    watermarkLogoPath?: string;
+    /** Position: top-left / top-right / bottom-left / bottom-right / center. Default bottom-right. */
+    watermarkPosition?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'center';
+    /** Opacity 0.0–1.0. Default 0.6. */
+    watermarkOpacity?: number;
+    /** Font size for text watermark. Default 24. */
+    watermarkFontSize?: number;
+    /** Usage-summary cache TTL (seconds). `0`/omitted = inherit (900). */
+    usageCacheTtl?: number;
+    /** Percent at which quota status becomes "warning". `0`/omitted = inherit (70). */
+    usageWarningThreshold?: number;
+    /** Percent at which quota status becomes "critical". `0`/omitted = inherit (90). */
+    usageCriticalThreshold?: number;
+    /** Number of largest folders the usage dashboard returns. `0`/omitted = inherit (10). */
+    usageTopFoldersCount?: number;
+    /** Folder grouping depth for the usage breakdown. `0`/omitted = inherit (1). */
+    usageFolderDepth?: number;
 }
 interface CreateTokenOptions extends BaseTokenOptions {
     /** Disk names the token may access. */

package/dist/index.js

@@ -157,6 +157,21 @@ function applyTenantOverrides(payload, opts) {
   if (opts.webpEnabled !== void 0) payload.webp_enabled = !!opts.webpEnabled;
   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.watermarkEnabled) {
+    payload.watermark_enabled = true;
+    if (opts.watermarkType) payload.watermark_type = opts.watermarkType;
+    if (opts.watermarkText) payload.watermark_text = String(opts.watermarkText);
+    if (opts.watermarkLogoPath) payload.watermark_logo_path = String(opts.watermarkLogoPath);
+    if (opts.watermarkPosition) payload.watermark_position = opts.watermarkPosition;
+    if (opts.watermarkOpacity !== void 0) payload.watermark_opacity = opts.watermarkOpacity;
+    if (opts.watermarkFontSize && opts.watermarkFontSize > 0) payload.watermark_font_size = Math.trunc(opts.watermarkFontSize);
+  }
+  if (opts.usageCacheTtl && opts.usageCacheTtl > 0) payload.usage_cache_ttl = Math.trunc(opts.usageCacheTtl);
+  if (opts.usageWarningThreshold && opts.usageWarningThreshold > 0) payload.usage_warning_threshold = Math.trunc(opts.usageWarningThreshold);
+  if (opts.usageCriticalThreshold && opts.usageCriticalThreshold > 0) payload.usage_critical_threshold = Math.trunc(opts.usageCriticalThreshold);
+  if (opts.usageTopFoldersCount && opts.usageTopFoldersCount > 0) payload.usage_top_folders_count = Math.trunc(opts.usageTopFoldersCount);
+  if (opts.usageFolderDepth && opts.usageFolderDepth > 0) payload.usage_folder_depth = Math.trunc(opts.usageFolderDepth);
 }
 function validateByobDisk(name, config) {
   if (!config || config.driver !== "s3") {

package/dist/index.mjs

@@ -135,6 +135,21 @@ function applyTenantOverrides(payload, opts) {
   if (opts.webpEnabled !== void 0) payload.webp_enabled = !!opts.webpEnabled;
   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.watermarkEnabled) {
+    payload.watermark_enabled = true;
+    if (opts.watermarkType) payload.watermark_type = opts.watermarkType;
+    if (opts.watermarkText) payload.watermark_text = String(opts.watermarkText);
+    if (opts.watermarkLogoPath) payload.watermark_logo_path = String(opts.watermarkLogoPath);
+    if (opts.watermarkPosition) payload.watermark_position = opts.watermarkPosition;
+    if (opts.watermarkOpacity !== void 0) payload.watermark_opacity = opts.watermarkOpacity;
+    if (opts.watermarkFontSize && opts.watermarkFontSize > 0) payload.watermark_font_size = Math.trunc(opts.watermarkFontSize);
+  }
+  if (opts.usageCacheTtl && opts.usageCacheTtl > 0) payload.usage_cache_ttl = Math.trunc(opts.usageCacheTtl);
+  if (opts.usageWarningThreshold && opts.usageWarningThreshold > 0) payload.usage_warning_threshold = Math.trunc(opts.usageWarningThreshold);
+  if (opts.usageCriticalThreshold && opts.usageCriticalThreshold > 0) payload.usage_critical_threshold = Math.trunc(opts.usageCriticalThreshold);
+  if (opts.usageTopFoldersCount && opts.usageTopFoldersCount > 0) payload.usage_top_folders_count = Math.trunc(opts.usageTopFoldersCount);
+  if (opts.usageFolderDepth && opts.usageFolderDepth > 0) payload.usage_folder_depth = Math.trunc(opts.usageFolderDepth);
 }
 function validateByobDisk(name, config) {
   if (!config || config.driver !== "s3") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluxfiles/node",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "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

@@ -125,6 +125,25 @@ function applyTenantOverrides(payload: Record<string, unknown>, opts: BaseTokenO
   if (opts.webpEnabled !== undefined) payload.webp_enabled = !!opts.webpEnabled;
   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);
+
+  // Download gate + watermark.
+  if (opts.allowDownload !== undefined) payload.allow_download = !!opts.allowDownload;
+  if (opts.watermarkEnabled) {
+    payload.watermark_enabled = true;
+    if (opts.watermarkType) payload.watermark_type = opts.watermarkType;
+    if (opts.watermarkText) payload.watermark_text = String(opts.watermarkText);
+    if (opts.watermarkLogoPath) payload.watermark_logo_path = String(opts.watermarkLogoPath);
+    if (opts.watermarkPosition) payload.watermark_position = opts.watermarkPosition;
+    if (opts.watermarkOpacity !== undefined) payload.watermark_opacity = opts.watermarkOpacity;
+    if (opts.watermarkFontSize && opts.watermarkFontSize > 0) payload.watermark_font_size = Math.trunc(opts.watermarkFontSize);
+  }
+
+  // Usage-dashboard claims.
+  if (opts.usageCacheTtl && opts.usageCacheTtl > 0) payload.usage_cache_ttl = Math.trunc(opts.usageCacheTtl);
+  if (opts.usageWarningThreshold && opts.usageWarningThreshold > 0) payload.usage_warning_threshold = Math.trunc(opts.usageWarningThreshold);
+  if (opts.usageCriticalThreshold && opts.usageCriticalThreshold > 0) payload.usage_critical_threshold = Math.trunc(opts.usageCriticalThreshold);
+  if (opts.usageTopFoldersCount && opts.usageTopFoldersCount > 0) payload.usage_top_folders_count = Math.trunc(opts.usageTopFoldersCount);
+  if (opts.usageFolderDepth && opts.usageFolderDepth > 0) payload.usage_folder_depth = Math.trunc(opts.usageFolderDepth);
 }
 
 /**

package/src/types.ts

@@ -68,6 +68,33 @@ export interface BaseTokenOptions {
   webpMaxWidth?: number;
   /** Default WebP quality when a request omits it. `0`/omitted = inherit (80). */
   webpDefaultQuality?: number;
+  /** 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;
+  /** 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'. */
+  watermarkType?: 'text' | 'logo';
+  /** Watermark text (for type 'text'). */
+  watermarkText?: string;
+  /** Storage path to the logo PNG (for type 'logo'); missing → text fallback. */
+  watermarkLogoPath?: string;
+  /** Position: top-left / top-right / bottom-left / bottom-right / center. Default bottom-right. */
+  watermarkPosition?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' | 'center';
+  /** Opacity 0.0–1.0. Default 0.6. */
+  watermarkOpacity?: number;
+  /** Font size for text watermark. Default 24. */
+  watermarkFontSize?: number;
+  /** Usage-summary cache TTL (seconds). `0`/omitted = inherit (900). */
+  usageCacheTtl?: number;
+  /** Percent at which quota status becomes "warning". `0`/omitted = inherit (70). */
+  usageWarningThreshold?: number;
+  /** Percent at which quota status becomes "critical". `0`/omitted = inherit (90). */
+  usageCriticalThreshold?: number;
+  /** Number of largest folders the usage dashboard returns. `0`/omitted = inherit (10). */
+  usageTopFoldersCount?: number;
+  /** Folder grouping depth for the usage breakdown. `0`/omitted = inherit (1). */
+  usageFolderDepth?: number;
 }
 
 export interface CreateTokenOptions extends BaseTokenOptions {