@autorender/sdk-nextjs

Autorender SDK adapter for Next.js - Upload and ViewTag functionality.

Installation

npm install @autorender/sdk-nextjs

Upload SDK Usage

This package provides React components optimized for Next.js. The components are client components, so make sure to use the 'use client' directive.

Basic Example

'use client';

import { AutorenderUploader } from '@autorender/sdk-nextjs';
import '@autorender/sdk-nextjs/styles';

export default function UploadPage() {
  return (
    <AutorenderUploader
      apiKey="your-api-key"
      environment="prod"
      folderPath="uploads"
    />
  );
}

ViewTag SDK Usage

Setup Provider

'use client';

import { AutoRenderProvider } from '@autorender/sdk-nextjs';

export default function RootLayout({ children }) {
  return (
    <AutoRenderProvider
      baseUrl="https://assets.autorender.io"
      workspace="ws_123"
      defaults={{ f: 'auto', q: 'auto' }}
    >
      {children}
    </AutoRenderProvider>
  );
}

Use ARImage Component

'use client';

import { ARImage } from '@autorender/sdk-nextjs';
import type { TransformOptions } from '@autorender/sdk-core';

export default function ProductPage() {
  return (
    <ARImage
      src="products/shoe.jpg"
      width={400}
      height={400}
      alt="Shoe"
      transform={{
        fit: 'cover',
        // See TransformOptions below for all available options
      }}
      responsive={true}
      lazy={true}
      sizes="(min-width: 800px) 50vw, 100vw"
    />
  );
}

Complete Transform Example

'use client';

import { ARImage } from '@autorender/sdk-nextjs';
import type { TransformOptions } from '@autorender/sdk-core';

export default function HeroPage() {
  const transform: TransformOptions = {
    // Size & Crop
    w: 1200,
    h: 800,
    fit: 'cover', // 'crop' | 'fill' | 'fit' | 'scale'
    ar: '16:9', // Aspect ratio
    p: 'c', // Position: 'c' | 'tl' | 'br' | 'face' | etc.
    ps: 'attention', // Position strategy: 'center' | 'entropy' | 'attention'
    
    // Transform
    r: 0, // Rotation: number (0-360) | 'portrait' | 'landscape'
    z: 1.2, // Zoom level
    flip: 'h', // 'h' | 'v' | 'hv' | 'vh'
    br: 20, // Border radius in pixels
    
    // Format & Quality
    f: 'auto', // 'auto' | 'webp' | 'jpg' | 'png' | 'avif'
    q: 'auto', // 'auto' | 'auto:best' | number (1-100)
    
    // Background
    bg: 'rgb:FF5733', // Background color
    
    // Kernel
    k: 'lanczos3', // 'nearest' | 'linear' | 'cubic' | 'mitchell' | 'lanczos2' | 'lanczos3'
    
    // DPR
    dpr: 2, // Device pixel ratio (0.1-10)
    
    // Effects
    improve: true, // Auto-enhancement
    unsharpMask: 100, // Unsharp mask strength (1-2000)
    saturation: 20, // Saturation adjustment (-100 to 100)
    contrast: 15, // Contrast adjustment (-100 to 100)
    brightness: 10, // Brightness adjustment (-99 to 100)
    gamma: 0, // Gamma correction (-50 to 150)
    sharpen: 50, // Sharpen: boolean | number (1-2000)
    grayscale: false, // Convert to grayscale
    blackwhite: 50, // Black and white balance (0-100)
    hue: 0, // Hue rotation (-180 to 180)
    warmth: 0, // Warmth adjustment (-100 to 100)
    tint: 0, // Tint adjustment (-100 to 100)
    normalize: false, // Normalize histogram
    invert: false, // Invert colors
    fade: 0, // Fade effect (0-100)
    vignette: 0, // Vignette strength (0-100)
    highlights: 0, // Highlights adjustment (-100 to 100)
    shadows: 0, // Shadows adjustment (-100 to 100)
    exposure: 0, // Exposure adjustment (-100 to 100)
    structure: 0, // Structure/clarity (0-100)
    autoEnhance: false, // Auto enhance
    temperature: 0, // Temperature adjustment (-100 to 100)
    blur: 0, // Blur amount (0-20)
    
    // Layers
    layers: [
      {
        type: 'image',
        imagePath: 'logo.png',
        layerType: 'overlay', // 'overlay' | 'underlay'
        width: 200,
        height: 200,
        placement: 'ne', // 'nw' | 'n' | 'ne' | 'w' | 'c' | 'e' | 'sw' | 's' | 'se'
        x: 0,
        y: 0,
        opacity: 100,
        rotation: 0,
      },
      {
        type: 'text',
        text: 'Hello World',
        fontFamily: 'arial',
        fontSize: 24,
        fontStyle: 'bold',
        fontColor: 'FF0000',
        placement: 's',
        x: 0,
        y: -20,
        rotation: 0,
      }
    ],
    
    // Blend mode
    blend: 'overlay', // 'screen' | 'overlay' | 'multiply' | 'mask' | 'anti_removal'
  };

  return (
    <ARImage
      src="hero.jpg"
      width={1200}
      height={800}
      alt="Hero image"
      transform={transform}
      responsive={true}
      lazy={true}
      sizes="(min-width: 1200px) 1200px, 100vw"
      className="hero-image"
    />
  );
}

Use AR Instance Directly

'use client';

import { useAutoRender } from '@autorender/sdk-nextjs';

export default function ImageComponent() {
  const AR = useAutoRender();
  
  const url = AR.url('image.jpg', { w: 300, h: 300, fit: 'cover' });
  const transformString = AR.transformString({ w: 300, h: 300 });
  const dpr = AR.getDPR();
  const connectionQuality = AR.getConnectionQuality();
  
  // Generate responsive attributes
  const attrs = AR.responsiveImageAttributes({
    src: 'hero.jpg',
    width: 1200,
    sizes: '(min-width: 800px) 50vw, 100vw',
    transform: { fit: 'cover' }
  });
  
  return (
    <img
      src={attrs.src}
      srcSet={attrs.srcSet}
      sizes={attrs.sizes}
      width={attrs.width}
      alt="Image"
    />
  );
}

API Reference

Upload SDK

All props from @autorender/sdk-core are supported, with the addition of:

• environment?: 'prod' | 'dev' - Controls which API endpoint to use (default: 'prod')
• containerClassName?: string - Additional CSS class for the container

ViewTag SDK

<AutoRenderProvider />

Next.js Context Provider that makes AR instance available to child components.

Props:

• baseUrl?: string - Base URL (default: 'https://assets.autorender.io')
• workspace: string - Your workspace ID
• defaults?: { f?: string, q?: string | number } - Default transformations
• deviceBreakpoints?: number[] - Device breakpoints
• imageBreakpoints?: number[] - Image breakpoints
• enableDPR?: boolean - Enable device pixel ratio (default: true)
• enableResponsive?: boolean - Enable responsive images (default: true)
• connectionQuality?: 'auto' | '2g' | '3g' | '4g' | 'wifi' - Connection quality override

<ARImage />

Next.js component that wraps next/image with AutoRender transformations.

Props:

• src: string - Image source path (required)
• width?: number - Image width in pixels
• height?: number - Image height in pixels
• transform?: TransformOptions - Transformation options (see TransformOptions Reference below)
• responsive?: boolean - Enable responsive images (default: true)
• lazy?: boolean - Enable lazy loading (default: true)
• sizes?: string - Sizes attribute for responsive images
• All standard next/image props are supported (e.g., alt, className, style, priority, fill, etc.)

useAutoRender(): ARInstance

Hook to access the AR instance from context.

Returns: ARInstance with methods:

• url(src: string, transform?: TransformOptions): string - Generate image URL
• transformString(transform: TransformOptions): string - Get transformation string only
• responsiveImageAttributes(options: ResponsiveOptions): ResponsiveAttributes - Generate responsive image attributes
• getDPR(): number - Get device pixel ratio
• getConnectionQuality(): '2g' | '3g' | '4g' | 'wifi' | 'unknown' - Get connection quality

TransformOptions Reference

All transformation parameters available in the transform prop. See React SDK README for complete reference.

Size & Crop

• w?: number - Width in pixels
• h?: number - Height in pixels
• fit?: 'crop' | 'fill' | 'fit' | 'scale' - Crop mode
• ar?: string - Aspect ratio (e.g., "16:9")
• p?: string - Position/gravity
• ps?: 'center' | 'entropy' | 'attention' - Position strategy

Preset (named transformation)

• preset?: string - Optional named preset, which becomes a leading t_<preset> segment in the URL.

  Example:

  <ARImage
    src="avatar.png"
    width={100}
    height={100}
    alt="Unavailable avatar"
    transform={{ preset: 'unavailable', w: 100, h: 100 }}
  />
  {/* Results in: /workspace/t_unavailable,w_100,h_100/avatar.png */} 

Transform

• r?: number | 'portrait' | 'landscape' - Rotation
• z?: number - Zoom level
• flip?: 'h' | 'v' | 'hv' | 'vh' - Flip direction
• br?: number - Border radius

Format & Quality

• f?: string - Format ("auto", "webp", "jpg", etc.)
• q?: string | number - Quality ("auto" or 1-100)

Effects

• improve?: boolean | string | object - Auto-enhancement
• saturation?: number - Saturation (-100 to 100)
• contrast?: number - Contrast (-100 to 100)
• brightness?: number - Brightness (-99 to 100)
• sharpen?: boolean | number - Sharpen
• grayscale?: boolean - Convert to grayscale
• blur?: number - Blur amount (0-20)
• vignette?: number - Vignette strength (0-100)
• exposure?: number - Exposure (-100 to 100)
• And many more... (see React SDK README for complete list)

Layers

• layers?: LayerOptions[] - Array of layer options
  • Image layers: { type: 'image', imagePath: string, layerType?: 'overlay' | 'underlay', ... }
  • Text layers: { type: 'text', text: string, fontFamily?: string, fontSize?: number, ... }

Documentation

See the main @autorender/sdk-core documentation for full API reference.