Compression Presets

import { CompressPresets } from "sonamu";

// Usage in API
@api({
  httpMethod: 'GET',
  compress: CompressPresets.aggressive,
})

// Global configuration
plugins: {
  compress: CompressPresets.default
}

CompressPresets.disabled
// Value: false

CompressPresets.default
// Generated configuration:
{
  threshold: 1024,  // 1KB
  encodings: ["br", "gzip", "deflate"]
}

CompressPresets.aggressive
// Generated configuration:
{
  threshold: 256,  // 256 bytes
  encodings: ["br", "gzip", "deflate"]
}

CompressPresets.conservative
// Generated configuration:
{
  threshold: 4096,  // 4KB
  encodings: ["gzip", "deflate"]  // Excludes brotli
}

CompressPresets.gzipOnly
// Generated configuration:
{
  threshold: 1024,  // 1KB
  encodings: ["gzip"]  // gzip only
}

export const config: SonamuConfig = {
  server: {
    plugins: {
      compress: CompressPresets.default,  // Balanced settings
    }
  }
};

export const config: SonamuConfig = {
  server: {
    plugins: {
      compress: CompressPresets.aggressive,  // Maximum compression
    }
  }
};

export const config: SonamuConfig = {
  server: {
    plugins: {
      compress: CompressPresets.conservative,  // Save CPU
    }
  }
};

export const config: SonamuConfig = {
  server: {
    plugins: {
      compress: CompressPresets.gzipOnly,  // Compatibility
    }
  }
};

export const config: SonamuConfig = {
  server: {
    plugins: {
      compress: CompressPresets.disabled,  // Easier debugging
    }
  }
};

// Based on default + adjust threshold
plugins: {
  compress: {
    ...CompressPresets.default,
    threshold: 512,  // Change to 512B
  }
}

// Based on aggressive + gzip only
plugins: {
  compress: {
    ...CompressPresets.aggressive,
    encodings: ["gzip"],  // Exclude brotli
  }
}

class DataModelClass extends BaseModel {
  // Small response: aggressive
  @api({
    httpMethod: 'GET',
    compress: CompressPresets.aggressive,
  })
  async getStatus() {
    return { status: "ok" };
  }

  // Medium response: default
  @api({
    httpMethod: 'GET',
    compress: CompressPresets.default,
  })
  async getList() {
    return this.findMany({ num: 100 });
  }

  // Large response: conservative (save CPU)
  @api({
    httpMethod: 'GET',
    compress: CompressPresets.conservative,
  })
  async exportData() {
    return this.findMany({ num: 100000 });
  }

  // Already compressed file: disabled
  @api({
    httpMethod: 'GET',
    compress: CompressPresets.disabled,
  })
  async downloadImage() {
    return this.sendFile('image.png');
  }
}

const isDevelopment = process.env.NODE_ENV === 'development';
const isProduction = process.env.NODE_ENV === 'production';

export const config: SonamuConfig = {
  server: {
    plugins: {
      compress: isDevelopment
        ? CompressPresets.disabled       // Development: no compression
        : isProduction
        ? CompressPresets.aggressive     // Production: maximum compression
        : CompressPresets.default        // Others: default settings
    }
  }
};