react-native-fast-image 8.31.1 → 9.0.0

package/android/src/main/java/com/dylanvann/fastimage/FastImageViewManager.java

@@ -8,7 +8,6 @@ import android.app.Activity;
 import android.content.Context;
 import android.content.ContextWrapper;
 import android.graphics.PorterDuff;
-import android.os.Build;
 
 import androidx.annotation.NonNull;
 
@@ -240,12 +239,7 @@ class FastImageViewManager extends SimpleViewManager<FastImageViewWithUrl> imple
     }
 
     private static boolean isActivityDestroyed(Activity activity) {
-        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN_MR1) {
-            return activity.isDestroyed() || activity.isFinishing();
-        } else {
-            return activity.isFinishing() || activity.isChangingConfigurations();
-        }
-
+        return activity.isDestroyed() || activity.isFinishing();
     }
 
     // Legacy architecture only; the New Architecture doesn't use shadow nodes.

package/android/src/main/java/com/dylanvann/fastimage/FastImageViewWithUrl.java

@@ -443,7 +443,7 @@ class FastImageViewWithUrl extends AppCompatImageView {
                 }
             }
             if (resource instanceof FastImageAnimatable) {
-                // An APNG: each view's is its own (FastImageApngRenderer).
+                // An APNG: each view's is its own (FastImageApng).
                 FastImageAnimatable animatable = (FastImageAnimatable) resource;
                 animatable.setLoopCount(mLoopCount, false);
                 // The target starts it; paused, it stays on its first frame.

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 import React from 'react';
-import { StyleProp, ViewStyle, ImageRequireSource, AccessibilityProps, ViewProps } from 'react-native';
+import { ColorValue, StyleProp, ViewStyle, ImageRequireSource, AccessibilityProps, ViewProps } from 'react-native';
 import { cacheControl, priority, resizeMode } from './constants';
-type ColorValue = NonNullable<ViewStyle['backgroundColor']>;
 /** How the image fits the view: see [`resizeMode`](#resizemode). */
 export type ResizeMode = 'contain' | 'cover' | 'stretch' | 'center' | 'repeat';
 /** An image's load priority: see [`source.priority`](#sourcepriority). */
@@ -13,10 +12,11 @@ export type Source = {
     /**
      * Remote url to load the image from. e.g. `'https://example.com/image.jpg'`.
      *
-     * Also loads local files (`file://`, and on Android `content://`), photo
-     * library images on iOS (`ph://`, see
-     * [Photo library images](#photo-library-images-ios)) and SVG images (see
-     * [SVG images](docs/formats.md#svg-images)).
+     * Also loads local files (`file://`, and on Android `content://`), images
+     * in the app by name (e.g. `'my_image'`: in its asset catalog on iOS, a
+     * drawable on Android), photo library images on iOS and tvOS (`ph://`,
+     * see [Photo library images](#photo-library-images-ios-and-tvos)) and SVG
+     * images (see [SVG images](docs/formats.md#svg-images)).
      */
     uri?: string;
     /** Headers to load the image with. e.g. `{ Authorization: 'someAuthToken' }`. */
@@ -220,8 +220,8 @@ export interface OnProgressEvent {
     };
 }
 export interface ImageStyle extends ViewStyle {
-    overlayColor?: ViewStyle['backgroundColor'];
-    tintColor?: ViewStyle['backgroundColor'];
+    overlayColor?: ColorValue;
+    tintColor?: ColorValue;
 }
 export interface FastImageProps extends AccessibilityProps, ViewProps {
     /**
@@ -492,8 +492,10 @@ export interface FastImageProps extends AccessibilityProps, ViewProps {
      */
     tintColor?: ColorValue;
     /**
-     * Render children within the image. In the next major version,
-     * `FastImage` won't render children: use `FastImageBackground`.
+     * Render children within the image.
+     *
+     * @deprecated In the next major version, `FastImage` won't render
+     * children: use `FastImageBackground`.
      */
     children?: React.ReactNode;
 }

package/ios/FastImage/FFFastImageSource.h

@@ -64,8 +64,7 @@ typedef NS_ENUM(NSInteger, FFFCacheControl) {
 // which is decoded at about the view's size.
 - (BOOL)isPhotoLibrary;
 
-// The error's message, or for an SVG image that couldn't be decoded because
-// the app doesn't have SDWebImageSVGCoder, what to add.
+// The error's message, for onError.
 - (NSString *)errorMessage:(NSError *)error;
 
 // A photo library image's own size in pixels (for onLoad when it comes from

package/ios/FastImage/FFFastImageSource.m

@@ -9,7 +9,9 @@
 #import <SDWebImage/SDImageAWebPCoder.h>
 #import "FFFAnimatedWebPCoder.h"
 #import "FFFAnimatedAVIFCoder.h"
-#import <objc/message.h>
+#import <SDWebImageSVGCoder/SDImageSVGCoder.h>
+#import <SDWebImagePhotosPlugin/SDImagePhotosLoader.h>
+#import <Photos/Photos.h>
 #import <ImageIO/ImageIO.h>
 
 // In FFFastImageView.m.
@@ -18,24 +20,16 @@ FOUNDATION_EXTERN NSString *FFFErrorMessage(NSError *error);
 static NSUInteger const FFFWebCacheSize = 50 * 1024 * 1024;
 
 // The photo's own size in pixels, looked up by its identifier (the url after
-// ph://), or zero. Through the runtime, as the Photos framework is only there
-// with SDWebImagePhotosPlugin (on iOS, always). Kept once looked up.
+// ph://), or zero.
 static CGSize FFFLookUpPhotoPixelSize(NSURL *url)
 {
-    Class assetClass = NSClassFromString(@"PHAsset");
-    SEL fetch = NSSelectorFromString(@"fetchAssetsWithLocalIdentifiers:options:");
     NSString *prefix = @"ph://";
     NSString *string = url.absoluteString;
-    if (!assetClass || ![assetClass respondsToSelector:fetch] || ![string hasPrefix:prefix]) {
+    if (![string hasPrefix:prefix]) {
         return CGSizeZero;
     }
-    id (*fetchAssets)(id, SEL, NSArray *, id) = (void *)objc_msgSend;
-    id result = fetchAssets(assetClass, fetch, @[[string substringFromIndex:prefix.length]], nil);
-    id asset = [result respondsToSelector:@selector(firstObject)] ? [result firstObject] : nil;
-    if (!asset) {
-        return CGSizeZero;
-    }
-    return CGSizeMake([[asset valueForKey:@"pixelWidth"] doubleValue], [[asset valueForKey:@"pixelHeight"] doubleValue]);
+    PHAsset *asset = [PHAsset fetchAssetsWithLocalIdentifiers:@[[string substringFromIndex:prefix.length]] options:nil].firstObject;
+    return asset ? CGSizeMake(asset.pixelWidth, asset.pixelHeight) : CGSizeZero;
 }
 
 static NSCache<NSString *, NSValue *> *FFFPhotoSizes(void)
@@ -62,14 +56,81 @@ static CGSize FFFPhotoPixelSize(NSURL *url)
     return size;
 }
 
+// An image in the app by its name (`uri: 'my_image'`), such as one in the
+// app's asset catalog, as React Native's Image takes: RCTConvert makes a uri
+// without a scheme a file in the app's resources, where such an image isn't a
+// file. The name, or nil if the url is a file that exists or isn't in the
+// app's resources.
+static NSString *FFFBundleAssetName(NSURL *url)
+{
+    if (!url.isFileURL) {
+        return nil;
+    }
+    NSString *resources = [NSBundle.mainBundle.resourcePath stringByAppendingString:@"/"];
+    NSString *path = url.path;
+    if (![path hasPrefix:resources] || path.length == resources.length ||
+        [NSFileManager.defaultManager fileExistsAtPath:path]) {
+        return nil;
+    }
+    return [path substringFromIndex:resources.length];
+}
+
+// Loads images in the app by name (FFFBundleAssetName) with UIImage
+// imageNamed:, which finds them in the asset catalog (and image files in the
+// app's resources, e.g. with @2x and @3x versions), as React Native's Image
+// does.
+@interface FFFBundleAssetLoader : NSObject <SDImageLoader>
+@end
+
+@implementation FFFBundleAssetLoader
+
++ (FFFBundleAssetLoader *)sharedLoader
+{
+    static FFFBundleAssetLoader *loader;
+    static dispatch_once_t once;
+    dispatch_once(&once, ^{
+        loader = [FFFBundleAssetLoader new];
+    });
+    return loader;
+}
+
+- (BOOL)canRequestImageForURL:(NSURL *)url
+{
+    return YES;
+}
+
+- (id<SDWebImageOperation>)requestImageWithURL:(NSURL *)url
+                                        options:(SDWebImageOptions)options
+                                        context:(SDWebImageContext *)context
+                                       progress:(SDImageLoaderProgressBlock)progressBlock
+                                      completed:(SDImageLoaderCompletedBlock)completedBlock
+{
+    NSString *name = FFFBundleAssetName(url);
+    UIImage *image = name ? [UIImage imageNamed:name] : nil;
+    if (completedBlock) {
+        if (image) {
+            completedBlock(image, nil, nil, YES);
+        } else {
+            NSString *message = [NSString stringWithFormat:@"No image named %@ in the app", name ?: url.path];
+            completedBlock(nil, nil, [NSError errorWithDomain:SDWebImageErrorDomain code:SDWebImageErrorInvalidURL userInfo:@{NSLocalizedDescriptionKey: message}], YES);
+        }
+    }
+    return nil;
+}
+
+- (BOOL)shouldBlockFailedURLWithURL:(NSURL *)url error:(NSError *)error
+{
+    return NO;
+}
+
+@end
+
 // Loads photo library images (ph://<localIdentifier>) with
-// SDWebImagePhotosPlugin's loader: a dependency on iOS (the podspec), found
-// at runtime so that tvOS builds without it (an app can add it there). Its
-// own instance, so the app's use of the plugin is left as it is. Without the
-// plugin, or for a source it can't load (assets-library://), the load fails
-// with `failure`.
+// SDWebImagePhotosPlugin's loader, its own instance, so the app's use of the
+// plugin is left as it is. For a source it can't load (assets-library://),
+// the load fails with `failure`.
 @interface FFFPhotosLoader : NSObject <SDImageLoader>
-@property (nonatomic, strong) id<SDImageLoader> plugin;
+@property (nonatomic, strong) SDImagePhotosLoader *plugin;
 @property (nonatomic, copy) NSString *failure;
 @end
 
@@ -81,24 +142,12 @@ static CGSize FFFPhotoPixelSize(NSURL *url)
     static dispatch_once_t once;
     dispatch_once(&once, ^{
         loader = [FFFPhotosLoader new];
-        Class pluginClass = NSClassFromString(@"SDImagePhotosLoader");
-        id<SDImageLoader> plugin = pluginClass ? [pluginClass new] : nil;
-        if ([plugin conformsToProtocol:@protocol(SDImageLoader)]) {
-            // One image per load, at full quality. By default the plugin
-            // first sends a quick low quality one, which a view would show
-            // (and fade in) before the one it asked for.
-            // PHImageRequestOptionsDeliveryModeHighQualityFormat. Skipped if
-            // a later version of the plugin renames these.
-            NSObject *requestOptions = [(NSObject *)plugin respondsToSelector:NSSelectorFromString(@"imageRequestOptions")]
-                ? [(NSObject *)plugin valueForKey:@"imageRequestOptions"]
-                : nil;
-            if ([requestOptions respondsToSelector:NSSelectorFromString(@"setDeliveryMode:")]) {
-                [requestOptions setValue:@1 forKey:@"deliveryMode"];
-            }
-            loader.plugin = plugin;
-        } else {
-            loader.failure = @"Photo library images (ph://) need SDWebImagePhotosPlugin: add pod 'SDWebImagePhotosPlugin' to the app's Podfile";
-        }
+        SDImagePhotosLoader *plugin = [SDImagePhotosLoader new];
+        // One image per load, at full quality. By default the plugin first
+        // sends a quick low quality one, which a view would show (and fade
+        // in) before the one it asked for.
+        plugin.imageRequestOptions.deliveryMode = PHImageRequestOptionsDeliveryModeHighQualityFormat;
+        loader.plugin = plugin;
     });
     return loader;
 }
@@ -235,10 +284,6 @@ static BOOL FFFLooksLikeSVG(NSData *data)
 
 @end
 
-// SDWebImageSVGCoder's coder, when the app has the pod (SVG images): found at
-// runtime, so FastImage doesn't depend on it. Nil otherwise.
-static id<SDImageCoder> FFFSVGCoder;
-
 @implementation FFFastImageSource
 
 + (void)initialize
@@ -276,28 +321,17 @@ static id<SDImageCoder> FFFSVGCoder;
         [SDImageCodersManager.sharedManager addCoder:FFFAnimatedAVIFCoder.sharedCoder];
     }
 
-    // SVG: registered with SDWebImage's coders, as the pod's setup does (unless
-    // the app has already): SDWebImage then picks it for SVG data, including
-    // for FastImage's animated and downsampled image classes. Giving the
-    // coder per load instead (SDWebImageContextImageCoder) would make it the
-    // only coder for everything in that load. So the app's own SDWebImage
-    // use can decode SVG too, which is what the pod is for.
-    Class coderClass = NSClassFromString(@"SDImageSVGCoder");
-    SEL shared = NSSelectorFromString(@"sharedCoder");
-    if (!coderClass || ![coderClass respondsToSelector:shared]) {
-        return;
-    }
-    id coder = ((id (*)(id, SEL))objc_msgSend)(coderClass, shared);
-    if (![coder conformsToProtocol:@protocol(SDImageCoder)]) {
-        return;
-    }
-    FFFSVGCoder = coder;
+    // SVG (SDWebImageSVGCoder): registered with SDWebImage's coders, as the
+    // pod's setup does (unless the app has already): SDWebImage then picks it
+    // for SVG data, including for FastImage's animated and downsampled image
+    // classes. Giving the coder per load instead (SDWebImageContextImageCoder)
+    // would make it the only coder for everything in that load.
     for (id<SDImageCoder> registered in SDImageCodersManager.sharedManager.coders) {
-        if ([registered isKindOfClass:coderClass]) {
+        if ([registered isKindOfClass:[SDImageSVGCoder class]]) {
             return;
         }
     }
-    [SDImageCodersManager.sharedManager addCoder:coder];
+    [SDImageCodersManager.sharedManager addCoder:SDImageSVGCoder.sharedCoder];
 }
 
 - (instancetype)initWithURL:(NSURL *)url
@@ -343,10 +377,6 @@ static id<SDImageCoder> FFFSVGCoder;
 
 - (NSString *)errorMessage:(NSError *)error
 {
-    if (!FFFSVGCoder && [error.domain isEqualToString:SDWebImageErrorDomain] && error.code == SDWebImageErrorBadImageData &&
-        [_url.path.lowercaseString hasSuffix:@".svg"]) {
-        return @"SVG images need SDWebImageSVGCoder: add pod 'SDWebImageSVGCoder' to the app's Podfile";
-    }
     return FFFErrorMessage(error);
 }
 
@@ -368,6 +398,9 @@ static id<SDImageCoder> FFFSVGCoder;
     if ([_url.scheme isEqualToString:@"assets-library"]) {
         return [FFFPhotosLoader assetsLibraryLoader];
     }
+    if (FFFBundleAssetName(_url)) {
+        return [FFFBundleAssetLoader sharedLoader];
+    }
     if (_cacheControl != FFFCacheControlWeb) {
         return nil;
     }
@@ -436,17 +469,10 @@ static id<SDImageCoder> FFFSVGCoder;
     static dispatch_once_t once;
     dispatch_once(&once, ^{
         NSString *name = @"fast-image-http-cache";
-        if (@available(iOS 13.0, tvOS 13.0, *)) {
-            NSURL *caches = [NSFileManager.defaultManager URLsForDirectory:NSCachesDirectory inDomains:NSUserDomainMask].firstObject;
-            cache = [[NSURLCache alloc] initWithMemoryCapacity:0
-                                                  diskCapacity:FFFWebCacheSize
-                                                  directoryURL:[caches URLByAppendingPathComponent:name]];
-        } else {
-            // In the app's caches directory.
-            cache = [[NSURLCache alloc] initWithMemoryCapacity:0
-                                                  diskCapacity:FFFWebCacheSize
-                                                      diskPath:name];
-        }
+        NSURL *caches = [NSFileManager.defaultManager URLsForDirectory:NSCachesDirectory inDomains:NSUserDomainMask].firstObject;
+        cache = [[NSURLCache alloc] initWithMemoryCapacity:0
+                                              diskCapacity:FFFWebCacheSize
+                                              directoryURL:[caches URLByAppendingPathComponent:name]];
     });
     return cache;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "react-native-fast-image",
-    "version": "8.31.1",
+    "version": "9.0.0",
     "description": "FastImage, performant React Native image component.",
     "keywords": [
         "cache",
@@ -28,11 +28,7 @@
         "android/build.gradle",
         "android/consumer-rules.pro",
         "android/src/main",
-        "android/src/glide-4.15",
-        "android/src/glide-older",
         "ios/FastImage",
-        "ios/FastImage.xcodeproj/project.pbxproj",
-        "ios/FastImage.xcodeproj/xcshareddata",
         "app.plugin.js",
         "dist",
         "RNFastImage.podspec"
@@ -73,6 +69,6 @@
     },
     "peerDependencies": {
         "react": "^17 || ^18 || ^19",
-        "react-native": ">=0.60.0"
+        "react-native": ">=0.65.0"
     }
 }

package/android/src/glide-older/java/com/dylanvann/fastimage/FastImageAnimated.java

@@ -1,36 +0,0 @@
-package com.dylanvann.fastimage;
-
-import android.content.Context;
-import android.graphics.drawable.Drawable;
-
-import androidx.annotation.NonNull;
-import androidx.annotation.Nullable;
-
-import com.bumptech.glide.Glide;
-import com.bumptech.glide.Registry;
-
-// Built instead of src/glide-4.15's FastImageAnimated with a Glide before
-// 4.15 (build.gradle), which has no decoder for animated WebP or AVIF: they
-// show their first frame, so there's nothing to register, remember or copy.
-final class FastImageAnimated {
-    private FastImageAnimated() {}
-
-    interface CopyCallback {
-        void onCopy(@Nullable Drawable copy);
-    }
-
-    static void register(@NonNull Context context, @NonNull Glide glide, @NonNull Registry registry) {}
-
-    @Nullable
-    static Integer repeatCount(@NonNull Drawable drawable) {
-        return null;
-    }
-
-    static boolean shownElsewhere(@NonNull Drawable drawable, @NonNull Drawable.Callback view) {
-        return false;
-    }
-
-    static void copy(@NonNull Drawable drawable, @NonNull CopyCallback callback) {
-        callback.onCopy(null);
-    }
-}

package/android/src/main/java/com/dylanvann/fastimage/FastImageApngRenderer.java

@@ -1,152 +0,0 @@
-package com.dylanvann.fastimage;
-
-import android.graphics.Rect;
-import android.graphics.drawable.Drawable;
-
-import androidx.annotation.NonNull;
-import androidx.annotation.Nullable;
-
-import com.bumptech.glide.load.engine.Resource;
-import com.github.penfeizhou.animation.apng.APNGDrawable;
-import com.github.penfeizhou.animation.apng.decode.APNGDecoder;
-import com.github.penfeizhou.animation.loader.ByteBufferLoader;
-import com.github.penfeizhou.animation.loader.Loader;
-
-import java.nio.ByteBuffer;
-
-// APNGs with APNG4Android (FastImageApng, which only uses this when it's
-// there). Glide keeps the image's data in its memory cache, and each view
-// gets a drawable of its own over it, so views don't share playback: making
-// one only reads the image's header, and it decodes its frames (at a sample
-// size from the size it's drawn at) on APNG4Android's threads as it plays.
-final class FastImageApngRenderer {
-    private FastImageApngRenderer() {
-    }
-
-    // Throws NoClassDefFoundError without APNG4Android.
-    static boolean available() {
-        return APNGDrawable.class.getName() != null;
-    }
-
-    private static Loader loader(ByteBuffer data) {
-        return new ByteBufferLoader() {
-            @Override
-            public ByteBuffer getByteBuffer() {
-                ByteBuffer buffer = data.duplicate();
-                buffer.position(0);
-                return buffer;
-            }
-        };
-    }
-
-    // Null if APNG4Android can't read it (Glide then decodes it as a PNG).
-    @Nullable
-    static Resource<Drawable> decode(@NonNull ByteBuffer data, int plays) {
-        // Reads the header, waiting for APNG4Android's thread.
-        Rect bounds = new APNGDecoder(loader(data), null).getBounds();
-        if (bounds.isEmpty()) return null;
-        return new ApngResource(data, plays, bounds);
-    }
-
-    private static final class ApngResource implements Resource<Drawable> {
-        private final ByteBuffer data;
-        private final int plays;
-        private final Rect bounds;
-
-        ApngResource(ByteBuffer data, int plays, Rect bounds) {
-            this.data = data;
-            this.plays = plays;
-            this.bounds = bounds;
-        }
-
-        @NonNull
-        @Override
-        public Class<Drawable> getResourceClass() {
-            return Drawable.class;
-        }
-
-        @NonNull
-        @Override
-        public Drawable get() {
-            return new ApngDrawable(loader(data), plays);
-        }
-
-        // The data, and a frame at full size (each view's drawable has its
-        // own, at the size it's drawn at).
-        @Override
-        public int getSize() {
-            return data.limit() + bounds.width() * bounds.height() * 4;
-        }
-
-        @Override
-        public void recycle() {
-        }
-    }
-
-    private static final class ApngDrawable extends APNGDrawable implements FastImageAnimatable {
-        // How many times the file says it plays (0: forever).
-        private final int plays;
-        private volatile boolean paused = false;
-        // Once a frame has been rendered (on the decoder's thread).
-        private volatile boolean rendered = false;
-
-        ApngDrawable(Loader loader, int plays) {
-            super(loader);
-            this.plays = plays;
-        }
-
-        @Override
-        public void setLoopCount(int loopCount, boolean restart) {
-            // Plays (0: forever), as APNG4Android counts them.
-            setLoopLimit(loopCount == -1 ? plays : loopCount);
-            if (restart) {
-                reset();
-                start();
-            }
-        }
-
-        @Override
-        public void setPaused(boolean paused) {
-            this.paused = paused;
-            // It starts and stops itself as it's shown and hidden, but not
-            // while paused.
-            setAutoPlay(!paused);
-            if (paused) {
-                // Before the first frame, onStart pauses once it's rendered:
-                // the decoder's start clears a pause, then skips rendering if
-                // one came in meanwhile, which left the view blank.
-                if (rendered) pause();
-            } else {
-                resume();
-            }
-        }
-
-        // From its first frame. The target starts it right after
-        // setVisible(true) has (auto play): APNG4Android's start() stops and
-        // starts a running decoder, and a stop made while the decoder is
-        // still starting can win over that start, leaving it stopped on its
-        // first frame. A running one is reset to its first frame instead.
-        @Override
-        public void start() {
-            if (isRunning()) {
-                getFrameSeqDecoder().reset();
-                return;
-            }
-            super.start();
-        }
-
-        @Override
-        public void onRender(ByteBuffer byteBuffer) {
-            super.onRender(byteBuffer);
-            rendered = true;
-        }
-
-        // On its decoder thread, once starting has drawn the first frame:
-        // starting clears a pause made before it got there, so pause again.
-        @Override
-        public void onStart() {
-            super.onStart();
-            if (paused) getFrameSeqDecoder().pause();
-        }
-    }
-}