Merge pull request #186 from react-native-community/improve-ts

* Improve types for Factory, Async storage and Storage backends
* Docs: Core
* Docs: Legacy
* Docs: Writing own storage backend
* Make sure the packages can be published correctly

Author: Krzysztof Borowy

.npmignore

@@ -1,6 +1,6 @@
 # Async Storage
 
-A storage system for React Native.
+A persistent data storage solution for your next mobile, web or desktop application. 
 
 ## Work in progress
 
@@ -10,8 +10,22 @@ If you're looking for published and operational Async Storage version, please ch
 
 If you'd like to see the progress of v2, [please visit Project page.](https://github.com/react-native-community/async-storage/projects/1) 
 
-## Running Examples
+## Features
+
+todo
+
+## Documentation
+
+- [Creating a custom Storage backend](./packages/core/docs/Writing_Storage_Backend.md)
+
+## Available storage backends
+
+- [Legacy](./packages/storage-legacy/README.md)
+
+
+## License
+
+MIT
 
-### React Native
 
 

README.md

@@ -5,7 +5,7 @@
       {
         "alias": {
           "@react-native-community/async-storage": "../../packages/core/build",
-          "@react-native-community/async-storage-legacy": "../../packages/storage-legacy/build"
+          "@react-native-community/async-storage-backend-legacy": "../../packages/storage-legacy/build"
         },
         "cwd": "babelrc"
       }

examples/mobile/.babelrc

@@ -28,3 +28,7 @@ $ yarn start
 
 Let me know about any issue found or feedback you have at [Async-Storage issue page](https://github.com/react-native-community/async-storage/issues). 
 Please mark it as `examples` label. 
+
+## License
+
+MIT

examples/mobile/README.md

@@ -1,4 +1,4 @@
-import LegacyStorage from '@react-native-community/async-storage-legacy';
+import LegacyStorage from '@react-native-community/async-storage-backend-legacy';
 import AsyncStorageFactory from '@react-native-community/async-storage';
 
 

examples/mobile/src/legacy/storage.js

@@ -1,7 +1,7 @@
 {
   "packages": [
     "core",
-    "storages/*"
+    "storages-*"
   ],
   "version": "independent",
   "npmClient": "yarn",

lerna.json

@@ -0,0 +1,30 @@
+# Core
+node_modules
+yarn.lock
+src/
+__tests__/
+CONTRIBUTING.md
+CODE_OF_CONDUCT.md
+
+
+########## Trash ##########
+.DS_Store
+.DS_Store?
+*.DS_Store
+coverage.android.json
+coverage.ios.json
+coverage
+npm-debug.log
+.github
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.dbandroid/gradle
+.idea
+bin/test.js
+codorials
+.vscode
+.nyc_output
+yarn-error.log
+

packages/core/.npmignore

@@ -0,0 +1,119 @@
+# Async Storage Core
+
+Main, public-facing components of Async Storage. The core module contains a factory to create an `AsyncStorage` instance 
+and `IStorageBackend`, that needs to be implemented by any Backend Storage in order to be compatible.   
+
+## Install
+
+```bash
+$ yarn install @react-native-community/async-storage
+```
+
+## API
+
+
+### `AsyncStorageFactory`
+
+A factory module for `AsyncStorage` instance with selected storage backend attached. 
+
+
+```typescript
+// storage.js
+
+import ASFactory from '@react-native-community/async-storage'
+
+// use any available Storage Backend
+const storageBackend = new StorageBackend();
+
+const mobileStorage = ASFactory.create(storageBackend, options);
+
+export default mobileStorage;
+```
+
+
+**Factory options**
+
+`AsyncStorageFactory.create` accepts an options object, that enables additional features.
+
+
+- *logger*
+
+```typescript
+type logger = ((action: LoggerAction) => void) | boolean;
+``` 
+
+Used to log `AsyncStorage` method calls and used arguments.
+You can provide your own implementation or use provided default logger (enabled by default in DEV mode).
+
+
+- *errorHandler*
+
+```typescript
+type errorHandler = ((error: Error | string) => void) | boolean;
+````
+
+Used to report any errors thrown.
+You can provide your own implementation or use provided default error handler (enabled by default in DEV mode).
+
+
+**Providing a storage model**
+
+If you know the structure of the stored data upfront, you can use the full potential of the type system, by providing a type argument to  `AsyncStorageFactory.create<T>` method.
+
+
+```typescript
+import ASFactory from '@react-native-community/async-storage'
+
+type StorageModel = {
+  user: {
+    name: string;
+    age: number;
+  };
+  preferences: {
+    darkModeEnabled: boolean;
+  };
+  subscribedChannels: Array<string>;
+  onboardingCompleted: boolean;
+};
+
+// use any available Storage Backend
+const storageBackend = new StorageBackend();
+
+
+const storage = ASFactory.create<StorageModel>(storageBackend);
+
+```
+
+
+### `IStorageBackend`
+
+In order to let `AsyncStorage` use a storage backend, it has to implement this interface. 
+Contains basic set method of methods to get, set and remove data, return already used keys or drop the whole storage.
+
+
+```typescript
+
+import {
+  IStorageBackend,
+} from '@react-native-community/async-storage';
+
+type Model = {
+  count: number
+  user: {
+    name: string,
+    rating: number
+  }
+}
+
+class MyStorageSolution implements IStorageBackend<Model> {
+  // implement necessary methods
+}
+
+```
+
+
+  
+## License
+
+MIT
+

packages/core/README.md

@@ -20,13 +20,13 @@ describe('AsyncStorage', () => {
   });
 
   type testCases = [
-    Partial<keyof AsyncStorage<any>>,
+    Partial<keyof AsyncStorage<any, any>>,
     Partial<keyof StorageMock>,
     string
   ][];
 
   describe('main API', () => {
-    const asyncStorage = new AsyncStorage<any>(mockedStorage, {
+    const asyncStorage = new AsyncStorage<any, any>(mockedStorage, {
       logger: false,
       errorHandler: false,
     });
@@ -63,7 +63,7 @@ describe('AsyncStorage', () => {
     it('uses logger when provided', async () => {
       const loggerFunc = jest.fn();
 
-      const as = new AsyncStorage(mockedStorage, {
+      const as = new AsyncStorage<any, any>(mockedStorage, {
         logger: loggerFunc,
         errorHandler: false,
       });
@@ -81,7 +81,7 @@ describe('AsyncStorage', () => {
         throw error;
       });
 
-      const as = new AsyncStorage(mockedStorage, {
+      const as = new AsyncStorage<any, any>(mockedStorage, {
         errorHandler,
         logger: false,
       });