@baasix/sdk 0.1.12 → 0.1.14

package/README.md

@@ -463,6 +463,8 @@ Baasix supports 50+ filter operators:
 
 // Dynamic variables
 { author_Id: { eq: '$CURRENT_USER' } }
+{ tenant_Id: { eq: '$CURRENT_TENANT' } }
+{ currency: { eq: '$CURRENT_SETTINGS.currency' } }
 { createdAt: { gte: '$NOW-DAYS_30' } }
 ```
 
@@ -493,7 +495,7 @@ const metadata = await baasix.files.upload({
 // Original file
 const url = baasix.files.getAssetUrl('file-uuid');
 
-// With transformations
+// Resize to thumbnail
 const thumbnailUrl = baasix.files.getAssetUrl('file-uuid', {
   width: 200,
   height: 200,
@@ -501,8 +503,32 @@ const thumbnailUrl = baasix.files.getAssetUrl('file-uuid', {
   quality: 80,
   format: 'webp',
 });
+
+// Convert to WebP without resizing (preserves transparency)
+const webpUrl = baasix.files.getAssetUrl('file-uuid', {
+  format: 'webp',
+  quality: 85,
+});
+
+// Resize without upscaling
+const safeUrl = baasix.files.getAssetUrl('file-uuid', {
+  width: 800,
+  format: 'webp',
+  withoutEnlargement: true,
+});
 ```
 
+**`AssetTransformOptions`:**
+
+| Option               | Type                              | Default   | Description                                                                 |
+| -------------------- | --------------------------------- | --------- | --------------------------------------------------------------------------- |
+| `width`              | `number`                          | —         | Target width in pixels                                                      |
+| `height`             | `number`                          | —         | Target height in pixels                                                     |
+| `fit`                | `'cover'\|'contain'\|'fill'\|'inside'\|'outside'` | `'cover'` | Resize fit mode |
+| `quality`            | `number` (1–100)                  | `80`      | Output quality                                                              |
+| `format`             | `'jpeg'\|'png'\|'webp'\|'avif'`   | `'jpeg'`  | Output format. `webp` and `png` preserve alpha transparency; `jpeg` flattens transparency to white |
+| `withoutEnlargement` | `boolean`                         | `false`   | Prevent upscaling images smaller than the target dimensions                 |
+
 ### File Operations
 
 ```typescript

package/dist/index.cjs

@@ -1875,6 +1875,16 @@ var FilesModule = class {
   /**
    * Get the URL for an asset with optional transformations
    *
+   * @param id - File UUID
+   * @param options - Optional transformation options
+   * @param options.width - Target width in pixels
+   * @param options.height - Target height in pixels
+   * @param options.fit - Resize fit mode: 'cover' | 'contain' | 'fill' | 'inside' | 'outside' (default: 'cover')
+   * @param options.quality - Output quality 1–100 (default: 80)
+   * @param options.format - Output format: 'jpeg' | 'png' | 'webp' | 'avif' (default: 'jpeg').
+   *   'webp' and 'png' preserve alpha transparency; 'jpeg' composites transparency over a white background.
+   * @param options.withoutEnlargement - When true, prevents upscaling images smaller than the target dimensions
+   *
    * @example
    * ```typescript
    * // Original file
@@ -1888,11 +1898,21 @@ var FilesModule = class {
    *   quality: 80
    * });
    *
-   * // Convert to WebP
+   * // Convert to WebP (preserves transparency)
    * const webpUrl = baasix.files.getAssetUrl('file-uuid', {
    *   format: 'webp',
    *   quality: 85
    * });
+   *
+   * // Resize and convert to WebP
+   * const optimizedUrl = baasix.files.getAssetUrl('file-uuid', {
+   *   width: 800,
+   *   height: 600,
+   *   fit: 'cover',
+   *   format: 'webp',
+   *   quality: 80,
+   *   withoutEnlargement: true
+   * });
    * ```
    */
   getAssetUrl(id, options) {
@@ -1946,7 +1966,10 @@ var FilesModule = class {
    * @example
    * ```typescript
    * const base64 = await baasix.files.toBase64('file-uuid');
-   * // Use in Image component: <Image source={{ uri: `data:image/jpeg;base64,${base64}` }} />
+   * // Use in Image component: <Image source={{ uri: `data:image/webp;base64,${base64}` }} />
+   *
+   * // Convert to WebP first for smaller payload
+   * const base64Webp = await baasix.files.toBase64('file-uuid', { format: 'webp', quality: 80 });
    * ```
    */
   async toBase64(id, options) {