[docs] Move examples. Update readme, todo and changelog

Author: rumkin

changelog.md

@@ -12,6 +12,8 @@
     )
     ```
 - Make type rules switch each other.
+- Add `optional`, `is` and `custom` checks.
+- Add strict type implementation.
 
 ### v0.9
 

doc/readme.md

@@ -30,12 +30,12 @@ Include scripts with integrity control:
 ```html
 <script
   src="https://unpkg.com/typed-props@1.0.0/dist/typed-props.js"
-  integrity="sha384-GlIQIsykUnZCr2koAs9hrk+hOPZaf6/46IqLb1dkuEeE3Ztf7jzMTqVWce7JcHjC"
+  integrity="sha384-HJ1xePGzEGMbK5T23s6BURtTDxAQO1aCz8hy5nfKZdp2pbCRkfS2R6PnJ/x2FjK0"
   crossorigin="anonymous"
 ></script>
 <script
   src="https://unpkg.com/typed-props@1.0.0/dist/typed-props.min.js"
-  integrity="sha384-RxeNiFmGfqI7CsqvM0YvY81u6PyrMwBI4qlucXLV3yT4HdKDu3w6Wjh5P5bK4FdM"
+  integrity="sha384-FdEeyPF4FQcR+L8Fmt1AizWCb0wAdCUxpXoayeFsrTuCCvygKNTszGN8PLPzWGxu"
   crossorigin="anonymous"
 ></script>
 <script language="javascript">

example/api.js

@@ -2,21 +2,38 @@ import {StrictType as T} from 'typed-props'
 
 let userType
 let postType
+let commentType
 
 userType = T.exact({
+  $type: T.is('http://api.rumk.in/v1#user'),
   id: T.number,
   username: T.string,
   email: T.string,
   balance: T.number,
-  // Posts has author which type is User
-  posts: () => postType,
+  // Posts is an array. Each post has an author which type is User
+  posts: () => T.arrayOf(postType),
 })
 
 postType = T.exact({
+  $type: T.is('http://api.rumk.in/v1#post'),
+  id: T.number,
   title: T.string,
-  starts: T.number,
+  text: T.string,
+  stars: T.number,
   // Author has type User which has posts
   author: () => userType,
+  // Comments property is an array It has reference to the post type
+  comments: () => T.arrayOf(commentType),
+  publishedAt: T.instanceOf(Date),
+})
+
+commentType = T.exact({
+  $type: T.is('http://api/rumk.in/v1#comment'),
+  id: T.number,
+  text: T.string,
+  stars: T.number,
+  author: () => userType,
+  publishedAt: T.instanceOf(Date),
 })
 
 function typeIs(type) {
@@ -26,4 +43,5 @@ function typeIs(type) {
 export default T.select(
   [typeIs('http://api.rumk.in/v1#user'), userType],
   [typeIs('http://api.rumk.in/v1#post'), postType],
+  [typeIs('http://api.rumk.in/v1#comment'), commentType],
 )

example/uniq-items.js

@@ -5,7 +5,7 @@
 [![npm](https://img.shields.io/npm/v/typed-props.svg?style=flat-square)](https://npmjs.com/package/typed-props)
 [![Travis](https://img.shields.io/travis/rumkin/typed-props.svg?style=flat-square)](https://travis-ci.org/rumkin/typed-props)
 ![](https://img.shields.io/badge/coverage-100%25-green.svg?style=flat-square)
-![](https://img.shields.io/badge/size-12.6%20KiB-blue.svg?style=flat-square)
+![](https://img.shields.io/badge/size-12.60%20KiB-blue.svg?style=flat-square)
 ![](https://img.shields.io/badge/deps-0-blue.svg?style=flat-square)
 [![npm](https://img.shields.io/npm/dm/typed-props.svg?style=flat-square)](https://npmjs.com/packages/typed-props)
 
@@ -105,7 +105,7 @@ Example:
       // Reason helps to identify kind of problem within one validator.
       // Usual values are mismatch, no_matches, and redundant.
       reason: 'mismatch',
-      // The next values are validator dependant.
+      // The next values are validator dependent.
       type: 'string',
       expect: true,
       is: false,
@@ -117,7 +117,7 @@ Example:
 ## Examples
 
 * Create [UniqItems check](examples/uniq-items.js).
-* [Describe API](examples/api.js) with TypedProps (with circular references resolution).
+* [Describe API](examples/api.js) with TypedProps (with circular types resolution).
 
 ## Standard checks
 
@@ -185,7 +185,7 @@ Type.shape({
   // Make type optional
   optionalValue: Type.optional,
   // Determine type in runtime
-  propertyDependantType: Type.select(
+  propertyDependentType: Type.select(
     [
       ({type}) => type === 'ADD_TODO',
       Type.shape({/* ADD_TODO action payload shape */}),
@@ -206,7 +206,7 @@ Type.shape({
 
 TypedProps have it's own custom checks which make it more handful.
 
-### `Type.optional`
+### `Checkable.optional`
 
 This is pseudo check. This rule allows to make some property optional. It can
 switch off previously defined `.isRequired` check. It's better to use with `StrictType`.
@@ -215,9 +215,20 @@ switch off previously defined `.isRequired` check. It's better to use with `Stri
 StrictType.number.optional
 ```
 
-### `Type.select()`
+### `Checkable.is()`
 ```
-(...Function|TypedProps) -> TypedProps
+(value:*) -> Checkable
+```
+
+This check validates the checkable value to strict equal `value` argument.
+
+```javascript
+Type.is('user')
+```
+
+### `Checkable.select()`
+```
+(...Function|Checkable) -> Checkable
 ```
 
 This checker allow to dynamically switch between types depending on input value.
@@ -232,9 +243,9 @@ Type.select(
 )
 ```
 
-### `Type.custom()`
+### `Checkable.custom()`
 ```
-(check:(it:*) -> bool) -> TypedProps
+(check:(it:*) -> bool) -> Checkable
 ```
 
 Custom check accepts `check` argument and use it to validate the value.
@@ -267,7 +278,7 @@ class Arith {
 
 ## Checks and groups
 
-Currently there are several groups of checkers: existance, type and complex checks.
+Currently there are several groups of checkers: existence, type, exact, and complex checks.
 
 * Existance:
   * isRequired
@@ -279,9 +290,11 @@ Currently there are several groups of checkers: existance, type and complex chec
   * func
   * object
   * array
-  * any: removes type rule
-* Complex:
+  * any: removes any other type check
+* Exact:
+  * is
   * oneOf
+* Complex:
   * oneOfType
   * arrayOf: overwirites type check with `array`
   * objectOf: overwirites type check with `object`
@@ -290,7 +303,7 @@ Currently there are several groups of checkers: existance, type and complex chec
   * select
   * custom
 
-Type and existance checks are switchable and can replace each other. It's made
+Type and existence checks are switchable and can replace each other. It's made
 for flexibility.
 
 ```javascript
@@ -387,7 +400,11 @@ class IsArray extends SimpleRule {
 
 ## API
 
-### `TypedProps#getChecks()`
+### `Checkable()`
+
+Checkable is a prototype of TypeProps. It contains only check logic and has no own rules.
+
+### `Checkable#getChecks()`
 ```
 () -> Checks[]
 ```

examples/api.js

@@ -9,6 +9,8 @@
 
 ### v1.1
 
+ - [ ] Select should accept plain object as shapes.
+ - [ ] Add context to prevent circular structures failures.
  - [ ] Inspect details.reason wider implementation.
  - [ ] Add rule referrences to remove dependant rules on replace:
     ```javascript