Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modify methods and API cleanup #175

Merged
merged 18 commits into from Jan 29, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .flowconfig
Expand Up @@ -12,3 +12,4 @@ module.system.node.resolve_dirname=src
<PROJECT_ROOT>/.*/gatsby-node.js
<PROJECT_ROOT>/packages/dataparcels-docs/.*
<PROJECT_ROOT>/node_modules/react-flip-move/src/.*
<PROJECT_ROOT>/node_modules/immutable/.*
6 changes: 5 additions & 1 deletion .size-limit
Expand Up @@ -4,7 +4,11 @@
path: "packages/dataparcels/lib/index.js"
},
{
limit: "30 KB",
limit: "25 KB",
path: "packages/dataparcels/ParcelShape.js"
},
{
limit: "25 KB",
path: "packages/react-dataparcels/lib/index.js"
}
]
3 changes: 3 additions & 0 deletions flow-typed/brokenModules.js
@@ -0,0 +1,3 @@
declare module "immutable" {
declare module.exports: any
}
4 changes: 2 additions & 2 deletions package.json
Expand Up @@ -9,8 +9,8 @@
"flow": "blueflag-test flow",
"flow-coverage": "blueflag-test flow-coverage -M",
"lint": "blueflag-test lint --monorepo",
"test": "yarn jest --maxWorkers=4",
"test-all": "yarn lint && yarn flow && yarn test --maxWorkers=4 && yarn flow-coverage && yarn size-limit",
"test": "yarn build && yarn jest --maxWorkers=1",
"test-all": "yarn build && yarn test --maxWorkers=1 && yarn flow && yarn lint && yarn flow-coverage && yarn size-limit",
"deploy-docs": "yarn lerna --scope dataparcels-docs run deploy",
"view-coverage": "open ./coverage/lcov-report/index.html",
"watch": "lerna run watch --parallel --"
Expand Down
4 changes: 2 additions & 2 deletions packages/dataparcels-docs/src/docs/api/action/Action.md
Expand Up @@ -3,8 +3,8 @@ import Link from 'component/Link';
# Action

```js
import {Action} from 'dataparcels';
import {Action} from 'react-dataparcels';
import Action from 'dataparcels/Action';
import Action from 'react-dataparcels/Action';
```

```flow
Expand Down
Expand Up @@ -3,8 +3,8 @@ import Link from 'component/Link';
# ChangeRequest

```js
import {ChangeRequest} from 'dataparcels';
import {ChangeRequest} from 'react-dataparcels';
import ChangeRequest from 'dataparcels/ChangeRequest';
import ChangeRequest from 'react-dataparcels/ChangeRequest';
```

```flow
Expand Down
Expand Up @@ -18,7 +18,7 @@ Each ParcelBoundary is passed a Parcel. By default the ParcelBoundary uses pure
ParcelBoundaries have an internal action buffer that can hold onto changes as they exit the boundary. These are normally released immediately, but also allow for debouncing changes, or putting a hold on all changes so they can be released later.

```js
import {ParcelBoundary} from 'react-dataparcels';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';
```

```js
Expand Down
Expand Up @@ -20,7 +20,7 @@ ParcelBoundaryHocs have an internal action buffer that can hold onto changes as
Unlike <Link to="/api/ParcelBoundary">ParcelBoundary</Link>, it cannot use pure rendering.

```js
import {ParcelBoundaryHoc} from 'react-dataparcels';
import ParcelBoundaryHoc from 'react-dataparcels/ParcelBoundaryHoc';
```

```js
Expand Down
Expand Up @@ -15,7 +15,7 @@ ParcelHoc is a React higher order component. It's job is to provide a parcel as
It is recommended that you <Link to="/examples/editing-objects">use ParcelHoc</Link>, rather than <Link to="/examples/managing-your-own-parcel-state">managing your own Parcel state</Link>.

```js
import {ParcelHoc} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
```

```flow
Expand Down
Expand Up @@ -14,8 +14,8 @@ These exist to be used with <Link to="/shape-updaters">shape updaters</Link>, to
ParcelShape's methods are a subset of <Link to="/api/Parcel">Parcel</Link>'s methods.

```js
import {ParcelShape} from 'dataparcels';
import {ParcelShape} from 'react-dataparcels';
import ParcelShape from 'dataparcels/ParcelShape';
import ParcelShape from 'react-dataparcels/ParcelShape';
```

```flow
Expand All @@ -34,4 +34,4 @@ let parcelShape = new ParcelShape(123);

ParcelShapes are used in a very similar way to [Immutable.js Maps and Lists](https://facebook.github.io/immutable-js/docs/), by calling methods that return new and updated ParcelShapes.

TODO
TODOTODO
3 changes: 2 additions & 1 deletion packages/dataparcels-docs/src/examples/EditingArrays.jsx
@@ -1,5 +1,6 @@
import React from 'react';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';
import ExampleHoc from 'component/ExampleHoc';

const FruitListParcelHoc = ParcelHoc({
Expand Down
@@ -1,6 +1,7 @@
import React from 'react';
import FlipMove from 'react-flip-move';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';
import ExampleHoc from 'component/ExampleHoc';

const FruitListParcelHoc = ParcelHoc({
Expand Down
@@ -1,5 +1,6 @@
import React from 'react';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';
import {SortableContainer, SortableElement} from 'react-sortable-hoc';
import ExampleHoc from 'component/ExampleHoc';

Expand Down
3 changes: 2 additions & 1 deletion packages/dataparcels-docs/src/examples/EditingObjects.jsx
@@ -1,5 +1,6 @@
import React from 'react';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';
import ExampleHoc from 'component/ExampleHoc';

const PersonParcelHoc = ParcelHoc({
Expand Down
@@ -1,5 +1,5 @@
import React from 'react';
import {ParcelHoc} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ExampleHoc from 'component/ExampleHoc';

const PersonParcelHoc = ParcelHoc({
Expand Down
@@ -1,5 +1,6 @@
import React from 'react';
import Parcel, {ParcelBoundary} from 'react-dataparcels';
import Parcel from 'react-dataparcels';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';

export default class ManagingOwnParcelState extends React.Component {
constructor(props) {
Expand Down
@@ -1,5 +1,6 @@
import React from 'react';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';
import ExampleHoc from 'component/ExampleHoc';

const FoodParcelHoc = ParcelHoc({
Expand Down
@@ -1,5 +1,6 @@
import React from 'react';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';
import ExampleHoc from 'component/ExampleHoc';

const ColourParcelHoc = ParcelHoc({
Expand Down
@@ -1,5 +1,6 @@
import React from 'react';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';
import ExampleHoc from 'component/ExampleHoc';

const NameParcelHoc = ParcelHoc({
Expand Down
@@ -1,5 +1,6 @@
import React from 'react';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';
import ExampleHoc from 'component/ExampleHoc';

const PersonParcelHoc = ParcelHoc({
Expand Down
@@ -1,5 +1,5 @@
import React from 'react';
import {ParcelHoc} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ExampleHoc from 'component/ExampleHoc';

const WordParcelHoc = ParcelHoc({
Expand Down
@@ -1,5 +1,5 @@
import React from 'react';
import {ParcelHoc} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ExampleHoc from 'component/ExampleHoc';

const DelayParcelHoc = ParcelHoc({
Expand Down
@@ -1,5 +1,5 @@
import React from 'react';
import {ParcelHoc} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ExampleHoc from 'component/ExampleHoc';

const WordParcelHoc = ParcelHoc({
Expand Down
@@ -1,5 +1,5 @@
import React from 'react';
import {ParcelHoc} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ExampleHoc from 'component/ExampleHoc';

const WordParcelHoc = ParcelHoc({
Expand Down
@@ -1,5 +1,5 @@
import React from 'react';
import {ParcelHoc} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ExampleHoc from 'component/ExampleHoc';
import {Box} from 'dcme-style';

Expand Down
@@ -1,6 +1,6 @@
import React from 'react';
import {ParcelHoc} from 'react-dataparcels';
import {ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';
import ExampleHoc from 'component/ExampleHoc';
import IsRenderingStaticHtml from 'utils/IsRenderingStaticHtml';
import ReactRouterQueryStringHoc from 'react-cool-storage/lib/ReactRouterQueryStringHoc';
Expand Down
Expand Up @@ -9,7 +9,8 @@ Dataparcels has a powerful set of methods for manipulating indexed data types, s

```js
import React from 'react';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';
import ExampleHoc from 'component/ExampleHoc';

const FruitListParcelHoc = ParcelHoc({
Expand Down Expand Up @@ -59,7 +60,8 @@ Dataparcels' plays nicely with [react-sortable-hoc](https://github.com/clauderic

```js
import React from 'react';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';
import {SortableContainer, SortableElement} from 'react-sortable-hoc';

const FruitListParcelHoc = ParcelHoc({
Expand Down Expand Up @@ -116,7 +118,8 @@ Dataparcels' also plays nicely with [react-flip-move](https://github.com/joshwco
```js
import React from 'react';
import FlipMove from 'react-flip-move';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';
import ExampleHoc from 'component/ExampleHoc';

const FruitListEditor = (props) => {
Expand Down
Expand Up @@ -18,7 +18,8 @@ This example demonstrates a pretty typical React setup to do that.

```js
import React from 'react';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';

const PersonParcelHoc = ParcelHoc({
name: "personParcel",
Expand Down
Expand Up @@ -7,7 +7,8 @@ If you don't want to use the <Link to="/api/ParcelHoc">ParcelHoc higher order co

```js
import React from 'react';
import Parcel, {ParcelBoundary} from 'react-dataparcels';
import Parcel from 'react-dataparcels';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';

export default class ManagingOwnParcelState extends React.Component {
constructor(props) {
Expand Down
Expand Up @@ -9,7 +9,8 @@ This example demonstrates ParcelBoundary's `debounce` feature. The first field i

```js
import React from 'react';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';

const FoodParcelHoc = ParcelHoc({
name: "foodParcel",
Expand Down
Expand Up @@ -11,7 +11,8 @@ The `forceUpdate` option is used to force the ParcelBoundary to update when `opt

```js
import React from 'react';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';

const ColourParcelHoc = ParcelHoc({
name: "colourParcel",
Expand Down
Expand Up @@ -9,7 +9,8 @@ This example demonstrates ParcelBoundary's `hold` feature.

```js
import React from 'react';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';

const NameParcelHoc = ParcelHoc({
name: "nameParcel",
Expand Down
Expand Up @@ -11,7 +11,8 @@ Note how the `height` field has a prop of `pure={false}`, and therefore updates

```js
import React from 'react';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';

const PersonParcelHoc = ParcelHoc({
name: "personParcel",
Expand Down
Expand Up @@ -9,7 +9,7 @@ This example shows how to delay the creation of a Parcel with `ParcelHoc`. The e

```js
import React from 'react';
import {ParcelHoc} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';

const DelayParcelHoc = ParcelHoc({
name: "delayParcel",
Expand Down
Expand Up @@ -9,7 +9,7 @@ This example demonstrates a simple usage of `ParcelHoc`.

```js
import React from 'react';
import {ParcelHoc} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';

const WordParcelHoc = ParcelHoc({
name: "wordParcel",
Expand Down
Expand Up @@ -11,7 +11,7 @@ This example demonstrates a `ParcelHoc` with an initial value that originates fr

```js
import React from 'react';
import {ParcelHoc} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';

const WordParcelHoc = ParcelHoc({
name: "wordParcel",
Expand Down
Expand Up @@ -28,7 +28,7 @@ When you type in the second input, the ParcelHoc changes and notifies the higher

```js
import React from 'react';
import {ParcelHoc} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';

const NameParcelHoc = ParcelHoc({
name: "nameParcel",
Expand Down Expand Up @@ -86,8 +86,8 @@ The same method can be used to allow a ParcelHoc to be controlled by another oth

```js
import React from 'react';
import {ParcelHoc} from 'react-dataparcels';
import {ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';
import ReactRouterQueryStringHoc from 'react-cool-storage/lib/ReactRouterQueryStringHoc';

import composeWith from 'unmutable/lib/util/composeWith';
Expand Down
Expand Up @@ -9,7 +9,7 @@ This example demonstrates a `ParcelHoc` with an initial value that originates fr

```js
import React from 'react';
import {ParcelHoc} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';

const WordParcelHoc = ParcelHoc({
name: "wordParcel",
Expand Down
5 changes: 3 additions & 2 deletions packages/dataparcels-docs/src/pages/getting-started.md
Expand Up @@ -43,7 +43,7 @@ We could do something like this.

```js
import React from 'react';
import {ParcelHoc} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';

// PLEASE DON'T USE THIS CODE
// THIS CODE IS FOR DEMONSTRAION PURPOSES ONLY
Expand Down Expand Up @@ -99,7 +99,8 @@ This is the same example with a few improvements added: better rendering perform

```js
import React from 'react';
import {ParcelHoc, ParcelBoundary} from 'react-dataparcels';
import ParcelHoc from 'react-dataparcels/ParcelHoc';
import ParcelBoundary from 'react-dataparcels/ParcelBoundary';

const PersonParcelHoc = ParcelHoc({
name: "personParcel",
Expand Down
2 changes: 2 additions & 0 deletions packages/dataparcels/Action.js
@@ -0,0 +1,2 @@
/* eslint-disable */
module.exports = require('./lib/change/Action.js').default;
2 changes: 2 additions & 0 deletions packages/dataparcels/ChangeRequest.js
@@ -0,0 +1,2 @@
/* eslint-disable */
module.exports = require('./lib/change/ChangeRequest.js').default;
2 changes: 2 additions & 0 deletions packages/dataparcels/DeletedParcelMarker.js
@@ -0,0 +1,2 @@
/* eslint-disable */
module.exports = require('./lib/parcelData/DeletedParcelMarker.js').default;
2 changes: 2 additions & 0 deletions packages/dataparcels/ParcelShape.js
@@ -0,0 +1,2 @@
/* eslint-disable */
module.exports = require('./lib/parcelShape/ParcelShape.js').default;