@momo-kits/native-kits 0.0.1-beta.4 → 0.0.1-beta.5

package/example/ios/Pods/SDWebImage/SDWebImage/Core/SDWebImageDownloaderConfig.h

@@ -0,0 +1,113 @@
+/*
+ * 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"
+
+/// Operation execution order
+typedef NS_ENUM(NSInteger, SDWebImageDownloaderExecutionOrder) {
+    /**
+     * Default value. All download operations will execute in queue style (first-in-first-out).
+     */
+    SDWebImageDownloaderFIFOExecutionOrder,
+    
+    /**
+     * All download operations will execute in stack style (last-in-first-out).
+     */
+    SDWebImageDownloaderLIFOExecutionOrder
+};
+
+/**
+ The class contains all the config for image downloader
+ @note This class conform to NSCopying, make sure to add the property in `copyWithZone:` as well.
+ */
+@interface SDWebImageDownloaderConfig : NSObject <NSCopying>
+
+/**
+ Gets the default downloader config used for shared instance or initialization when it does not provide any downloader config. Such as `SDWebImageDownloader.sharedDownloader`.
+ @note You can modify the property on default downloader config, which can be used for later created downloader instance. The already created downloader instance does not get affected.
+ */
+@property (nonatomic, class, readonly, nonnull) SDWebImageDownloaderConfig *defaultDownloaderConfig;
+
+/**
+ * The maximum number of concurrent downloads.
+ * Defaults to 6.
+ */
+@property (nonatomic, assign) NSInteger maxConcurrentDownloads;
+
+/**
+ * The timeout value (in seconds) for each download operation.
+ * Defaults to 15.0.
+ */
+@property (nonatomic, assign) NSTimeInterval downloadTimeout;
+
+/**
+ * The minimum interval about progress percent during network downloading. Which means the next progress callback and current progress callback's progress percent difference should be larger or equal to this value. However, the final finish download progress callback does not get effected.
+ * The value should be 0.0-1.0.
+ * @note If you're using progressive decoding feature, this will also effect the image refresh rate.
+ * @note This value may enhance the performance if you don't want progress callback too frequently.
+ * Defaults to 0, which means each time we receive the new data from URLSession, we callback the progressBlock immediately.
+ */
+@property (nonatomic, assign) double minimumProgressInterval;
+
+/**
+ * The custom session configuration in use by NSURLSession. If you don't provide one, we will use `defaultSessionConfiguration` instead.
+ * Defatuls to nil.
+ * @note This property does not support dynamic changes, means it's immutable after the downloader instance initialized.
+ */
+@property (nonatomic, strong, nullable) NSURLSessionConfiguration *sessionConfiguration;
+
+/**
+ * Gets/Sets a subclass of `SDWebImageDownloaderOperation` as the default
+ * `NSOperation` to be used each time SDWebImage constructs a request
+ * operation to download an image.
+ * Defaults to nil.
+ * @note Passing `NSOperation<SDWebImageDownloaderOperation>` to set as default. Passing `nil` will revert to `SDWebImageDownloaderOperation`.
+ */
+@property (nonatomic, assign, nullable) Class operationClass;
+
+/**
+ * Changes download operations execution order.
+ * Defaults to `SDWebImageDownloaderFIFOExecutionOrder`.
+ */
+@property (nonatomic, assign) SDWebImageDownloaderExecutionOrder executionOrder;
+
+/**
+ * Set the default URL credential to be set for request operations.
+ * Defaults to nil.
+ */
+@property (nonatomic, copy, nullable) NSURLCredential *urlCredential;
+
+/**
+ * Set username using for HTTP Basic authentication.
+ * Defaults to nil.
+ */
+@property (nonatomic, copy, nullable) NSString *username;
+
+/**
+ * Set password using for HTTP Basic authentication.
+ * Defaults to nil.
+ */
+@property (nonatomic, copy, nullable) NSString *password;
+
+/**
+ * Set the acceptable HTTP Response status code. The status code which beyond the range will mark the download operation failed.
+ * For example, if we config [200, 400) but server response is 503, the download will fail with error code `SDWebImageErrorInvalidDownloadStatusCode`.
+ * Defaults to [200,400). Nil means no validation at all.
+ */
+@property (nonatomic, copy, nullable) NSIndexSet *acceptableStatusCodes;
+
+/**
+ * Set the acceptable HTTP Response content type. The content type beyond the set will mark the download operation failed.
+ * For example, if we config ["image/png"] but server response is "application/json", the download will fail with error code `SDWebImageErrorInvalidDownloadContentType`.
+ * Normally you don't need this for image format detection because we use image's data file signature magic bytes: https://en.wikipedia.org/wiki/List_of_file_signatures
+ * Defaults to nil. Nil means no validation at all.
+ */
+@property (nonatomic, copy, nullable) NSSet<NSString *> *acceptableContentTypes;
+
+@end

package/example/ios/Pods/SDWebImage/SDWebImage/Core/SDWebImageDownloaderConfig.m

@@ -0,0 +1,60 @@
+/*
+ * 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 "SDWebImageDownloaderConfig.h"
+#import "SDWebImageDownloaderOperation.h"
+
+static SDWebImageDownloaderConfig * _defaultDownloaderConfig;
+
+@implementation SDWebImageDownloaderConfig
+
++ (SDWebImageDownloaderConfig *)defaultDownloaderConfig {
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+        _defaultDownloaderConfig = [SDWebImageDownloaderConfig new];
+    });
+    return _defaultDownloaderConfig;
+}
+
+- (instancetype)init {
+    self = [super init];
+    if (self) {
+        _maxConcurrentDownloads = 6;
+        _downloadTimeout = 15.0;
+        _executionOrder = SDWebImageDownloaderFIFOExecutionOrder;
+        _acceptableStatusCodes = [NSIndexSet indexSetWithIndexesInRange:NSMakeRange(200, 100)];
+    }
+    return self;
+}
+
+- (id)copyWithZone:(NSZone *)zone {
+    SDWebImageDownloaderConfig *config = [[[self class] allocWithZone:zone] init];
+    config.maxConcurrentDownloads = self.maxConcurrentDownloads;
+    config.downloadTimeout = self.downloadTimeout;
+    config.minimumProgressInterval = self.minimumProgressInterval;
+    config.sessionConfiguration = [self.sessionConfiguration copyWithZone:zone];
+    config.operationClass = self.operationClass;
+    config.executionOrder = self.executionOrder;
+    config.urlCredential = self.urlCredential;
+    config.username = self.username;
+    config.password = self.password;
+    config.acceptableStatusCodes = self.acceptableStatusCodes;
+    config.acceptableContentTypes = self.acceptableContentTypes;
+    
+    return config;
+}
+
+- (void)setOperationClass:(Class)operationClass {
+    if (operationClass) {
+        NSAssert([operationClass isSubclassOfClass:[NSOperation class]] && [operationClass conformsToProtocol:@protocol(SDWebImageDownloaderOperation)], @"Custom downloader operation class must subclass NSOperation and conform to `SDWebImageDownloaderOperation` protocol");
+    }
+    _operationClass = operationClass;
+}
+
+
+@end

package/example/ios/Pods/SDWebImage/SDWebImage/Core/SDWebImageDownloaderDecryptor.h

@@ -0,0 +1,49 @@
+/*
+* 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 NSData * _Nullable (^SDWebImageDownloaderDecryptorBlock)(NSData * _Nonnull data, NSURLResponse * _Nullable response);
+
+/**
+This is the protocol for downloader decryptor. Which decrypt the original encrypted data before decoding. Note progressive decoding is not compatible for decryptor.
+We can use a block to specify the downloader decryptor. 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 SDWebImageDownloaderDecryptor <NSObject>
+
+/// Decrypt the original download data and return a new data. You can use this to decrypt the data using your preferred algorithm.
+/// @param data The original download data
+/// @param response The URL response for data. If you modify the original URL response via response modifier, the modified version will be here. This arg is nullable.
+/// @note If nil is returned, the image download will be marked as failed with error `SDWebImageErrorBadImageData`
+- (nullable NSData *)decryptedDataWithData:(nonnull NSData *)data response:(nullable NSURLResponse *)response;
+
+@end
+
+/**
+A downloader response modifier class with block.
+*/
+@interface SDWebImageDownloaderDecryptor : NSObject <SDWebImageDownloaderDecryptor>
+
+/// Create the data decryptor with block
+/// @param block A block to control decrypt logic
+- (nonnull instancetype)initWithBlock:(nonnull SDWebImageDownloaderDecryptorBlock)block;
+
+/// Create the data decryptor with block
+/// @param block A block to control decrypt logic
++ (nonnull instancetype)decryptorWithBlock:(nonnull SDWebImageDownloaderDecryptorBlock)block;
+
+@end
+
+/// Convenience way to create decryptor for common data encryption.
+@interface SDWebImageDownloaderDecryptor (Conveniences)
+
+/// Base64 Encoded image data decryptor
+@property (class, readonly, nonnull) SDWebImageDownloaderDecryptor *base64Decryptor;
+
+@end

package/example/ios/Pods/SDWebImage/SDWebImage/Core/SDWebImageDownloaderDecryptor.m

@@ -0,0 +1,55 @@
+/*
+* 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 "SDWebImageDownloaderDecryptor.h"
+
+@interface SDWebImageDownloaderDecryptor ()
+
+@property (nonatomic, copy, nonnull) SDWebImageDownloaderDecryptorBlock block;
+
+@end
+
+@implementation SDWebImageDownloaderDecryptor
+
+- (instancetype)initWithBlock:(SDWebImageDownloaderDecryptorBlock)block {
+    self = [super init];
+    if (self) {
+        self.block = block;
+    }
+    return self;
+}
+
++ (instancetype)decryptorWithBlock:(SDWebImageDownloaderDecryptorBlock)block {
+    SDWebImageDownloaderDecryptor *decryptor = [[SDWebImageDownloaderDecryptor alloc] initWithBlock:block];
+    return decryptor;
+}
+
+- (nullable NSData *)decryptedDataWithData:(nonnull NSData *)data response:(nullable NSURLResponse *)response {
+    if (!self.block) {
+        return nil;
+    }
+    return self.block(data, response);
+}
+
+@end
+
+@implementation SDWebImageDownloaderDecryptor (Conveniences)
+
++ (SDWebImageDownloaderDecryptor *)base64Decryptor {
+    static SDWebImageDownloaderDecryptor *decryptor;
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+        decryptor = [SDWebImageDownloaderDecryptor decryptorWithBlock:^NSData * _Nullable(NSData * _Nonnull data, NSURLResponse * _Nullable response) {
+            NSData *modifiedData = [[NSData alloc] initWithBase64EncodedData:data options:NSDataBase64DecodingIgnoreUnknownCharacters];
+            return modifiedData;
+        }];
+    });
+    return decryptor;
+}
+
+@end

package/example/ios/Pods/SDWebImage/SDWebImage/Core/SDWebImageDownloaderOperation.h

@@ -0,0 +1,191 @@
+/*
+ * 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 "SDWebImageDownloader.h"
+#import "SDWebImageOperation.h"
+
+/**
+ Describes a downloader operation. If one wants to use a custom downloader op, it needs to inherit from `NSOperation` and conform to this protocol
+ For the description about these methods, see `SDWebImageDownloaderOperation`
+ @note If your custom operation class does not use `NSURLSession` at all, do not implement the optional methods and session delegate methods.
+ */
+@protocol SDWebImageDownloaderOperation <NSURLSessionTaskDelegate, NSURLSessionDataDelegate>
+@required
+- (nonnull instancetype)initWithRequest:(nullable NSURLRequest *)request
+                              inSession:(nullable NSURLSession *)session
+                                options:(SDWebImageDownloaderOptions)options;
+
+- (nonnull instancetype)initWithRequest:(nullable NSURLRequest *)request
+                              inSession:(nullable NSURLSession *)session
+                                options:(SDWebImageDownloaderOptions)options
+                                context:(nullable SDWebImageContext *)context;
+
+- (nullable id)addHandlersForProgress:(nullable SDWebImageDownloaderProgressBlock)progressBlock
+                            completed:(nullable SDWebImageDownloaderCompletedBlock)completedBlock;
+
+- (nullable id)addHandlersForProgress:(nullable SDWebImageDownloaderProgressBlock)progressBlock
+                            completed:(nullable SDWebImageDownloaderCompletedBlock)completedBlock
+                        decodeOptions:(nullable SDImageCoderOptions *)decodeOptions;
+
+- (BOOL)cancel:(nullable id)token;
+
+@property (strong, nonatomic, readonly, nullable) NSURLRequest *request;
+@property (strong, nonatomic, readonly, nullable) NSURLResponse *response;
+
+@optional
+@property (strong, nonatomic, readonly, nullable) NSURLSessionTask *dataTask;
+@property (strong, nonatomic, readonly, nullable) NSURLSessionTaskMetrics *metrics API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0));
+
+// These operation-level config was inherited from downloader. See `SDWebImageDownloaderConfig` for documentation.
+@property (strong, nonatomic, nullable) NSURLCredential *credential;
+@property (assign, nonatomic) double minimumProgressInterval;
+@property (copy, nonatomic, nullable) NSIndexSet *acceptableStatusCodes;
+@property (copy, nonatomic, nullable) NSSet<NSString *> *acceptableContentTypes;
+
+@end
+
+
+/**
+ The download operation class for SDWebImageDownloader.
+ */
+@interface SDWebImageDownloaderOperation : NSOperation <SDWebImageDownloaderOperation>
+
+/**
+ * The request used by the operation's task.
+ */
+@property (strong, nonatomic, readonly, nullable) NSURLRequest *request;
+
+/**
+ * The response returned by the operation's task.
+ */
+@property (strong, nonatomic, readonly, nullable) NSURLResponse *response;
+
+/**
+ * The operation's task
+ */
+@property (strong, nonatomic, readonly, nullable) NSURLSessionTask *dataTask;
+
+/**
+ * The collected metrics from `-URLSession:task:didFinishCollectingMetrics:`.
+ * This can be used to collect the network metrics like download duration, DNS lookup duration, SSL handshake duration, etc. See Apple's documentation: https://developer.apple.com/documentation/foundation/urlsessiontaskmetrics
+ */
+@property (strong, nonatomic, readonly, nullable) NSURLSessionTaskMetrics *metrics API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0));
+
+/**
+ * The credential used for authentication challenges in `-URLSession:task:didReceiveChallenge:completionHandler:`.
+ *
+ * This will be overridden by any shared credentials that exist for the username or password of the request URL, if present.
+ */
+@property (strong, nonatomic, nullable) NSURLCredential *credential;
+
+/**
+ * The minimum interval about progress percent during network downloading. Which means the next progress callback and current progress callback's progress percent difference should be larger or equal to this value. However, the final finish download progress callback does not get effected.
+ * The value should be 0.0-1.0.
+ * @note If you're using progressive decoding feature, this will also effect the image refresh rate.
+ * @note This value may enhance the performance if you don't want progress callback too frequently.
+ * Defaults to 0, which means each time we receive the new data from URLSession, we callback the progressBlock immediately.
+ */
+@property (assign, nonatomic) double minimumProgressInterval;
+
+/**
+ * Set the acceptable HTTP Response status code. The status code which beyond the range will mark the download operation failed.
+ * For example, if we config [200, 400) but server response is 503, the download will fail with error code `SDWebImageErrorInvalidDownloadStatusCode`.
+ * Defaults to [200,400). Nil means no validation at all.
+ */
+@property (copy, nonatomic, nullable) NSIndexSet *acceptableStatusCodes;
+
+/**
+ * Set the acceptable HTTP Response content type. The content type beyond the set will mark the download operation failed.
+ * For example, if we config ["image/png"] but server response is "application/json", the download will fail with error code `SDWebImageErrorInvalidDownloadContentType`.
+ * Normally you don't need this for image format detection because we use image's data file signature magic bytes: https://en.wikipedia.org/wiki/List_of_file_signatures
+ * Defaults to nil. Nil means no validation at all.
+ */
+@property (copy, nonatomic, nullable) NSSet<NSString *> *acceptableContentTypes;
+
+/**
+ * The options for the receiver.
+ */
+@property (assign, nonatomic, readonly) SDWebImageDownloaderOptions options;
+
+/**
+ * The context for the receiver.
+ */
+@property (copy, nonatomic, readonly, nullable) SDWebImageContext *context;
+
+/**
+ *  Initializes a `SDWebImageDownloaderOperation` object
+ *
+ *  @see SDWebImageDownloaderOperation
+ *
+ *  @param request        the URL request
+ *  @param session        the URL session in which this operation will run
+ *  @param options        downloader options
+ *
+ *  @return the initialized instance
+ */
+- (nonnull instancetype)initWithRequest:(nullable NSURLRequest *)request
+                              inSession:(nullable NSURLSession *)session
+                                options:(SDWebImageDownloaderOptions)options;
+
+/**
+ *  Initializes a `SDWebImageDownloaderOperation` object
+ *
+ *  @see SDWebImageDownloaderOperation
+ *
+ *  @param request        the URL request
+ *  @param session        the URL session in which this operation will run
+ *  @param options        downloader options
+ *  @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.
+ *
+ *  @return the initialized instance
+ */
+- (nonnull instancetype)initWithRequest:(nullable NSURLRequest *)request
+                              inSession:(nullable NSURLSession *)session
+                                options:(SDWebImageDownloaderOptions)options
+                                context:(nullable SDWebImageContext *)context NS_DESIGNATED_INITIALIZER;
+
+/**
+ *  Adds handlers for progress and completion. Returns a token that can be passed to -cancel: to cancel this set of
+ *  callbacks.
+ *
+ *  @param progressBlock  the block executed when a new chunk of data arrives.
+ *                        @note the progress block is executed on a background queue
+ *  @param completedBlock the block executed when the download is done.
+ *                        @note the completed block is executed on the main queue for success. If errors are found, there is a chance the block will be executed on a background queue
+ *
+ *  @return the token to use to cancel this set of handlers
+ */
+- (nullable id)addHandlersForProgress:(nullable SDWebImageDownloaderProgressBlock)progressBlock
+                            completed:(nullable SDWebImageDownloaderCompletedBlock)completedBlock;
+
+/**
+ *  Adds handlers for progress and completion, and optional decode options (which need another image other than the initial one). Returns a token that can be passed to -cancel: to cancel this set of
+ *  callbacks.
+ *
+ *  @param progressBlock  the block executed when a new chunk of data arrives.
+ *                        @note the progress block is executed on a background queue
+ *  @param completedBlock the block executed when the download is done.
+ *                        @note the completed block is executed on the main queue for success. If errors are found, there is a chance the block will be executed on a background queue
+ *  @param decodeOptions The optional decode options, used when in thumbnail decoding for current completion block callback. For example, request <url1, {thumbnail: 100x100}> and then <url1, {thumbnail: 200x200}>, we may callback these two completion block with different size.
+ *  @return the token to use to cancel this set of handlers
+ */
+- (nullable id)addHandlersForProgress:(nullable SDWebImageDownloaderProgressBlock)progressBlock
+                            completed:(nullable SDWebImageDownloaderCompletedBlock)completedBlock
+                        decodeOptions:(nullable SDImageCoderOptions *)decodeOptions;
+
+/**
+ *  Cancels a set of callbacks. Once all callbacks are canceled, the operation is cancelled.
+ *
+ *  @param token the token representing a set of callbacks to cancel
+ *
+ *  @return YES if the operation was stopped because this was the last token to be canceled. NO otherwise.
+ */
+- (BOOL)cancel:(nullable id)token;
+
+@end