skandha 0.9.0 → 0.10.1

package/README.md

@@ -2,10 +2,7 @@
 
 ## Rationale
 
-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, 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.
 
 ## Links
 
@@ -15,94 +12,105 @@ be highlighted. As we will see, these interactions are achieved by implementing
 - The [aspiration](http://github.com/mnieber/aspiration) library handles aspect oriented programming (AOP)
 - The [example code](http://github.com/mnieber/skandha-sample-app) shown in this README.
 
-## Snippet
+## Glossary (conceptual)
+
+- callback function: a function that is called by an operation to help implement that operation
+- callbacks object: a collection of callback functions that is used by an operation.
+- container: a class that contains multiple 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 also used to map data between facets.
+- registerCtr: the function that tells SkandhaJS which containers and facets exist.
+- setCallbackMap: the function that installs the callbacks objects that are used by a facet.
+
+## Example: a simplified 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.
 
 ```
 // file: Selection.ts
 import { input, output, operation } from 'skandha';
-import { host, stub } from 'aspiration';
 
 export type SelectionParamsT = { itemId?: string; isShift?: boolean; isCtrl?: boolean; };
 
 export class Selection<ValueT = any> {
   static className = () => 'Selection';
 
-  @input selectableIds: Array<string> = stub();
+  @input selectableIds: Array<string> = [];
   @output ids: Array<string> = [];
   @output anchorId?: string;
-  @output items: Array<ValueT> = stub();
+  @output items: Array<ValueT> = [];
 
-  @operation @host(['selectionParams'], selectItemDefaultCbs) selectItem(
-    selectionParams: SelectionParamsT
-  ) {
-    return (cbs: Selection_selectItem) => {
-      cbs.select();
-    };
+  @operation selectItem(selectionParams: SelectionParamsT) {
+    // This function calls a callback function to do the actual work.
+    // Details about how this works are omitted for now.
   }
 }
 ```
 
-## Fact: the Selection facet has input, data and output members
+## Fact: facets have @input, @data and @output members
 
-In the snippet above we see a so-called Facet class. A facet class implements a reusable behaviour. The `Selection` facet stores a list of selectable ids and has a `selectItem` function that allows you to select from those ids. The result of the selection is stored in the `ids`, `anchorId` and `items` fields. Note that `selectItem` is an empty function. The exact method for doing the selection is determined by a callback function, as we shall see later.
+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()`. Fields that are decorated with `@data` are used both as output and input.
 
-## Fact: the Selection facet has a static className function
+## Fact: operations are decorated with `@operation`.
 
-Various facets are usually combined in a single container. To allow you to look up a facet by it's name, each facet class implements the static `className` function.
+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. 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.
 
-## Fact: the `selectItem` function uses a callback function
+## Fact: operations are logged
 
-We shall see later how callbacks are installed in a facet. For now, it's sufficient to understand that `selectItem` (the host function) executes the `cbs.selectItem()` callback function. This callback function will have access to all parameters of the host function (in this case: `selectionParams`).
+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 (such as filtering, or highlight). The log message contains all @input, @data and @output fields of all facets in the container.
 
-## Snippet
+## Example: a container with Selection, Highlight and Filtering
 
-```
-// file: Selection.ts
-export class Selection_selectItem extends Cbs {
-  selectionParams: SelectionParamsT = stub();
-  select() {}
-}
-```
+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 (and some other facets that we haven't defined yet).
 
 ```
 // file: createContainer.ts
-import { registerCtr } from 'skandha';
+import { Selection_selectItem } from 'SelectionCbs';
 
 const createContainer() {
-  const ctr = {
-    selection: new Selection()
+  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);
+        handleSelectItem(todosCtr.selection, this.selectionParams);
+        highlightFollowsSelection(todosCtr, this.selectionParams);
       },
     }
   });
 
-  // If you omit `members` then all fields of `ctr` are included.
-  registerCtr(ctr, { name: 'TodosCtr', members: ['selection'] });
-  return ctr;
+  setCallbackMap(todosCtr.filtering, {
+    apply: {
+      exit() {
+        highlightIsCorrectedOnFilterChange(todosCtr);
+      },
+    },
+  });
+
+  registerCtr({ ctr: todosCtr, options: { name: 'Todos'} });
+  return todosCtr;
 }
 ```
 
-## Fact: a Cbs class defines a set of callbacks
-
-In the above snippet we see that the `Selection_selectItem` class defines the callbacks that can be installed for the `selectItem` function of the `Selection` facet. This class also defines the parameters that are received by the host function and made available to each callback.
-
-## Fact: the setCallbacks function installs the callbacks for the Selection facet
-
-In the same snippet we see that `setCallbacks` is called to install the `select` callback function. This callback function forwards to a helper function called `handleSelectItem`. Note that the `Selection_selectItem` instance is available through the `this` constant.
-
-## Fact: the registerCtr function registers the container with SkandhaJS
-
-The purpose of calling registerCtr on the container is twofold:
-
-- it makes it possible to look up a facet by its name or class, e.g. `getf(ctr, Selection)` returns `ctr.selection`.
-- it tells SkandhaJS what facets should be included in log reports. When the client calls any facet function that is decorated with @operation then SkandhaJS will log the entire container before and after the operation was executed. Logging can be enabled using the `setOptions` function.
-
-## Snippet: the handleSelectItem functon
+```
+// file: highlightFollowsSelection.ts
+const highlightFollowsSelection = (ctr: any, selectionParams: SelectionParamsT) => {
+  if (!selectionParams.isShift && !selectionParams.isCtrl) {
+    ctr.highlight.highlightItem(selectionParams.itemId);
+  }
+}
+```
 
 ```
 // file: handleSelectItem.ts
@@ -133,163 +141,156 @@ export function handleSelectItem(
 }
 ```
 
-## Fact: the handleSelectItem does the actual work of selecting items
+## Note: the todos container has selection, highlight and filtering
 
-For completeness, we show how `handleSelectItem` is implemented. Note that this function stores the results directly in the selection facet instance.
+In `createContainer.ts` we see how `createContainer()` creates a `todosCtr` 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. In this case, we only install the `select()` callback function.
 
-## Snippet: the Highlight facet
+## Fact: callbacks are installed with `setCallbackMap()`
 
-```
-// file: Highlight.ts
-export class Highlight_highlightItem extends Cbs {
-  id: string = stub();
-  scrollItemIntoView() {}
-}
+We call `setCallbackMap()` to install a callbacks 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.
 
-export class Highlight<ValueT = any> {
-  @data id?: string;
-  @data item?: ValueT;
+## Fact: callbacks can take care of side effects
 
-  @operation @host(["id"]) highlightItem(id: string) {
-    return (cbs: Highlight_highlightItem) => {
-      this.id = id;
-      if (cbs.scrollItemIntoView) {
-        cbs.scrollItemIntoView();
-      }
-    };
-  }
-}
-```
+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.
 
-## Fact: the `Highlight` facet implements the highlight behaviour
+## Fact: the callback function can access the callbacks object through `this`.
 
-The `Highlight` snippet has a similar structure as the `Selection` facet. It has a callback function for scrolling the highlighted item into view. Note that the `highlightItem` function does not set the `item` field, because the facet only deals with ids. We shall later see how the `item` field is set by looking up the item in an external collection.
+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`.
 
-## Snippet: a container with Selection and Highlight
+## Fact: the `exit()` callback function is called at the end of an operation
 
-```
-// file: createContainer.ts
-const createContainer() {
-  const ctr = {
-    selection: new Selection(),
-    highlight: new Highlight()
-  };
+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.
 
-  setCallbacks(ctr.selection, {
-    selectItem: {
-      select(this: Selection_selectItem): {
-        handleSelectItem(ctr.selection, this.selectionParams);
+## Fact: the `registerCtr()` allows SkandhaJS to introspect the container
 
-        if (!this.selectionParams.isShift && !this.selectionParams.isCtrl) {
-          ctr.highlight.highlightItem(this.selectionParams.itemId);
-        }
+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
 
-        // The above 3 lines could be extracted in a reusable helper function, e.g.
-        // highlightFollowsSelection(ctr, this.selectionParams);
-      },
-    }
-  });
+## Example: a complete Selection facet
 
-  return ctr;
-```
+It's time now to return to the Selection facet and show how callbacks really work.
 
-## Fact: callbacks allow you to create co-ordinated behaviours
+```
+// file: Selection.ts
+import { input, output, operation } from 'skandha';
+import { host, stub } from 'aspiration';
+import { Selection_selectItem, SelectionParamsT } from 'SelectionCbs';
 
-Above we see for the first time how SkandhaJS helps you to create co-ordinated behaviours. When the client calls `ctr.selection.selectItem` and the `select` callback is executed, then the callback ensures that the selected item is also highlighted. As the comment in the snippet suggests, we can make the body of the `select` callback more readable by extracting some of the code in a `highlightFollowsSelection` helper function.
+export class Selection<ValueT = any> {
+  static className = () => 'Selection';
 
-## Snippet: a container with Selection, Highlight and Filtering
+  @input selectableIds: Array<string> = stub();
+  @output ids: Array<string> = [];
+  @output anchorId?: string;
+  @output items: Array<ValueT> = stub();
 
+  @operation @host(['selectionParams']) selectItem(
+    selectionParams: SelectionParamsT
+  ) {
+    return (cbs: Selection_selectItem) => {
+      cbs.select();
+    };
+  }
+}
 ```
-// file: createContainer.ts
-const createContainer() {
-  const ctr = {
-    selection: new Selection(),
-    highlight: new Highlight(),
-    filtering: new Filtering()
-  };
 
-  setCallbacks(ctr.selection, {
-    selectItem: {
-      select(this: Selection_selectItem): {
-        handleSelectItem(ctr.selection, this.selectionParams);
-        highlightFollowsSelection(ctr, this.selectionParams);
-      },
-    }
-  });
+```
+// file: SelectionCbs.ts
+import { stub } from 'aspiration';
 
-  setCallbacks(filtering, {
-    apply: {
-      exit() {
-        highlightIsCorrectedOnFilterChange(ctr);
-      },
-    },
-  });
+export type SelectionParamsT = { itemId?: string; isShift?: boolean; isCtrl?: boolean; };
 
-  return ctr;
+export class Selection_selectItem extends Cbs {
+  selectionParams: SelectionParamsT = stub();
+  select() {}
 }
 ```
 
-## Fact: the `exit` callback function is called at the end of the host function
+## 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 `setCallbackMap()`)
+- 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
 
-In the snippet we add a filtering facet that has an `apply` host function. In this host function, we can install an `exit` callback that corrects the highlight when the filter changes (because the filter may hide the highlighted item). The `exit` callback is called at the end of the host function. Similarly, the `enter` callback is called at the beginning.
+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`).
 
-## Snippet: mapping data onto each facet
+## 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: `mapDataToProps()` 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. In this example, we will see how we can create such a mapping from the filtering facet to the selection facet. Moreover, we will add code to load the todos and set them as the inputs of the filtering facet.
 
 ```
 // file: createContainer.ts
 import * from 'ramda' as R;
+import { mapDataToProps, pmap } from 'skandha';
 
-const connectContainer(ctr: any) {
-  const inputs = { todos: loadTodos() };
-  const outputs = { filteredTodoById: {} };
+const createContainer = () => {
+  const todosCtr = {
+    data: {
+      todos: loadTodos(),
+      filteredTodoById: {},
+    },
+    selection: new Selection(),
+    highlight: new Highlight(),
+    filtering: new Filtering(),
+  }
 
-  const con = createConnector({
-    selection: () => ctr.selection,
-    highlight: () => ctr.highlight,
-    filtering: () => ctr.filtering`,
-    inputs: () => inputs,
-    outputs: () => outputs,
-  });
+  const lookUpTodo = (id?: string) => id ? todosCtr.data.filteredTodoById[id] : undefined;
+
+  mapDataToProps(
+    pmap(
+      [todosCtr.filtering, 'inputItems'],
+      () => todosCtr.data.todos
+    ),
+    pmap(
+      [todosCtr.data, 'filteredTodoById'],
+      () => R.indexBy('id')(todosCtr.filtering.filteredItems)
+    ),
+    pmap(
+      [todosCtr.selection, 'selectableIds'],
+      () => R.keys(todosCtr.data.filteredTodoById)
+    ),
+    pmap(
+      [todosCtr.selection, 'item'],
+      () => R.map(lookUpTodo, todosCtr.selection.ids)
+    ),
+    pmap(
+      [todosCtr.highlight, 'item'],
+      () => lookUpTodo(todosCtr.highlight.id)
+    ),
+  )
+}
 
-  const lookUpTodo = (id: string) => outputs.filteredTodoById[id];
+setOptions({logging: true});
+```
 
-  con.filtering.inputItems = con.inputs.todos;
-  con.outputs.filteredTodoById = con.filtering.filteredItems.tf(R.indexBy('id));
-  con.selection.selectableIds = con.outputs.filteredTodoById.tf(R.keys);
-  con.selection.item = con.selection.ids.tf(lookUpTodos);
-  con.highlight.item = con.highlight.id.tf(lookUpTodo);
+## Fact: the `mapDataToProps()` function maps data between objects
 
-  con.connect();
-```
+The `mapDataToProp()` function takes a container, field name and function then it turns that field into a `get` property 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
+## Fact: the `pmap()` function adds type-checking
 
-The Connector instance allows you to map data from one object onto another object. In our example, the `inputs.todos` field is mapped onto the `filtering.inputItems` field. What the `Connector` class does is turn `filtering.inputItems` into a `get` property that returns `filtering.inputItems`.
-The snippet contains three steps. In the first step we declare the objects, such as `selection`, `filtering`, etc. For each object, we specify the getter function that returns the object. In the second step, we declare relations between the different fields of these objects. In this step, we can also declare one or more transformation functions (such as `lookUpTodo`) that should be used in the mapping. In the final step, we call `con.connect` to create the `get` properties that perform the declared mappings.
+The `pmap()` function 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). As you can see, `pmap` does not do any useful work at run-time, but it adds type-checking at compile-time.
 
-### Logging
+## Fact: 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. An operation is any facet member function decorated with @operation.
-This will log Facet members that are decorated with `@data` (or `@input`, or `@output`) in a way that looks similar to what you are used to from Redux:
+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:
 
 - 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
+## Fact: the `registerCtr()` function from facets-mobx makes facets observable
 
-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:
-
-```
-registerCtr({
-  ctr: ctr,
-  options: { name: 'TodosCtr'},
-});
-```
+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 replacement version of `registerCtr()` function turns each `@data` member into a Mobx property that is either observable or computed.
 
 ## Conclusion
 

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 { 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 { 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/utils.js

@@ -1,11 +1,7 @@
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
+var __spreadArray = (this && this.__spreadArray) || function (to, from) {
+    for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
+        to[j] = from[i];
+    return to;
 };
 import { symbols } from './symbols';
 export function getOrCreate(obj, key, fn) {
@@ -20,7 +16,7 @@ export var zip = function (arr) {
         arrs[_i - 1] = arguments[_i];
     }
     return arr.map(function (val, i) {
-        return arrs.reduce(function (a, arr) { return __spreadArray(__spreadArray([], a, true), [arr[i]], false); }, [val]);
+        return arrs.reduce(function (a, arr) { return __spreadArray(__spreadArray([], a), [arr[i]]); }, [val]);
     });
 };
 export function getCtrAdmin(ctr) {

package/lib/facet.js

@@ -11,7 +11,7 @@ export function getf(facetClass, ctr) {
         : (_a = getCtrAdmin(ctr).facetByFacetClassName) === null || _a === void 0 ? void 0 : _a[facetClassName(facetClass)];
     if (!facet) {
         var facetName = facetClass === 'string' ? facetClass : facetClassName(facetClass);
-        console.error("No facet ".concat(facetName, " in container ").concat(getCtrAdmin(ctr).logName));
+        console.error("No facet " + facetName + " in container " + getCtrAdmin(ctr).logName);
     }
     return facet;
 }

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/lib/registerCtr.d.ts

@@ -1,6 +1,6 @@
 export declare type OptionsT = {
     name: string;
-    members?: string[];
+    facets?: string[];
     ctrState?: Function;
 };
 export declare function registerCtr(ctr: any, options: OptionsT): void;

package/lib/registerCtr.js

@@ -10,18 +10,18 @@ export function registerCtr(ctr, options) {
     ctrAdmin.facetMembers = (_a = ctrAdmin.facetMembers) !== null && _a !== void 0 ? _a : [];
     ctrAdmin.facetByFacetClassName = (_b = ctrAdmin.facetByFacetClassName) !== null && _b !== void 0 ? _b : {};
     ctrAdmin.ctrStateOverride = options.ctrState;
-    ((_c = options.members) !== null && _c !== void 0 ? _c : Object.getOwnPropertyNames(ctr)).forEach(function (member) {
-        var facet = ctr[member];
+    ((_c = options.facets) !== null && _c !== void 0 ? _c : Object.getOwnPropertyNames(ctr)).forEach(function (facetName) {
+        var facet = ctr[facetName];
         setCtr(facet, ctr);
-        ctrAdmin.facetMembers.push(member);
+        ctrAdmin.facetMembers.push(facetName);
         if (!facet.constructor.className) {
-            console.error("Facet ".concat(member, " of container ").concat(ctrAdmin.logName, " ") +
+            console.error("Facet " + facetName + " of container " + ctrAdmin.logName + " " +
                 "does not have a static className function");
         }
         var className = facetClassName(facet.constructor);
-        getFacetAdmin(facet).logName = "".concat(ctrAdmin.logName, "/").concat(className);
+        getFacetAdmin(facet).logName = ctrAdmin.logName + "/" + className;
         if (ctrAdmin.facetByFacetClassName[className] !== undefined) {
-            console.error("Two facets of same type ".concat(className, " in container ").concat(ctrAdmin.logName));
+            console.error("Two facets of same type " + className + " in container " + ctrAdmin.logName);
         }
         ctrAdmin.facetByFacetClassName[className] = facet;
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skandha",
-  "version": "0.9.0",
+  "version": "0.10.1",
   "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 FunctionByNameT = {
-    [name: string]: Function;
-};
-export declare const createConnector: (entities: FunctionByNameT) => any;
-export {};

package/lib/Connector.js

@@ -1,98 +0,0 @@
-import { mapDataToProp } from './patch';
-var Connector = /** @class */ (function () {
-    function Connector(entities, options) {
-        var _this = this;
-        var _a;
-        this.entityByName = {};
-        this.connect = function () {
-            for (var _i = 0, _a = Object.values(_this.entityByName); _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];
-                var obj = entity.getObj();
-                if (_this.options.strict && !(name_1 in obj)) {
-                    throw new Error("Cannot override the field ".concat(name_1, " in ").concat(obj, ".") +
-                        'Field not found. Disable strict mode to ignore this error.');
-                }
-                mapDataToProp(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,
-        };
-        for (var _i = 0, _b = Object.entries(entities); _i < _b.length; _i++) {
-            var entry = _b[_i];
-            var name_2 = entry[0], getObj = entry[1];
-            this.entityByName[name_2] = new Entity(getObj);
-        }
-    }
-    return Connector;
-}());
-export var createConnector = function (entities) {
-    var con = new Connector(entities);
-    return new Proxy(con, {
-        get: function (target, key) {
-            // Code example:
-            //
-            // const con = createConnector({ foo: () => myFoo });
-            //
-            // When you call `con.foo` then you
-            // receive `con.entityByName.foo.fieldByName`.
-            //
-            // con.foo.bar = 5;  // Equivalent to: con.entityByName.foo.fieldByName.bar = 5
-            //
-            // When you call `con.connect` then a normal lookup of the `connect`
-            // member in `con` is performed.
-            var _a, _b;
-            return (_b = (_a = target.entityByName[key]) === null || _a === void 0 ? void 0 : _a.fieldByName) !== null && _b !== void 0 ? _b : target[key];
-        },
-    });
-};
-var Entity = /** @class */ (function () {
-    function Entity(getObj) {
-        var _this = this;
-        this.getObj = getObj;
-        this.fieldByName = new Proxy({}, {
-            get: function (target, key) {
-                var _a;
-                return (_a = target[key]) !== null && _a !== void 0 ? _a : new Field(_this, key);
-            },
-        });
-    }
-    return Entity;
-}());
-var Field = /** @class */ (function () {
-    function Field(entity, name) {
-        var _this = this;
-        this.transforms = [];
-        this.getSource = function () {
-            var obj = _this.entity.getObj();
-            if (!(_this.name in obj)) {
-                throw new Error("Field ".concat(_this.name, " does not exist on object ").concat(obj));
-            }
-            var result = obj[_this.name];
-            for (var _i = 0, _a = _this.transforms; _i < _a.length; _i++) {
-                var tf = _a[_i];
-                result = tf(result);
-            }
-            return result;
-        };
-        this.entity = entity;
-        this.name = name;
-    }
-    Field.prototype.tf = function (transform) {
-        this.transforms.push(transform);
-        return this;
-    };
-    return Field;
-}());