@octane-xplat/nativescript-mason-core 0.0.1 → 1.0.0-beta.1

package/platforms/ios/include/SDWebImage/SDWebImageDownloaderRequestModifier.h

@@ -0,0 +1,72 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import <Foundation/Foundation.h>
+#import "SDWebImageCompat.h"
+
+typedef NSURLRequest * _Nullable (^SDWebImageDownloaderRequestModifierBlock)(NSURLRequest * _Nonnull request);
+
+/**
+ This is the protocol for downloader request modifier.
+ We can use a block to specify the downloader request modifier. But Using protocol can make this extensible, and allow Swift user to use it easily instead of using `@convention(block)` to store a block into context options.
+ */
+@protocol SDWebImageDownloaderRequestModifier <NSObject>
+
+/// Modify the original URL request and return a new one instead. You can modify the HTTP header, cachePolicy, etc for this URL.
+/// @param request The original URL request for image loading
+/// @note If return nil, the URL request will be cancelled.
+- (nullable NSURLRequest *)modifiedRequestWithRequest:(nonnull NSURLRequest *)request;
+
+@end
+
+/**
+ A downloader request modifier class with block.
+ */
+@interface SDWebImageDownloaderRequestModifier : NSObject <SDWebImageDownloaderRequestModifier>
+
+/// Create the request modifier with block
+/// @param block A block to control modifier logic
+- (nonnull instancetype)initWithBlock:(nonnull SDWebImageDownloaderRequestModifierBlock)block;
+
+/// Create the request modifier with block
+/// @param block A block to control modifier logic
++ (nonnull instancetype)requestModifierWithBlock:(nonnull SDWebImageDownloaderRequestModifierBlock)block;
+
+- (nonnull instancetype)init NS_UNAVAILABLE;
++ (nonnull instancetype)new  NS_UNAVAILABLE;
+
+@end
+
+/**
+A convenient request modifier to provide the HTTP request including HTTP Method, Headers and Body.
+*/
+@interface SDWebImageDownloaderRequestModifier (Conveniences)
+
+/// Create the request modifier with HTTP Method.
+/// @param method HTTP Method, nil means to GET.
+/// @note This is for convenience, if you need code to control the logic, use block API instead.
+- (nonnull instancetype)initWithMethod:(nullable NSString *)method;
+
+/// Create the request modifier with HTTP Headers.
+/// @param headers HTTP Headers. Case insensitive according to HTTP/1.1(HTTP/2) standard. The headers will override the same fields from original request.
+/// @note This is for convenience, if you need code to control the logic, use block API instead.
+- (nonnull instancetype)initWithHeaders:(nullable NSDictionary<NSString *, NSString *> *)headers;
+
+/// Create the request modifier with HTTP Body.
+/// @param body HTTP Body.
+/// @note This is for convenience, if you need code to control the logic, use block API instead.
+- (nonnull instancetype)initWithBody:(nullable NSData *)body;
+
+/// Create the request modifier with HTTP Method, Headers and Body.
+/// @param method HTTP Method, nil means to GET.
+/// @param headers HTTP Headers. Case insensitive according to HTTP/1.1(HTTP/2) standard. The headers will override the same fields from original request.
+/// @param body HTTP Body.
+/// @note This is for convenience, if you need code to control the logic, use block API instead.
+- (nonnull instancetype)initWithMethod:(nullable NSString *)method headers:(nullable NSDictionary<NSString *, NSString *> *)headers body:(nullable NSData *)body;
+
+@end

package/platforms/ios/include/SDWebImage/SDWebImageDownloaderResponseModifier.h

@@ -0,0 +1,72 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import <Foundation/Foundation.h>
+#import "SDWebImageCompat.h"
+
+typedef NSURLResponse * _Nullable (^SDWebImageDownloaderResponseModifierBlock)(NSURLResponse * _Nonnull response);
+
+/**
+ This is the protocol for downloader response modifier.
+ We can use a block to specify the downloader response modifier. But Using protocol can make this extensible, and allow Swift user to use it easily instead of using `@convention(block)` to store a block into context options.
+ */
+@protocol SDWebImageDownloaderResponseModifier <NSObject>
+
+/// Modify the original URL response and return a new response. You can use this to check MIME-Type, mock server response, etc.
+/// @param response The original URL response, note for HTTP request it's actually a `NSHTTPURLResponse` instance
+/// @note If nil is returned, the image download will marked as cancelled with error `SDWebImageErrorInvalidDownloadResponse`
+- (nullable NSURLResponse *)modifiedResponseWithResponse:(nonnull NSURLResponse *)response;
+
+@end
+
+/**
+ A downloader response modifier class with block.
+ */
+@interface SDWebImageDownloaderResponseModifier : NSObject <SDWebImageDownloaderResponseModifier>
+
+/// Create the response modifier with block
+/// @param block A block to control modifier logic
+- (nonnull instancetype)initWithBlock:(nonnull SDWebImageDownloaderResponseModifierBlock)block;
+
+/// Create the response modifier with block
+/// @param block A block to control modifier logic
++ (nonnull instancetype)responseModifierWithBlock:(nonnull SDWebImageDownloaderResponseModifierBlock)block;
+
+- (nonnull instancetype)init NS_UNAVAILABLE;
++ (nonnull instancetype)new  NS_UNAVAILABLE;
+
+@end
+
+/**
+A convenient response modifier to provide the HTTP response including HTTP Status Code, Version and Headers.
+*/
+@interface SDWebImageDownloaderResponseModifier (Conveniences)
+
+/// Create the response modifier with HTTP Status code.
+/// @param statusCode HTTP Status Code.
+/// @note This is for convenience, if you need code to control the logic, use block API instead.
+- (nonnull instancetype)initWithStatusCode:(NSInteger)statusCode;
+
+/// Create the response modifier with HTTP Version. Status code defaults to 200.
+/// @param version HTTP Version, nil means "HTTP/1.1".
+/// @note This is for convenience, if you need code to control the logic, use block API instead.
+- (nonnull instancetype)initWithVersion:(nullable NSString *)version;
+
+/// Create the response modifier with HTTP Headers. Status code defaults to 200.
+/// @param headers HTTP Headers. Case insensitive according to HTTP/1.1(HTTP/2) standard. The headers will override the same fields from original response.
+/// @note This is for convenience, if you need code to control the logic, use block API instead.
+- (nonnull instancetype)initWithHeaders:(nullable NSDictionary<NSString *, NSString *> *)headers;
+
+/// Create the response modifier with HTTP Status Code, Version and Headers.
+/// @param statusCode HTTP Status Code.
+/// @param version HTTP Version, nil means "HTTP/1.1".
+/// @param headers HTTP Headers. Case insensitive according to HTTP/1.1(HTTP/2) standard. The headers will override the same fields from original response.
+/// @note This is for convenience, if you need code to control the logic, use block API instead.
+- (nonnull instancetype)initWithStatusCode:(NSInteger)statusCode version:(nullable NSString *)version headers:(nullable NSDictionary<NSString *, NSString *> *)headers;
+
+@end

package/platforms/ios/include/SDWebImage/SDWebImageError.h

@@ -0,0 +1,33 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ * (c) Jamie Pinkham
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import "SDWebImageCompat.h"
+
+/// An error domain represent SDWebImage loading system with custom codes
+FOUNDATION_EXPORT NSErrorDomain const _Nonnull SDWebImageErrorDomain;
+
+/// The response instance for invalid download response (NSURLResponse *)
+FOUNDATION_EXPORT NSErrorUserInfoKey const _Nonnull SDWebImageErrorDownloadResponseKey;
+/// The HTTP status code for invalid download response (NSNumber *)
+FOUNDATION_EXPORT NSErrorUserInfoKey const _Nonnull SDWebImageErrorDownloadStatusCodeKey;
+/// The HTTP MIME content type for invalid download response (NSString *)
+FOUNDATION_EXPORT NSErrorUserInfoKey const _Nonnull SDWebImageErrorDownloadContentTypeKey;
+
+/// SDWebImage error domain and codes
+typedef NS_ERROR_ENUM(SDWebImageErrorDomain, SDWebImageError) {
+    SDWebImageErrorInvalidURL = 1000, // The URL is invalid, such as nil URL or corrupted URL
+    SDWebImageErrorBadImageData = 1001, // The image data can not be decoded to image, or the image data is empty
+    SDWebImageErrorCacheNotModified = 1002, // The remote location specify that the cached image is not modified, such as the HTTP response 304 code. It's useful for `SDWebImageRefreshCached`
+    SDWebImageErrorBlackListed = 1003, // The URL is blacklisted because of unrecoverable failure marked by downloader (such as 404), you can use `.retryFailed` option to avoid this
+    SDWebImageErrorInvalidDownloadOperation = 2000, // The image download operation is invalid, such as nil operation or unexpected error occur when operation initialized
+    SDWebImageErrorInvalidDownloadStatusCode = 2001, // The image download response a invalid status code. You can check the status code in error's userInfo under `SDWebImageErrorDownloadStatusCodeKey`
+    SDWebImageErrorCancelled = 2002, // The image loading operation is cancelled before finished, during either async disk cache query, or waiting before actual network request. For actual network request error, check `NSURLErrorDomain` error domain and code.
+    SDWebImageErrorInvalidDownloadResponse = 2003, // When using response modifier, the modified download response is nil and marked as failed.
+    SDWebImageErrorInvalidDownloadContentType = 2004, // The image download response a invalid content type. You can check the MIME content type in error's userInfo under `SDWebImageErrorDownloadContentTypeKey`
+};

package/platforms/ios/include/SDWebImage/SDWebImageIndicator.h

@@ -0,0 +1,119 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import "SDWebImageCompat.h"
+
+#if SD_UIKIT || SD_MAC
+
+/**
+ A protocol to custom the indicator during the image loading.
+ All of these methods are called from main queue.
+ */
+@protocol SDWebImageIndicator <NSObject>
+
+@required
+/**
+ The view associate to the indicator.
+
+ @return The indicator view
+ */
+@property (nonatomic, strong, readonly, nonnull) UIView *indicatorView;
+
+/**
+ Start the animating for indicator.
+ */
+- (void)startAnimatingIndicator;
+
+/**
+ Stop the animating for indicator.
+ */
+- (void)stopAnimatingIndicator;
+
+@optional
+/**
+ Update the loading progress (0-1.0) for indicator. Optional
+ 
+ @param progress The progress, value between 0 and 1.0
+ */
+- (void)updateIndicatorProgress:(double)progress;
+
+@end
+
+#pragma mark - Activity Indicator
+
+/**
+ Activity indicator class.
+ for UIKit(macOS), it use a `UIActivityIndicatorView`.
+ for AppKit(macOS), it use a `NSProgressIndicator` with the spinning style.
+ */
+@interface SDWebImageActivityIndicator : NSObject <SDWebImageIndicator>
+
+#if SD_UIKIT
+@property (nonatomic, strong, readonly, nonnull) UIActivityIndicatorView *indicatorView;
+#else
+@property (nonatomic, strong, readonly, nonnull) NSProgressIndicator *indicatorView;
+#endif
+
+@end
+
+/**
+ Convenience way to use activity indicator.
+ */
+@interface SDWebImageActivityIndicator (Conveniences)
+
+#if !SD_VISION
+/// These indicator use the fixed color without dark mode support
+/// gray-style activity indicator
+@property (nonatomic, class, nonnull, readonly) SDWebImageActivityIndicator *grayIndicator;
+/// large gray-style activity indicator
+@property (nonatomic, class, nonnull, readonly) SDWebImageActivityIndicator *grayLargeIndicator;
+/// white-style activity indicator
+@property (nonatomic, class, nonnull, readonly) SDWebImageActivityIndicator *whiteIndicator;
+/// large white-style activity indicator
+@property (nonatomic, class, nonnull, readonly) SDWebImageActivityIndicator *whiteLargeIndicator;
+#endif
+/// These indicator use the system style, supports dark mode if available (iOS 13+/macOS 10.14+)
+/// large activity indicator
+@property (nonatomic, class, nonnull, readonly) SDWebImageActivityIndicator *largeIndicator;
+/// medium activity indicator
+@property (nonatomic, class, nonnull, readonly) SDWebImageActivityIndicator *mediumIndicator;
+
+@end
+
+#pragma mark - Progress Indicator
+
+/**
+ Progress indicator class.
+ for UIKit(macOS), it use a `UIProgressView`.
+ for AppKit(macOS), it use a `NSProgressIndicator` with the bar style.
+ */
+@interface SDWebImageProgressIndicator : NSObject <SDWebImageIndicator>
+
+#if SD_UIKIT
+@property (nonatomic, strong, readonly, nonnull) UIProgressView *indicatorView;
+#else
+@property (nonatomic, strong, readonly, nonnull) NSProgressIndicator *indicatorView;
+#endif
+
+@end
+
+/**
+ Convenience way to create progress indicator. Remember to specify the indicator width or use layout constraint if need.
+ */
+@interface SDWebImageProgressIndicator (Conveniences)
+
+/// default-style progress indicator
+@property (nonatomic, class, nonnull, readonly) SDWebImageProgressIndicator *defaultIndicator;
+#if SD_UIKIT
+/// bar-style progress indicator
+@property (nonatomic, class, nonnull, readonly) SDWebImageProgressIndicator *barIndicator API_UNAVAILABLE(tvos);
+#endif
+
+@end
+
+#endif

package/platforms/ios/include/SDWebImage/SDWebImageManager.h

@@ -0,0 +1,290 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import "SDWebImageCompat.h"
+#import "SDWebImageOperation.h"
+#import "SDImageCacheDefine.h"
+#import "SDImageLoader.h"
+#import "SDImageTransformer.h"
+#import "SDWebImageCacheKeyFilter.h"
+#import "SDWebImageCacheSerializer.h"
+#import "SDWebImageOptionsProcessor.h"
+
+typedef void(^SDExternalCompletionBlock)(UIImage * _Nullable image, NSError * _Nullable error, SDImageCacheType cacheType, NSURL * _Nullable imageURL);
+
+typedef void(^SDInternalCompletionBlock)(UIImage * _Nullable image, NSData * _Nullable data, NSError * _Nullable error, SDImageCacheType cacheType, BOOL finished, NSURL * _Nullable imageURL);
+
+/**
+ A combined operation representing the cache and loader operation. You can use it to cancel the load process.
+ */
+@interface SDWebImageCombinedOperation : NSObject <SDWebImageOperation>
+
+/**
+ Cancel the current operation, including cache and loader process
+ */
+- (void)cancel;
+
+/// Whether the operation has been cancelled.
+@property (nonatomic, assign, readonly, getter=isCancelled) BOOL cancelled;
+
+/**
+ The cache operation from the image cache query
+ */
+@property (strong, nonatomic, nullable, readonly) id<SDWebImageOperation> cacheOperation;
+
+/**
+ The loader operation from the image loader (such as download operation)
+ */
+@property (strong, nonatomic, nullable, readonly) id<SDWebImageOperation> loaderOperation;
+
+@end
+
+
+@class SDWebImageManager;
+
+/**
+ The manager delegate protocol.
+ */
+@protocol SDWebImageManagerDelegate <NSObject>
+
+@optional
+
+/**
+ * Controls which image should be downloaded when the image is not found in the cache.
+ *
+ * @param imageManager The current `SDWebImageManager`
+ * @param imageURL     The url of the image to be downloaded
+ *
+ * @return Return NO to prevent the downloading of the image on cache misses. If not implemented, YES is implied.
+ */
+- (BOOL)imageManager:(nonnull SDWebImageManager *)imageManager shouldDownloadImageForURL:(nonnull NSURL *)imageURL;
+
+/**
+ * Controls the complicated logic to mark as failed URLs when download error occur.
+ * If the delegate implement this method, we will not use the built-in way to mark URL as failed based on error code;
+ @param imageManager The current `SDWebImageManager`
+ @param imageURL The url of the image
+ @param error The download error for the url
+ @return Whether to block this url or not. Return YES to mark this URL as failed.
+ */
+- (BOOL)imageManager:(nonnull SDWebImageManager *)imageManager shouldBlockFailedURL:(nonnull NSURL *)imageURL withError:(nonnull NSError *)error;
+
+@end
+
+/**
+ * The SDWebImageManager is the class behind the UIImageView+WebCache category and likes.
+ * It ties the asynchronous downloader (SDWebImageDownloader) with the image cache store (SDImageCache).
+ * You can use this class directly to benefit from web image downloading with caching in another context than
+ * a UIView.
+ *
+ * Here is a simple example of how to use SDWebImageManager:
+ *
+ * @code
+
+SDWebImageManager *manager = [SDWebImageManager sharedManager];
+[manager loadImageWithURL:imageURL
+                  options:0
+                 progress:nil
+                completed:^(UIImage *image, NSData *data, NSError *error, SDImageCacheType cacheType, BOOL finished, NSURL *imageURL) {
+                    if (image) {
+                        // do something with image
+                    }
+                }];
+
+ * @endcode
+ */
+@interface SDWebImageManager : NSObject
+
+/**
+ * The delegate for manager. Defaults to nil.
+ */
+@property (weak, nonatomic, nullable) id <SDWebImageManagerDelegate> delegate;
+
+/**
+ * The image cache used by manager to query image cache.
+ */
+@property (strong, nonatomic, readonly, nonnull) id<SDImageCache> imageCache;
+
+/**
+ * The image loader used by manager to load image.
+ */
+@property (strong, nonatomic, readonly, nonnull) id<SDImageLoader> imageLoader;
+
+/**
+ The image transformer for manager. It's used for image transform after the image load finished and store the transformed image to cache, see `SDImageTransformer`.
+ Defaults to nil, which means no transform is applied.
+ @note This will affect all the load requests for this manager if you provide. However, you can pass `SDWebImageContextImageTransformer` in context arg to explicitly use that transformer instead.
+ */
+@property (strong, nonatomic, nullable) id<SDImageTransformer> transformer;
+
+/**
+ * The cache filter is used to convert an URL into a cache key each time SDWebImageManager need cache key to use image cache.
+ *
+ * The following example sets a filter in the application delegate that will remove any query-string from the
+ * URL before to use it as a cache key:
+ *
+ * @code
+ SDWebImageManager.sharedManager.cacheKeyFilter =[SDWebImageCacheKeyFilter cacheKeyFilterWithBlock:^NSString * _Nullable(NSURL * _Nonnull url) {
+    url = [[NSURL alloc] initWithScheme:url.scheme host:url.host path:url.path];
+    return [url absoluteString];
+ }];
+ * @endcode
+ */
+@property (nonatomic, strong, nullable) id<SDWebImageCacheKeyFilter> cacheKeyFilter;
+
+/**
+ * The cache serializer is used to convert the decoded image, the source downloaded data, to the actual data used for storing to the disk cache. If you return nil, means to generate the data from the image instance, see `SDImageCache`.
+ * For example, if you are using WebP images and facing the slow decoding time issue when later retrieving from disk cache again. You can try to encode the decoded image to JPEG/PNG format to disk cache instead of source downloaded data.
+ * @note The `image` arg is nonnull, but when you also provide an image transformer and the image is transformed, the `data` arg may be nil, take attention to this case.
+ * @note This method is called from a global queue in order to not to block the main thread.
+ * @code
+ SDWebImageManager.sharedManager.cacheSerializer = [SDWebImageCacheSerializer cacheSerializerWithBlock:^NSData * _Nullable(UIImage * _Nonnull image, NSData * _Nullable data, NSURL * _Nullable imageURL) {
+    SDImageFormat format = [NSData sd_imageFormatForImageData:data];
+    switch (format) {
+        case SDImageFormatWebP:
+            return image.images ? data : nil;
+        default:
+            return data;
+    }
+}];
+ * @endcode
+ * The default value is nil. Means we just store the source downloaded data to disk cache.
+ */
+@property (nonatomic, strong, nullable) id<SDWebImageCacheSerializer> cacheSerializer;
+
+/**
+ The options processor is used, to have a global control for all the image request options and context option for current manager.
+ @note If you use `transformer`, `cacheKeyFilter` or `cacheSerializer` property of manager, the input context option already apply those properties before passed. This options processor is a better replacement for those property in common usage.
+ For example, you can control the global options, based on the URL or original context option like the below code.
+ 
+ * @code
+ SDWebImageManager.sharedManager.optionsProcessor = [SDWebImageOptionsProcessor optionsProcessorWithBlock:^SDWebImageOptionsResult * _Nullable(NSURL * _Nullable url, SDWebImageOptions options, SDWebImageContext * _Nullable context) {
+     // Only do animation on `SDAnimatedImageView`
+     if (!context[SDWebImageContextAnimatedImageClass]) {
+        options |= SDWebImageDecodeFirstFrameOnly;
+     }
+     // Do not force decode for png url
+     if ([url.lastPathComponent isEqualToString:@"png"]) {
+        options |= SDWebImageAvoidDecodeImage;
+     }
+     // Always use screen scale factor
+     SDWebImageMutableContext *mutableContext = [NSDictionary dictionaryWithDictionary:context];
+     mutableContext[SDWebImageContextImageScaleFactor] = @(UIScreen.mainScreen.scale);
+     context = [mutableContext copy];
+ 
+     return [[SDWebImageOptionsResult alloc] initWithOptions:options context:context];
+ }];
+ * @endcode
+ */
+@property (nonatomic, strong, nullable) id<SDWebImageOptionsProcessor> optionsProcessor;
+
+/**
+ * Check one or more operations running
+ */
+@property (nonatomic, assign, readonly, getter=isRunning) BOOL running;
+
+/**
+ The default image cache when the manager which is created with no arguments. Such as shared manager or init.
+ Defaults to nil. Means using `SDImageCache.sharedImageCache`
+ */
+@property (nonatomic, class, nullable) id<SDImageCache> defaultImageCache;
+
+/**
+ The default image loader for manager which is created with no arguments. Such as shared manager or init.
+ Defaults to nil. Means using `SDWebImageDownloader.sharedDownloader`
+ */
+@property (nonatomic, class, nullable) id<SDImageLoader> defaultImageLoader;
+
+/**
+ * Returns global shared manager instance.
+ */
+@property (nonatomic, class, readonly, nonnull) SDWebImageManager *sharedManager;
+
+/**
+ * Allows to specify instance of cache and image loader used with image manager.
+ * @return new instance of `SDWebImageManager` with specified cache and loader.
+ */
+- (nonnull instancetype)initWithCache:(nonnull id<SDImageCache>)cache loader:(nonnull id<SDImageLoader>)loader NS_DESIGNATED_INITIALIZER;
+
+/**
+ * Downloads the image at the given URL if not present in cache or return the cached version otherwise.
+ *
+ * @param url            The URL to the image
+ * @param options        A mask to specify options to use for this request
+ * @param progressBlock  A block called while image is downloading
+ *                       @note the progress block is executed on a background queue
+ * @param completedBlock A block called when operation has been completed.
+ *
+ *   This parameter is required.
+ * 
+ *   This block has no return value and takes the requested UIImage as first parameter and the NSData representation as second parameter.
+ *   In case of error the image parameter is nil and the third parameter may contain an NSError.
+ *
+ *   The forth parameter is an `SDImageCacheType` enum indicating if the image was retrieved from the local cache
+ *   or from the memory cache or from the network.
+ *
+ *   The fifth parameter is set to NO when the SDWebImageProgressiveLoad option is used and the image is
+ *   downloading. This block is thus called repeatedly with a partial image. When image is fully downloaded, the
+ *   block is called a last time with the full image and the last parameter set to YES.
+ *
+ *   The last parameter is the original image URL
+ *
+ * @return Returns an instance of SDWebImageCombinedOperation, which you can cancel the loading process.
+ */
+- (nullable SDWebImageCombinedOperation *)loadImageWithURL:(nullable NSURL *)url
+                                                   options:(SDWebImageOptions)options
+                                                  progress:(nullable SDImageLoaderProgressBlock)progressBlock
+                                                 completed:(nonnull SDInternalCompletionBlock)completedBlock;
+
+/**
+ * Downloads the image at the given URL if not present in cache or return the cached version otherwise.
+ *
+ * @param url            The URL to the image
+ * @param options        A mask to specify options to use for this request
+ * @param context        A context contains different options to perform specify changes or processes, see `SDWebImageContextOption`. This hold the extra objects which `options` enum can not hold.
+ * @param progressBlock  A block called while image is downloading
+ *                       @note the progress block is executed on a background queue
+ * @param completedBlock A block called when operation has been completed.
+ *
+ * @return Returns an instance of SDWebImageCombinedOperation, which you can cancel the loading process.
+ */
+- (nullable SDWebImageCombinedOperation *)loadImageWithURL:(nullable NSURL *)url
+                                                   options:(SDWebImageOptions)options
+                                                   context:(nullable SDWebImageContext *)context
+                                                  progress:(nullable SDImageLoaderProgressBlock)progressBlock
+                                                 completed:(nonnull SDInternalCompletionBlock)completedBlock;
+
+/**
+ * Cancel all current operations
+ */
+- (void)cancelAll;
+
+/**
+ * Remove the specify URL from failed black list.
+ * @param url The failed URL.
+ */
+- (void)removeFailedURL:(nonnull NSURL *)url;
+
+/**
+ * Remove all the URL from failed black list.
+ */
+- (void)removeAllFailedURLs;
+
+/**
+ * Return the cache key for a given URL, does not considerate transformer or thumbnail.
+ * @note This method does not have context option, only use the url and manager level cacheKeyFilter to generate the cache key.
+ */
+- (nullable NSString *)cacheKeyForURL:(nullable NSURL *)url;
+
+/**
+ * Return the cache key for a given URL and context option.
+ * @note The context option like `.thumbnailPixelSize` and `.imageTransformer` will effect the generated cache key, using this if you have those context associated.
+*/
+- (nullable NSString *)cacheKeyForURL:(nullable NSURL *)url context:(nullable SDWebImageContext *)context;
+
+@end

package/platforms/ios/include/SDWebImage/SDWebImageOperation.h

@@ -0,0 +1,27 @@
+/*
+ * This file is part of the SDWebImage package.
+ * (c) Olivier Poitrey <rs@dailymotion.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+#import <Foundation/Foundation.h>
+
+/// A protocol represents cancelable operation.
+@protocol SDWebImageOperation <NSObject>
+
+/// Cancel the operation
+- (void)cancel;
+
+@optional
+
+/// Whether the operation has been cancelled.
+@property (nonatomic, assign, readonly, getter=isCancelled) BOOL cancelled;
+
+@end
+
+/// NSOperation conform to `SDWebImageOperation`.
+@interface NSOperation (SDWebImageOperation) <SDWebImageOperation>
+
+@end