skandha 0.9.1 → 0.10.2

package/README.md

@@ -1,8 +1,31 @@
 # SkandhaJS
 
-## Rationale
+## Introduction
 
-The goal of SkandhaJS is to provide data containers that have reusable behaviors, such as selection, highlighting, filtering, drag-and-drop, etc. The only requirement for using these containers is that every item in the container has a unique id. SkandhaJS allows you to combine behaviors and make them interact properly. For example, when selecting an item you may want the item also to be highlighted. As we will see, these interactions are achieved by implementing callback functions.
+The goal of SkandhaJS is to provide data containers that have reusable behaviors. These behaviours are implemented in classes called "facets". Examples of facets are selection, highlighting, filtering, drag-and-drop, etc. By connecting these facets, you can create interactions between different behaviours.
+
+Every facet provides an interface that supports a particular behaviour. This interface is used throughout the application, and ensures that the basic mechanism (e.g. for doing selection) is the same everywhere. The details of the behaviour depend on callback functions that the programmer provides:
+
+1. Callbacks decide what exactly happens when an item is selected, highlighted, deleted etc.
+2. Callbacks implement interactions. For example: when selecting an item, also higlight it.
+
+The second point is important for limiting the mixing of concerns that happens when you are combining multiple behaviours. This mixing of concerns is unavoidable, but should be limited to specific places that can be easily inspected.
+
+As a brief illustration, consider the example of selecting a todo in a list of todos:
+
+1. The application creates a local state to store todos. This state contains a `todoSelection` facet.
+2. When the user clicks on a todo, the todo-list component calls `todoSelection.selectItem(todo.id, shift, ctrl)`.
+3. The `aspiration` library intercepts the call in order to prepare a so-called `callbackMap`.
+4. Next, the `todoSelection.selectItem` function runs. It uses the `select` function from the `callbackMap` to do its work.
+5. The `select` callback performs the selection and a side-effect: it highlights the item as well.
+
+## Benefits
+
+There are three ways in which facets help you to write generic code:
+
+1. They can be reused in any container, regardless of what data-type is stored in the container. This means that selection, filtering and drag-and-drop work the same everywhere in the application.
+2. They allow you to capture the interaction between behaviours in reusable functions.
+3. They allow you to handle user-interaction in UI components in a uniform way. All UI components that receive a selection facet will use the same interface to make a selection (and in theory the component can remain agnostic of the data-type of the selected items).
 
 ## Links
 
@@ -14,90 +37,127 @@ The goal of SkandhaJS is to provide data containers that have reusable behaviors
 
 ## Glossary (conceptual)
 
-- callbacks object: a collection of callback functions that is used by an operation.
-- container: a class that contains multiple facets.
+- callback function: a function that is called by an operation to help implement that operation
+- callbackMap object: a collection of callback functions that is used by an operation.
+- container: an object that contains data and facets. Typically, these facets are made to work together using callback functions.
 - facet: a class that implements a reusable behaviour, such as selection.
 - operation: a member function of a facet that changes the data of that facet.
 
 ## Glossary (technical)
 
 - aspiration: a library that implements a form of Aspect Oriented Programming using callback functions.
+- mapDataToProps: a helper function that maps data from one object to another. It's used to map data between facets.
 - registerCtr: the function that tells SkandhaJS which containers and facets exist.
-- setCallbacks: the function that installs the callbacks objects that are used by a facet.
+- setCallbackMap: the function that installs the callbackMap objects that are used by a facet.
 
-## Example: a simplified Selection facet
+## Example: a Selection facet
 
-In Skandha, behaviours (such as selection, or filtering) are implemented in so-called facets that live in containers. For example, a todo container may have facets for selecting, highlighting and filtering todos. Because facets are reusable, they can also be used in other containers. And because facets are abstractions, you can use them to create UI components that handle selection in any container. In this example, we will show a simplified Selection facet class.
+In Skandha, a behaviour such as selection is implemented in a "facet" class. The purpose of the selection facet is to store (and manipulate) the meta-data related to selection. In this example, we will show a simplified Selection facet class.
 
 ```
 // file: Selection.ts
 import { input, output, operation } from 'skandha';
-
-export type SelectionParamsT = { itemId?: string; isShift?: boolean; isCtrl?: boolean; };
+import { host, stub } from 'aspiration';
+import { Selection_selectItem, SelectionParamsT } from 'SelectionCbs';
 
 export class Selection<ValueT = any> {
   static className = () => 'Selection';
 
-  @input selectableIds: Array<string> = [];
+  @input selectableIds: Array<string> = stub();
   @output ids: Array<string> = [];
   @output anchorId?: string;
-  @output items: Array<ValueT> = [];
+  @output items: Array<ValueT> = stub();
 
-  @operation selectItem(selectionParams: SelectionParamsT) {
-    // This function calls a callback function to do the actual work.
-    // Details about how this works are omitted for now.
+  @operation @host(['selectionParams']) selectItem(
+    selectionParams: SelectionParamsT
+  ) {
+    const cbs = getCallbacks<Selection_selectItem>(this);
+    cbs.select();
   }
 }
 ```
 
-## Fact: facets have @input, @data and @output members
+```
+// file: SelectionCbs.ts
+import { stub } from 'aspiration';
 
-In `Selection.ts` we see the Selection facet class. It has a `selectableIds` field that stores the list of ids from which we can select. It is marked with the `@input` decorator because this field stores an input. The `ids`, `anchorId` and `items` fields are marked as `@output` fields. They are used to store the result of calling `selectItem()`.
+export type SelectionParamsT = { itemId?: string; isShift?: boolean; isCtrl?: boolean; };
 
-## Fact: operations are decorated with `@operation`.
+export class Selection_selectItem extends Cbs {
+  selectionParams: SelectionParamsT = stub();
+  select() {}
+}
+```
+
+## Facets have @input, @data and @output members
+
+In `Selection.ts` we see the Selection facet class. It has a `selectableIds` field that stores the list of ids from which we can select. The `@input` decorator marks this field as an input. The `ids`, `anchorId` and `items` fields are marked as `@output` fields. They are used to store the result of calling `selectItem()`. Fields that are decorated with `@data` are used both as output and input. These decorators help with logging, and they also make it possible to bind the facets to state-management solutions such as MobX.
+
+## Operations are decorated with `@operation`.
+
+The `Selection` facet has a `selectItem()` operation that allows you to select from the selectable ids. It stores its results in the `ids`, `anchorId` and `items` fields. As the comment mentions, `selectItem()` calls a callback function to do the actual work. This design leaves the selection method (e.g. what should happen if shift is pressed?) up to the client, which makes it possible to support different use-cases flexibly.
+
+## Operations are logged
+
+As a side effect of calling an operation, the entire container is logged to the console (if logging is enabled); this includes the Selection facet, and any other facets that the container may have (such as filtering, or highlight). The log message contains all @input, @data and @output fields of all facets in the container.
+
+## The `@host` decorator is used to enable callbacks in an operation.
+
+The `@host` decorator comes from the `Aspiration` library. When you call a function `f` that is decorated with `@host` then the following happens:
+
+- Aspiration looks up the callbackMap object (that was installed with `setCallbackMap()`) for the given operation;
+- it copies the operation arguments to the callbackMap object, so that callback functions can access these arguments;
+- if calls `f(arguments)`;
+- it restores the callbackMap object to its previous state. This ensures that nested calls work correctly.
+
+If the original function `f` wants to access the callbackMap object then it uses the `getCallbacks` helper function. Note that the client code calls `f` in the usual way; it remains agnostic of the fact that callbacks are used to help implement `f`.
 
-Conceptually, an operation is a member function that is used to manipulate the facet. The `Selection` facet has a `selectItems` operation that allows you to select from the selectable ids. It stores its results in the `ids`, `anchorId` and `items` fields.
-As the comment mentions, `selectItem()` calls a callback function to do the actual work. The reason is that the correct way to make a selection (e.g. what should happen if shift is pressed?) depends on the use-case. Therefore, we want to leave it up to the client to decide this.
+## Callback functions have access to all operation arguments
 
-## Fact: operations are logged
+Each callback function of the callbackMap object has access to all arguments of the operation. In our example, the argument of the `selectItem` operation is named `selectionParams`. Therefore, a `selectionParams` field also exists in the `Selection_selectItem` class that stores the callbackMap. We must manually pass the list of argument names to the `@host` decorator, so that SkandhaJS can copy these values (unfortunately, introspection in typescript is not good enough to automate this).
 
-As a side effect of calling an operation, the entire container is logged to the console; this includes the Selection facet, and any other facets that the container may have. The log message contains all @input, @data and @output fields of all facets in the container.
+## Facets have a static `className()` function
+
+To allow SkandhaJS to log the container, you need to add the `className()` function to each facet class, so that Skandha knows the name of the facet.
 
 ## Example: a container with Selection, Highlight and Filtering
 
 Now that we have some idea of what a facet is, we will discuss containers.
-In this example we will take a look at a todos container. It uses the `Selection` facet that we saw earlier.
+In this example we will take a look at a todos container. It uses the `Selection` facet that we saw earlier (and some other facets that we haven't defined yet). Note that in this example, we're not yet storing any data in the container (this will come later).
 
 ```
 // file: createContainer.ts
 import { Selection_selectItem } from 'SelectionCbs';
+import * as R from 'ramda';
 
 const createContainer() {
-  const ctr = {
+  const todosCtr = {
     selection: new Selection(),
     highlight: new Highlight(),
     filtering: new Filtering()
   };
 
-  setCallbacks(ctr.selection, {
+  setCallbackMap(todosCtr.selection, {
     selectItem: {
       select(this: Selection_selectItem): {
-        handleSelectItem(ctr.selection, this.selectionParams);
-        highlightFollowsSelection(ctr, this.selectionParams);
+        handleSelectItem(todosCtr.selection, this.selectionParams);
+        highlightFollowsSelection(todosCtr, this.selectionParams);
       },
     }
   });
 
-  setCallbacks(ctr.filtering, {
+  setCallbackMap(todosCtr.highlight, {});
+
+  setCallbackMap(todosCtr.filtering, {
     apply: {
       exit() {
-        highlightIsCorrectedOnFilterChange(ctr);
+        highlightIsCorrectedOnFilterChange(todosCtr);
       },
     },
   });
 
-  registerCtr({ ctr: ctr, options: { name: 'Todos'} });
-  return ctr;
+  registerCtr({ ctr: todosCtr, options: { name: 'Todos'} });
+  return todosCtr;
 }
 ```
 
@@ -139,141 +199,103 @@ export function handleSelectItem(
 }
 ```
 
-## Note: the todos container has selection, highlight and filtering
+## Callbacks are installed with `setCallbackMap()`
 
-In `createContainer.ts` we see how `createContainer()` creates a `ctr` object that has three facets: selection, highlight and filtering. After creating the container, the `installCallbacks` function is called to determine how the facet operations are implemented. Finally, `registerCtr()` is called to allow SkandhaJS to introspect the container. This is necessary for two reasons. First, it makes it possible to look up a facet by its name or class, e.g. `getf(ctr, Selection)` returns `ctr.selection`. Second, it informs SkandhaJS how to log all facets of the container
+We call `setCallbackMap()` to install a callbackMap object for each operation of the `Selection` facet. In our case we only have one operation (`selectItem()`) that has only one callback (`select()`). This callback function calls `handleSelectItem()` to take care of doing the selection. This is a typical pattern: you want the call to `setCallbackMap()` to be as short and readable as possible, so that it's easy to understand what happens in each operation of each facet.
 
-## Fact: callbacks are installed with `setCallbacks`
+## Callbacks can take care of side effects
 
-We call `setCallbacks` to install a callbacks object for each operation of the `Selection` facet. The callbacks object contains all callbacks for an operation. In our case we only have one operation (`selectItem()`) that has only one callback (`select()`). This callback function calls `handleSelectItem` to take care of doing the selection. This is a typical pattern: you want the call to `setCallbacks` to be as short and readable as possible, so that it's easy to understand what happens in each operation of each facet.
+An important advantage of using callbacks is that they can also take care of side effects. In this case, it calls `highlightFollowsSelection()` to ensure that selected items are also highlighted. Note that the callback function is able to connect selection and highlight because it has access to the entire container. Keeping the code of `setCallbackMap()` short also helps the reader to understand which interactions take place. This is vital, because we are purposely mixing concerns in this part of the code, which means that there is a higher risk of confusing the reader.
 
-## Fact: callbacks can take care of side effects
+## The callback function can access the callbackMap object through `this`.
 
-An important advantage of using callbacks is that they can also take care of side effects. In this case, it calls `highlightFollowsSelection()` to ensure that selected items are also highlighted. Note that the callback function is able to connect selection and highlight because it has access to the entire container.
+When the clients calls `todosCtr.selection.selectItem()` and `select()` is called back, then all arguments of the operation are available through `this`. In our case, we see that the `select()` callback function is accessing `this.selectionParams`.
 
-## Fact: the callback function can access the callbacks object through `this`.
+## The `exit()` callback function is called at the end of an operation
 
-When the clients calls `ctr.selection.selectItem()` and `select` is called back, then all arguments of the operation are available through `this`. In our case, we see that the `select` callback function is accessing `this.selectionParams`.
+In `createContainer.ts` we also have a `Filtering` facet that has an `apply(f)` operation (where `f` is the filter function). In this operation, we install the `exit()` callback that corrects the highlight when the filter function changes (because the new filter may hide the highlighted item). The `exit()` callback is called automatically at the end of each operation. Similarly, the `enter()` callback is called automatically at the beginning.
 
-## Fact: the `exit` callback function is called at the end of an operation
+## The `registerCtr()` allows SkandhaJS to introspect the container
 
-In `createContainer.ts` we also have a `Filtering` facet that has an `apply(f)` operation (where `f` is the filter function). In this operation, we install the `exit()` callback that corrects the highlight when the filter function changes (because the new filter may hide the highlighted item). The `exit()` callback is called automatically at the end of each operation. Similarly, the `enter()` callback is called at the beginning.
+At the end of `createContainer.ts` we call `registerCtr()` so that SkandhaJS can introspect the container. This is necessary for two reasons. First, it makes it possible to look up a facet by its name or class, e.g. `getf(todosCtr, Selection)` returns `todosCtr.selection`. Second, it informs SkandhaJS how to log all facets of the container.
 
-## Example: a complete Selection facet
+## Example: `mapDataToProps()` maps data onto each facet
 
-It's time now to return to the Selection facet and show how callbacks really work.
+We've seen how facets are implemented, and how they can be added to a container in a way that allows us to create interactions between them. The next step is to map data between facets. Such mappings are necessary when the input data for one facet is based on the output data of another facet. For example, we should only allow selection of todos that have not been filtered out. In this example, we will see how we can create such a mapping. Moreover, we will add code to load the todos and set them as the inputs of the filtering facet.
 
 ```
-// file: Selection.ts
-import { input, output, operation } from 'skandha';
-import { host, stub } from 'aspiration';
-import { Selection_selectItem, SelectionParamsT } from 'SelectionCbs';
+// file: createContainer.ts
+import * from 'ramda' as R;
+import { mapDataToProps, pmap } from 'skandha';
 
-export class Selection<ValueT = any> {
-  static className = () => 'Selection';
+class TodosData {
+  static className = () => 'Inputs';
 
-  @input selectableIds: Array<string> = stub();
-  @output ids: Array<string> = [];
-  @output anchorId?: string;
-  @output items: Array<ValueT> = stub();
+  @data todos: TodoT[] = [];
+  @data filteredTodos: TodoT[] = [];
 
-  @operation @host(['selectionParams']) selectItem(
-    selectionParams: SelectionParamsT
-  ) {
-    return (cbs: Selection_selectItem) => {
-      cbs.select();
-    };
+  @data get todoById() {
+    return R.indexBy(R.prop('id'), todosCtr);
   }
 }
-```
-
-```
-// file: SelectionCbs.ts
-import { stub } from 'aspiration';
-
-export type SelectionParamsT = { itemId?: string; isShift?: boolean; isCtrl?: boolean; };
-
-export class Selection_selectItem extends Cbs {
-  selectionParams: SelectionParamsT = stub();
-  select() {}
-}
-```
-
-## Fact: the `@host` decorator is used to enable callbacks in an operation.
 
-The `@host` decorator comes from the `Aspiration` library. When you call a function `f` that is decorated with `@host` then the following happens:
-
-- Aspiration looks up the callbacks object for the operation (that was installed with `setCallbacks`)
-- it copies the operation arguments to the callbacks object (so that callback functions can access these arguments)
-- if calls `f(arguments)(callbacksObject)`.
-
-Remember that `f` is the original function. We see from the example that `f` returns a closure. This closure receives the callbacks object, but (because it's a closure) it also has access to the arguments of f. This approach allows the client code to call `f` in the usual way; it can be agnostic of the fact that callbacks are used to help implement `f`.
-
-## Fact: callback functions have access to all operation arguments
-
-As we mentioned earlier, each callback function of the callbacks object has access to all arguments of the operation. For this to work, it's required that you pass the list of argument names to the `@host` decorator (unfortunately, typescript does not have introspection capabilities that allow to automate this). These names need to match the corresponding fields of the callbacks object class (`Selection_selectItem`).
-
-## Fact: facets have a static `className()` function
-
-To allow SkandhaJS to introspect the container, you need to add the `className()` function to each facet class, so that Skandha knows the name of the facet.
-
-## Example: a Connector maps data onto each facet
-
-We've seen how facets are implemented, and how they can be added to a container in a way that allows us to create interactions between them. Since our container contains selection and filtering, we should only allow selection of todos that have not been filtered out. In other words, the list of selectable ids should be derived from the list of filtered todos. Moreover, we need to load the todos and set them as the inputs of the filtering facet. In this example, we show two containers (data and todos) and how to map data between them.
-
-```
-// file: createContainer.ts
-import * from 'ramda' as R;
-
-const connectContainer(ctr: any) {
-  const data = {
-    inputs: { todos: loadTodos() },
-    outputs: { filteredTodoById: {} },
-  };
-
-  const todos = {
+const createContainer = () => {
+  const todosCtr = {
+    data: new TodosData(),
     selection: new Selection(),
     highlight: new Highlight(),
     filtering: new Filtering(),
   }
+  todosCtr.data.todos = loadTodos();
+
+  const getTodoById = (id?: string) => id ? todosCtr.data.todoById[id] : undefined;
+
+  mapDataToProps(
+    pmap(
+      [todosCtr.filtering, 'inputItems'],
+      () => todosCtr.data.todos
+    ),
+    pmap(
+      [todosCtr.data, 'filteredTodos'],
+      () => todosCtr.filtering.filteredItems
+    ),
+    pmap(
+      [todosCtr.selection, 'selectableIds'],
+      () => R.map(R.prop('id'), todosCtr.data.filteredTodos)
+    ),
+    pmap(
+      [todosCtr.selection, 'items'],
+      () => R.map(getTodoById, todosCtr.selection.ids)
+    ),
+    pmap(
+      [todosCtr.highlight, 'item'],
+      () => getTodoById(todosCtr.highlight.id)
+    ),
+  )
+}
 
-  const con = createConnector({ data: data, todos: todos });
-  const lookUpTodo = (id: string) => outputsCtr.filteredTodoById[id];
+setOptions({logging: true});
+```
 
-  con['todos.filtering'].inputItems = con['inputs'].todos;
-  con['outputs'].filteredTodoById = con['todos.filtering'].filteredItems.tf(R.indexBy('id));
-  con['todos.selection'].selectableIds = con['outputs'].filteredTodoById.tf(R.keys);
-  con['todos.selection'].item = con['todos.selection'].ids.tf(lookUpTodos);
-  con['todos.highlight'].item = con['todos.highlight'].id.tf(lookUpTodo);
+## The `mapDataToProps()` function maps data between objects
 
-  con.connect();
-```
+The `mapDataToProp()` function takes a container, field name and function and installs a `get` property (on the given container, using the given field name) that executes the given function. The `mapDataToProps()` is a small convenience function that calls `mapDataToProp()` on each of its arguments. In our example, we see that the `todosCtr.data.todos` field is mapped onto the `todosCtr.filtering.inputItems` field.
 
-## Fact: the Connector class maps data between objects
+## The `pmap()` function adds type-checking
 
-The Connector instance allows you to map data from one object onto another object.
-In our example, the `data.inputs.todos` field is mapped onto the `todos.filtering.inputItems` field. What this means is that `Connector` turns `todos.filtering.inputItems` into a `get` property that returns `data.inputs.todos`.
+The `pmap` function does not really do anything at run-time, but it adds type-checking at compile-time. It takes two arguments. The first argument is an array that has a container and a container-member. The second argument is a function. The `pmap` function checks that the output of this function can be stored in the container-member (if not, then a compile-time error results). It returns an array that contains its two arguments (because that is the format that `mapDataToProps` expects).
 
-### Logging
+## Logging can be enabled using `setOptions()`
 
-By calling `setOptions({logging: true})`, the SkandhaJS library allows you to inspect each facet before and after calling an operation.
-All facet members that are decorated with `@data` (or `@input`, or `@output`) are logged in a way that looks similar to what you are used to from Redux:
+If you call `setOptions({logging: true})` then the SkandhaJS library logs each facet before and after each operation. All facet members that are decorated with `@data` (or `@input`, or `@output`) are logged in a way that looks similar to what you are used to from Redux:
 
 - before and after each operation, the entire container that holds the facet is logged
 - all data members of each facet in the container are included in the log
 - log entries are nested so that you can see how operation calls are nested
 
-### Making facets observable with Mobx
-
-If you want to render the facets with React then we need to let React know when data changes. The [skandha-mobx](http://github.com/mnieber/skandha-mobx) library was created for this purpose. It has a `registerCtr` function that turns each `@data` member into a Mobx property that is
-either observable or computed:
+## The `registerCtr()` function from facets-mobx makes facets observable
 
-```
-registerCtr({
-  ctr: ctr,
-  options: { name: 'Todos'},
-});
-```
+If you want to render the facets with React then we need to let React know when data changes. The [skandha-mobx](http://github.com/mnieber/skandha-mobx) library was created for this purpose. It has a `registerCtr()` function that can be used instead of the default one from `skandha`. This drop-in replacement version of the normal `registerCtr()` function turns each `@data` member into a Mobx property that is either observable or computed.
 
 ## Conclusion
 
@@ -284,5 +306,4 @@ separating concerns in a clear and understandable way. We could add a `Editing`
 a policy that says that changing the highlight disables editing. By using facets, we will not be tempted to put
 editing-specific code directly in the highlight function (that would obviously be mixing concerns).
 
-In my experience, using SkandhaJS leads to code reuse and improved structure. On top of that, it offers a good
-debugging experience by logging all changes in the container. Finally, it works nicely with MobX to render the container contents.
+In my experience, using SkandhaJS leads to code reuse and improved structure. On top of that, it offers a good debugging experience by logging all changes in the container. Finally, it works nicely with MobX to render the container contents.

package/index.d.ts

@@ -1,12 +1,11 @@
 export { getCtrState } from './internal/logging';
-export { getOptions, setOptions } from './internal/options';
-export { createConnector } from './lib/Connector';
+export { decorateCb, getOptions, setOptions } from './internal/options';
 export { getc, getFacetMemberNames } from './lib/ctr';
 export { data, getDataMemberNames, getLoggedMemberNames, input, log, output, } from './lib/data';
 export { getf } from './lib/facet';
 export { installPolicies } from './lib/install';
 export { getOperationMemberNames, operation } from './lib/operation';
-export { mapDataToProp } from './lib/patch';
+export { mapDataToProp, mapDataToProps, pmap } from './lib/patch';
 export { registerCtr } from './lib/registerCtr';
 export type { OptionsT as RegisterCtrOptionsT } from './lib/registerCtr';
 export declare type ClassT = any;

package/index.js

@@ -1,10 +1,9 @@
 export { getCtrState } from './internal/logging';
-export { getOptions, setOptions } from './internal/options';
-export { createConnector } from './lib/Connector';
+export { decorateCb, getOptions, setOptions } from './internal/options';
 export { getc, getFacetMemberNames } from './lib/ctr';
 export { data, getDataMemberNames, getLoggedMemberNames, input, log, output, } from './lib/data';
 export { getf } from './lib/facet';
 export { installPolicies } from './lib/install';
 export { getOperationMemberNames, operation } from './lib/operation';
-export { mapDataToProp } from './lib/patch';
+export { mapDataToProp, mapDataToProps, pmap } from './lib/patch';
 export { registerCtr } from './lib/registerCtr';

package/internal/options.d.ts

@@ -1,9 +1,12 @@
 export declare const options: {
     logging: boolean;
     formatObject: (x: any) => any;
+    decorateCb: (x: any) => any;
 };
 export declare const getOptions: () => {
     logging: boolean;
     formatObject: (x: any) => any;
+    decorateCb: (x: any) => any;
 };
 export declare const setOptions: (moreOptions: any) => void;
+export declare const decorateCb: (x: any) => any;

package/internal/options.js

@@ -1,8 +1,10 @@
 export var options = {
     logging: false,
     formatObject: function (x) { return x; },
+    decorateCb: function (x) { return x; },
 };
 export var getOptions = function () { return options; };
 export var setOptions = function (moreOptions) {
     Object.assign(options, moreOptions);
 };
+export var decorateCb = function (x) { return options.decorateCb(x); };

package/lib/patch.d.ts

@@ -1 +1,3 @@
-export declare function mapDataToProp(facet: any, prop: string, getter: () => any): void;
+export declare function mapDataToProp<F, P extends keyof F>(facet: F, prop: P, getter: () => F[P]): void;
+export declare function mapDataToProps(...mappings: any[]): void;
+export declare function pmap<F, P extends keyof F>(member: [F, P], getter: () => F[P]): ([F, P] | (() => F[P]))[];

package/lib/patch.js

@@ -6,3 +6,16 @@ export function mapDataToProp(facet, prop, getter) {
         configurable: true,
     });
 }
+export function mapDataToProps() {
+    var mappings = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        mappings[_i] = arguments[_i];
+    }
+    for (var _a = 0, mappings_1 = mappings; _a < mappings_1.length; _a++) {
+        var mapping = mappings_1[_a];
+        mapDataToProp(mapping[0][0], mapping[0][1], mapping[1]);
+    }
+}
+export function pmap(member, getter) {
+    return [member, getter];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skandha",
-  "version": "0.9.1",
+  "version": "0.10.2",
   "description": "Create data containers with modular behaviours",
   "main": "index.js",
   "repository": "https://github.com/mnieber/skandha.git",

package/lib/Connector.d.ts

@@ -1,5 +0,0 @@
-declare type OptionsT = {
-    strict: boolean;
-};
-export declare const createConnector: (obj: any, options?: OptionsT) => any;
-export {};

package/lib/Connector.js

@@ -1,107 +0,0 @@
-import { mapDataToProp } from './patch';
-function _path(path, obj) {
-    var result = obj;
-    for (var _i = 0, _a = path.split('.'); _i < _a.length; _i++) {
-        var part = _a[_i];
-        result = result === null || result === void 0 ? void 0 : result[part];
-        if (result === undefined)
-            return result;
-    }
-    return result;
-}
-var Connector = /** @class */ (function () {
-    function Connector(obj, options) {
-        var _this = this;
-        var _a;
-        this.entityByKey = {};
-        this.getOrCreateEntity = function (key) {
-            if (_this.entityByKey[key])
-                return _this.entityByKey[key];
-            var obj = _path(key, _this.obj);
-            var entity = new Proxy(new Entity(obj), {
-                get: function (target, key) {
-                    return target[key] || target.getOrCreateField(key);
-                },
-                set: function (target, key, value) {
-                    target.fieldByName[key] = value;
-                    return true;
-                },
-            });
-            _this.entityByKey[key] = entity;
-            return entity;
-        };
-        this.connect = function () {
-            for (var _i = 0, _a = Object.values(_this.entityByKey); _i < _a.length; _i++) {
-                var entity = _a[_i];
-                _this._connectEntity(entity);
-            }
-        };
-        this._connectEntity = function (entity) {
-            var _loop_1 = function (entry) {
-                var name_1 = entry[0], field = entry[1];
-                if (_this.options.strict && !(name_1 in entity.obj)) {
-                    throw new Error("Cannot override the field ".concat(name_1, " in ").concat(entity.obj, ".") +
-                        'Field not found. Disable strict mode to ignore this error.');
-                }
-                mapDataToProp(entity.obj, name_1, function () {
-                    return field.getSource();
-                });
-            };
-            for (var _i = 0, _a = Object.entries(entity.fieldByName); _i < _a.length; _i++) {
-                var entry = _a[_i];
-                _loop_1(entry);
-            }
-        };
-        this.options = {
-            strict: (_a = options === null || options === void 0 ? void 0 : options.strict) !== null && _a !== void 0 ? _a : true,
-        };
-        this.obj = obj;
-    }
-    return Connector;
-}());
-export var createConnector = function (obj, options) {
-    var con = new Connector(obj, options);
-    return new Proxy(con, {
-        get: function (target, key) {
-            var _a;
-            return (_a = target[key]) !== null && _a !== void 0 ? _a : target.getOrCreateEntity(key);
-        },
-    });
-};
-var Entity = /** @class */ (function () {
-    function Entity(obj) {
-        var _this = this;
-        this.fieldByName = {};
-        this.getOrCreateField = function (name) {
-            var _a;
-            // If we create a new field then we should *not* store it in fieldByName.
-            return (_a = _this.fieldByName[name]) !== null && _a !== void 0 ? _a : new Field(_this.obj, name);
-        };
-        this.obj = obj;
-    }
-    return Entity;
-}());
-var Field = /** @class */ (function () {
-    function Field(obj, name) {
-        var _this = this;
-        this.transforms = [];
-        this.getSource = function () {
-            if (!(_this.name in _this.obj)) {
-                throw new Error("Field ".concat(_this.name, " does not exist on object ").concat(_this.obj));
-            }
-            var result = _this.obj[_this.name];
-            for (var _i = 0, _a = _this.transforms; _i < _a.length; _i++) {
-                var tf = _a[_i];
-                result = tf(result);
-            }
-            return result;
-        };
-        this.obj = obj;
-        this.name = name;
-    }
-    Field.prototype.tf = function (transform) {
-        this.transforms.push(transform);
-        return this;
-    };
-    return Field;
-}());