@oguzhnatly/react-native-image-manipulator 1.0.0 → 1.0.3

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+## 1.0.3
+
+- Errors fixed.
+
+## 1.0.2
+
+- Typescript module declarations improved.
+
+## 1.0.1
+
+- Typescript module declaration added.
+
+## 1.0.0
+
+- Initial release of the @oguzhnatly/react-native-image-manipulator package.

package/README.md

@@ -1,4 +1,44 @@
-### `ImageManipulator.manipulate(uri, actions, saveOptions)`
+## Getting started
+
+`$ npm install @oguzhnatly/react-native-image-manipulator --save`
+### OR
+`$ yarn add @oguzhnatly/react-native-image-manipulator`
+
+### Pod installation
+
+`$ cd ios && pod install`
+
+### Mostly automatic installation
+
+`$ react-native link @oguzhnatly/react-native-image-manipulator`
+
+### Manual installation
+
+#### iOS
+
+1.  In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
+2.  Go to `node_modules` ➜ `@oguzhnatly` ➜ `react-native-image-manipulator` and add `RNImageManipulator.xcodeproj`
+3.  In XCode, in the project navigator, select your project. Add `libRNImageManipulator.a` to your project's `Build Phases` ➜ `Link Binary With Libraries`
+4.  Run your project (`Cmd+R`)<
+
+#### Android
+
+1.  Open up `android/app/src/main/java/[...]/MainActivity.java`
+
+- Add `import com.reactnativeimagemanipulator.RNImageManipulatorPackage;` to the imports at the top of the file
+- Add `new RNImageManipulatorPackage()` to the list returned by the `getPackages()` method
+
+2.  Append the following lines to `android/settings.gradle`:
+    ```
+    include ':react-native-image-manipulator'
+    project(':react-native-image-manipulator').projectDir = new File(rootProject.projectDir, 	'../node_modules/@oguzhnatly/react-native-image-manipulator/android')
+    ```
+3.  Insert the following lines inside the dependencies block in `android/app/build.gradle`:
+    ```
+      compile project(':react-native-image-manipulator')
+    ```
+
+### `RNImageManipulator.manipulate(uri, actions, saveOptions)`
 
 Manipulate the image provided via `uri`. Available modifications are rotating, flipping (mirroring), resizing and cropping. Each invocation results in a new file. With one invocation you can provide a set of actions to perform over the image. Overwriting the source file would not have an effect in displaying the result as images are cached.
 
@@ -30,7 +70,7 @@ This will first rotate the image 90 degrees clockwise, then flip the rotated ima
 ```javascript
 import React from "react";
 import { Button, TouchableOpacity, Text, View, Image } from "react-native";
-import ImageManipulator from "react-native-image-manipulator";
+import RNImageManipulator from "@oguzhnatly/react-native-image-manipulator";
 
 import Colors from "../constants/Colors";
 
@@ -63,7 +103,7 @@ export default class ImageManipulatorSample extends React.Component {
   }
 
   _rotate90andFlip = async () => {
-    const manipResult = await ImageManipulator.manipulate(
+    const manipResult = await RNImageManipulator.manipulate(
       this.state.image.localUri || this.state.image.uri,
       [{ rotate: 90 }, { flip: { vertical: true } }],
       { format: "png" }
@@ -88,40 +128,4 @@ export default class ImageManipulatorSample extends React.Component {
     );
   };
 }
-```
-
-## Getting started
-
-`$ npm install @oguzhnatly/react-native-image-manipulator --save`
-### OR
-`$ yarn add @oguzhnatly/react-native-image-manipulator`
-
-### Mostly automatic installation
-
-`$ react-native link react-native-image-manipulator`
-
-### Manual installation
-
-#### iOS
-
-1.  In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
-2.  Go to `node_modules` ➜ `react-native-image-manipulator` and add `RNImageManipulator.xcodeproj`
-3.  In XCode, in the project navigator, select your project. Add `libRNImageManipulator.a` to your project's `Build Phases` ➜ `Link Binary With Libraries`
-4.  Run your project (`Cmd+R`)<
-
-#### Android
-
-1.  Open up `android/app/src/main/java/[...]/MainActivity.java`
-
-- Add `import com.reactnativeimagemanipulator.RNImageManipulatorPackage;` to the imports at the top of the file
-- Add `new RNImageManipulatorPackage()` to the list returned by the `getPackages()` method
-
-2.  Append the following lines to `android/settings.gradle`:
-    ```
-    include ':react-native-image-manipulator'
-    project(':react-native-image-manipulator').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-image-manipulator/android')
-    ```
-3.  Insert the following lines inside the dependencies block in `android/app/build.gradle`:
-    ```
-      compile project(':react-native-image-manipulator')
-    ```
+```

package/index.d.ts

@@ -0,0 +1,35 @@
+declare module '@oguzhnatly/react-native-image-manipulator' {
+    import React from 'react';
+    import RNImageManipulator from './index';
+  
+    export type ImageResult = {
+      uri: string;
+      width: number;
+      height: number;
+      base64?: string;
+    };
+  
+    export function manipulate(
+      uri: string,
+      actions: Array<{
+        resize?: {width?: number; height?: number};
+        rotate?: number;
+        flip?: {vertical?: boolean; horizontal?: boolean};
+        crop?: {
+          originX?: number;
+          originY?: number;
+          width?: number;
+          height?: number;
+        };
+      }>,
+      saveOptions: {
+        compress?: number;
+        format?: 'jpeg' | 'png';
+        base64?: boolean;
+      },
+      callback: (uri: string) => void,
+    ): Promise<ImageResult>;
+  
+    export default RNImageManipulator;
+  }
+  

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@oguzhnatly/react-native-image-manipulator",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "ImageManipulator for react native without Expo and Unimodules. Based on Expo ImageManipulator",
   "main": "index.js",
   "author": "oguzhnatly",
   "homepage": "https://github.com/oguzhnatly/react-native-image-manipulator",
-  "license": "MIT"
+  "license": "MIT",
+  "typings": "index.d.ts"
 }

package/react-native-image-manipulator.podspec

@@ -3,7 +3,7 @@ require 'json'
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 
 Pod::Spec.new do |s|
-  s.name         = package['name']
+  s.name         = "react-native-image-manipulator"
   s.version      = package['version']
   s.summary      = package['description']
   s.license      = package['license']