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

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

@@ -0,0 +1,78 @@
+/*
+ * 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"
+#import "SDWebImageDefine.h"
+
+@class SDWebImageOptionsResult;
+
+typedef SDWebImageOptionsResult * _Nullable(^SDWebImageOptionsProcessorBlock)(NSURL * _Nullable url, SDWebImageOptions options, SDWebImageContext * _Nullable context);
+
+/**
+ The options result contains both options and context.
+ */
+@interface SDWebImageOptionsResult : NSObject
+
+/**
+ WebCache options.
+ */
+@property (nonatomic, assign, readonly) SDWebImageOptions options;
+
+/**
+ Context options.
+ */
+@property (nonatomic, copy, readonly, nullable) SDWebImageContext *context;
+
+/**
+ Create a new options result.
+
+ @param options options
+ @param context context
+ @return The options result contains both options and context.
+ */
+- (nonnull instancetype)initWithOptions:(SDWebImageOptions)options context:(nullable SDWebImageContext *)context;
+
+- (nonnull instancetype)init NS_UNAVAILABLE;
++ (nonnull instancetype)new  NS_UNAVAILABLE;
+
+@end
+
+/**
+ This is the protocol for options processor.
+ Options processor can be used, to control the final result for individual image request's `SDWebImageOptions` and `SDWebImageContext`
+ Implements the protocol to have a global control for each indivadual image request's option.
+ */
+@protocol SDWebImageOptionsProcessor <NSObject>
+
+/**
+ Return the processed options result for specify image URL, with its options and context
+
+ @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.
+ @return The processed result, contains both options and context
+ */
+- (nullable SDWebImageOptionsResult *)processedResultForURL:(nullable NSURL *)url
+                                                    options:(SDWebImageOptions)options
+                                                    context:(nullable SDWebImageContext *)context;
+
+@end
+
+/**
+ A options processor class with block.
+ */
+@interface SDWebImageOptionsProcessor : NSObject<SDWebImageOptionsProcessor>
+
+- (nonnull instancetype)initWithBlock:(nonnull SDWebImageOptionsProcessorBlock)block;
++ (nonnull instancetype)optionsProcessorWithBlock:(nonnull SDWebImageOptionsProcessorBlock)block;
+
+- (nonnull instancetype)init NS_UNAVAILABLE;
++ (nonnull instancetype)new  NS_UNAVAILABLE;
+
+@end

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

@@ -0,0 +1,168 @@
+/*
+ * 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 "SDWebImageManager.h"
+
+@class SDWebImagePrefetcher;
+
+/**
+ A token represents a list of URLs, can be used to cancel the download.
+ */
+@interface SDWebImagePrefetchToken : NSObject <SDWebImageOperation>
+
+/**
+ * Cancel the current prefetching.
+ */
+- (void)cancel;
+
+/**
+ list of URLs of current prefetching.
+ */
+@property (nonatomic, copy, readonly, nullable) NSArray<NSURL *> *urls;
+
+@end
+
+/**
+ The prefetcher delegate protocol
+ */
+@protocol SDWebImagePrefetcherDelegate <NSObject>
+
+@optional
+
+/**
+ * Called when an image was prefetched. Which means it's called when one URL from any of prefetching finished.
+ *
+ * @param imagePrefetcher The current image prefetcher
+ * @param imageURL        The image url that was prefetched
+ * @param finishedCount   The total number of images that were prefetched (successful or not)
+ * @param totalCount      The total number of images that were to be prefetched
+ */
+- (void)imagePrefetcher:(nonnull SDWebImagePrefetcher *)imagePrefetcher didPrefetchURL:(nullable NSURL *)imageURL finishedCount:(NSUInteger)finishedCount totalCount:(NSUInteger)totalCount;
+
+/**
+ * Called when all images are prefetched. Which means it's called when all URLs from all of prefetching finished.
+ * @param imagePrefetcher The current image prefetcher
+ * @param totalCount      The total number of images that were prefetched (whether successful or not)
+ * @param skippedCount    The total number of images that were skipped
+ */
+- (void)imagePrefetcher:(nonnull SDWebImagePrefetcher *)imagePrefetcher didFinishWithTotalCount:(NSUInteger)totalCount skippedCount:(NSUInteger)skippedCount;
+
+@end
+
+typedef void(^SDWebImagePrefetcherProgressBlock)(NSUInteger noOfFinishedUrls, NSUInteger noOfTotalUrls);
+typedef void(^SDWebImagePrefetcherCompletionBlock)(NSUInteger noOfFinishedUrls, NSUInteger noOfSkippedUrls);
+
+/**
+ * Prefetch some URLs in the cache for future use. Images are downloaded in low priority.
+ */
+@interface SDWebImagePrefetcher : NSObject
+
+/**
+ * The web image manager used by prefetcher to prefetch images.
+ * @note You can specify a standalone manager and downloader with custom configuration suitable for image prefetching. Such as `currentDownloadCount` or `downloadTimeout`.
+ */
+@property (strong, nonatomic, readonly, nonnull) SDWebImageManager *manager;
+
+/**
+ * Maximum number of URLs to prefetch at the same time. Defaults to 3.
+ */
+@property (nonatomic, assign) NSUInteger maxConcurrentPrefetchCount;
+
+/**
+ * The options for prefetcher. Defaults to SDWebImageLowPriority.
+ * @deprecated Prefetcher is designed to be used shared and should not effect others. So in 5.15.0 we added API  `prefetchURLs:options:context:`. If you want global control, try to use `SDWebImageOptionsProcessor` in manager level.
+ */
+@property (nonatomic, assign) SDWebImageOptions options API_DEPRECATED("Use individual prefetch options param instead", macos(10.10, API_TO_BE_DEPRECATED), ios(8.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED));
+
+/**
+ * The context for prefetcher. Defaults to nil.
+ * @deprecated Prefetcher is designed to be used shared and should not effect others. So in 5.15.0 we added API  `prefetchURLs:options:context:`. If you want global control, try to use `SDWebImageOptionsProcessor` in `SDWebImageManager.optionsProcessor`.
+ */
+@property (nonatomic, copy, nullable) SDWebImageContext *context API_DEPRECATED("Use individual prefetch context param instead", macos(10.10, API_TO_BE_DEPRECATED), ios(8.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED));
+
+/**
+ * Queue options for prefetcher when call the progressBlock, completionBlock and delegate methods. Defaults to Main Queue.
+ * @deprecated 5.15.0 introduce SDCallbackQueue, use that is preferred and has higher priority. The set/get to this property will translate to that instead.
+ * @note The call is asynchronously to avoid blocking target queue. (see SDCallbackPolicyDispatch)
+ * @note The delegate queue should be set before any prefetching start and may not be changed during prefetching to avoid thread-safe problem.
+ */
+@property (strong, nonatomic, nonnull) dispatch_queue_t delegateQueue API_DEPRECATED("Use SDWebImageContextCallbackQueue context param instead, see SDCallbackQueue", macos(10.10, 10.10), ios(8.0, 8.0), tvos(9.0, 9.0), watchos(2.0, 2.0));
+
+/**
+ * The delegate for the prefetcher. Defaults to nil.
+ */
+@property (weak, nonatomic, nullable) id <SDWebImagePrefetcherDelegate> delegate;
+
+/**
+ * Returns the global shared image prefetcher instance. It use a standalone manager which is different from shared manager.
+ */
+@property (nonatomic, class, readonly, nonnull) SDWebImagePrefetcher *sharedImagePrefetcher;
+
+/**
+ * Allows you to instantiate a prefetcher with any arbitrary image manager.
+ */
+- (nonnull instancetype)initWithImageManager:(nonnull SDWebImageManager *)manager NS_DESIGNATED_INITIALIZER;
+
+/**
+ * Assign list of URLs to let SDWebImagePrefetcher to queue the prefetching. It based on the image manager so the image may from the cache and network according to the `options` property.
+ * Prefetching is separate to each other, which means the progressBlock and completionBlock you provide is bind to the prefetching for the list of urls.
+ * Attention that call this will not cancel previous fetched urls. You should keep the token return by this to cancel or cancel all the prefetch.
+ *
+ * @param urls list of URLs to prefetch
+ * @return the token to cancel the current prefetching.
+ */
+- (nullable SDWebImagePrefetchToken *)prefetchURLs:(nullable NSArray<NSURL *> *)urls;
+
+/**
+ * Assign list of URLs to let SDWebImagePrefetcher to queue the prefetching. It based on the image manager so the image may from the cache and network according to the `options` property.
+ * Prefetching is separate to each other, which means the progressBlock and completionBlock you provide is bind to the prefetching for the list of urls.
+ * Attention that call this will not cancel previous fetched urls. You should keep the token return by this to cancel or cancel all the prefetch.
+ *
+ * @param urls            list of URLs to prefetch
+ * @param progressBlock   block to be called when progress updates; 
+ *                        first parameter is the number of completed (successful or not) requests, 
+ *                        second parameter is the total number of images originally requested to be prefetched
+ * @param completionBlock block to be called when the current prefetching is completed
+ *                        first param is the number of completed (successful or not) requests,
+ *                        second parameter is the number of skipped requests
+ * @return the token to cancel the current prefetching.
+ */
+- (nullable SDWebImagePrefetchToken *)prefetchURLs:(nullable NSArray<NSURL *> *)urls
+                                          progress:(nullable SDWebImagePrefetcherProgressBlock)progressBlock
+                                         completed:(nullable SDWebImagePrefetcherCompletionBlock)completionBlock;
+
+/**
+ * Assign list of URLs to let SDWebImagePrefetcher to queue the prefetching. It based on the image manager so the image may from the cache and network according to the `options` property.
+ * Prefetching is separate to each other, which means the progressBlock and completionBlock you provide is bind to the prefetching for the list of urls.
+ * Attention that call this will not cancel previous fetched urls. You should keep the token return by this to cancel or cancel all the prefetch.
+ *
+ * @param urls            list of URLs to prefetch
+ * @param options         The options to use when downloading the image. @see SDWebImageOptions for the possible values.
+ * @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   block to be called when progress updates;
+ *                        first parameter is the number of completed (successful or not) requests,
+ *                        second parameter is the total number of images originally requested to be prefetched
+ * @param completionBlock block to be called when the current prefetching is completed
+ *                        first param is the number of completed (successful or not) requests,
+ *                        second parameter is the number of skipped requests
+ * @return the token to cancel the current prefetching.
+ */
+- (nullable SDWebImagePrefetchToken *)prefetchURLs:(nullable NSArray<NSURL *> *)urls
+                                           options:(SDWebImageOptions)options
+                                           context:(nullable SDWebImageContext *)context
+                                          progress:(nullable SDWebImagePrefetcherProgressBlock)progressBlock
+                                         completed:(nullable SDWebImagePrefetcherCompletionBlock)completionBlock;
+
+/**
+ * Remove and cancel all the prefeching for the prefetcher.
+ */
+- (void)cancelPrefetching;
+
+
+@end

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

@@ -0,0 +1,131 @@
+/*
+ * 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
+#import "SDImageCache.h"
+
+#if SD_UIKIT
+typedef UIViewAnimationOptions SDWebImageAnimationOptions;
+#else
+typedef NS_OPTIONS(NSUInteger, SDWebImageAnimationOptions) {
+    SDWebImageAnimationOptionAllowsImplicitAnimation   = 1 << 0, // specify `allowsImplicitAnimation` for the `NSAnimationContext`
+    
+    SDWebImageAnimationOptionCurveEaseInOut            = 0 << 16, // default
+    SDWebImageAnimationOptionCurveEaseIn               = 1 << 16,
+    SDWebImageAnimationOptionCurveEaseOut              = 2 << 16,
+    SDWebImageAnimationOptionCurveLinear               = 3 << 16,
+    
+    SDWebImageAnimationOptionTransitionNone            = 0 << 20, // default
+    SDWebImageAnimationOptionTransitionFlipFromLeft    = 1 << 20,
+    SDWebImageAnimationOptionTransitionFlipFromRight   = 2 << 20,
+    SDWebImageAnimationOptionTransitionCurlUp          = 3 << 20,
+    SDWebImageAnimationOptionTransitionCurlDown        = 4 << 20,
+    SDWebImageAnimationOptionTransitionCrossDissolve   = 5 << 20,
+    SDWebImageAnimationOptionTransitionFlipFromTop     = 6 << 20,
+    SDWebImageAnimationOptionTransitionFlipFromBottom  = 7 << 20,
+};
+#endif
+
+typedef void (^SDWebImageTransitionPreparesBlock)(__kindof UIView * _Nonnull view, UIImage * _Nullable image, NSData * _Nullable imageData, SDImageCacheType cacheType, NSURL * _Nullable imageURL);
+typedef void (^SDWebImageTransitionAnimationsBlock)(__kindof UIView * _Nonnull view, UIImage * _Nullable image);
+typedef void (^SDWebImageTransitionCompletionBlock)(BOOL finished);
+
+/**
+ This class is used to provide a transition animation after the view category load image finished. Use this on `sd_imageTransition` in UIView+WebCache.h
+ for UIKit(iOS & tvOS), we use `+[UIView transitionWithView:duration:options:animations:completion]` for transition animation.
+ for AppKit(macOS), we use `+[NSAnimationContext runAnimationGroup:completionHandler:]` for transition animation. You can call `+[NSAnimationContext currentContext]` to grab the context during animations block.
+ @note These transition are provided for basic usage. If you need complicated animation, consider to directly use Core Animation or use `SDWebImageAvoidAutoSetImage` and implement your own after image load finished.
+ */
+@interface SDWebImageTransition : NSObject
+
+/**
+ By default, we set the image to the view at the beginning of the animations. You can disable this and provide custom set image process
+ */
+@property (nonatomic, assign) BOOL avoidAutoSetImage;
+/**
+ The duration of the transition animation, measured in seconds. Defaults to 0.5.
+ */
+@property (nonatomic, assign) NSTimeInterval duration;
+/**
+ The timing function used for all animations within this transition animation (macOS).
+ */
+@property (nonatomic, strong, nullable) CAMediaTimingFunction *timingFunction API_UNAVAILABLE(ios, tvos, watchos) API_DEPRECATED("Use SDWebImageAnimationOptions instead, or grab NSAnimationContext.currentContext and modify the timingFunction", macos(10.10, 10.10));
+/**
+ A mask of options indicating how you want to perform the animations.
+ */
+@property (nonatomic, assign) SDWebImageAnimationOptions animationOptions;
+/**
+ A block object to be executed before the animation sequence starts.
+ */
+@property (nonatomic, copy, nullable) SDWebImageTransitionPreparesBlock prepares;
+/**
+ A block object that contains the changes you want to make to the specified view.
+ */
+@property (nonatomic, copy, nullable) SDWebImageTransitionAnimationsBlock animations;
+/**
+ A block object to be executed when the animation sequence ends.
+ */
+@property (nonatomic, copy, nullable) SDWebImageTransitionCompletionBlock completion;
+
+@end
+
+/**
+ Convenience way to create transition. Remember to specify the duration if needed.
+ for UIKit, these transition just use the correspond `animationOptions`. By default we enable `UIViewAnimationOptionAllowUserInteraction` to allow user interaction during transition.
+ for AppKit, these transition use Core Animation in `animations`. So your view must be layer-backed. Set `wantsLayer = YES` before you apply it.
+ */
+@interface SDWebImageTransition (Conveniences)
+
+/// Fade-in transition.
+@property (nonatomic, class, nonnull, readonly) SDWebImageTransition *fadeTransition;
+/// Flip from left transition.
+@property (nonatomic, class, nonnull, readonly) SDWebImageTransition *flipFromLeftTransition;
+/// Flip from right transition.
+@property (nonatomic, class, nonnull, readonly) SDWebImageTransition *flipFromRightTransition;
+/// Flip from top transition.
+@property (nonatomic, class, nonnull, readonly) SDWebImageTransition *flipFromTopTransition;
+/// Flip from bottom transition.
+@property (nonatomic, class, nonnull, readonly) SDWebImageTransition *flipFromBottomTransition;
+/// Curl up transition.
+@property (nonatomic, class, nonnull, readonly) SDWebImageTransition *curlUpTransition;
+/// Curl down transition.
+@property (nonatomic, class, nonnull, readonly) SDWebImageTransition *curlDownTransition;
+
+/// Fade-in transition with duration.
+/// @param duration transition duration, use ease-in-out
++ (nonnull instancetype)fadeTransitionWithDuration:(NSTimeInterval)duration NS_SWIFT_NAME(fade(duration:));
+
+/// Flip from left  transition with duration.
+/// @param duration transition duration, use ease-in-out
++ (nonnull instancetype)flipFromLeftTransitionWithDuration:(NSTimeInterval)duration NS_SWIFT_NAME(flipFromLeft(duration:));
+
+/// Flip from right transition with duration.
+/// @param duration transition duration, use ease-in-out
++ (nonnull instancetype)flipFromRightTransitionWithDuration:(NSTimeInterval)duration NS_SWIFT_NAME(flipFromRight(duration:));
+
+/// Flip from top transition with duration.
+/// @param duration transition duration, use ease-in-out
++ (nonnull instancetype)flipFromTopTransitionWithDuration:(NSTimeInterval)duration NS_SWIFT_NAME(flipFromTop(duration:));
+
+/// Flip from bottom transition with duration.
+/// @param duration transition duration, use ease-in-out
++ (nonnull instancetype)flipFromBottomTransitionWithDuration:(NSTimeInterval)duration NS_SWIFT_NAME(flipFromBottom(duration:));
+
+///  Curl up transition with duration.
+/// @param duration transition duration, use ease-in-out
++ (nonnull instancetype)curlUpTransitionWithDuration:(NSTimeInterval)duration NS_SWIFT_NAME(curlUp(duration:));
+
+/// Curl down transition with duration.
+/// @param duration transition duration, use ease-in-out
++ (nonnull instancetype)curlDownTransitionWithDuration:(NSTimeInterval)duration NS_SWIFT_NAME(curlDown(duration:));
+
+@end
+
+#endif