skandha 0.10.2 → 0.11.0

package/README.md

@@ -2,22 +2,14 @@
 
 ## Introduction
 
-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.
+SkandhaJS is a library that provides data containers with reusable behaviors, or "facets," that are implemented as classes. Examples of facets are selection, highlighting, filtering, drag-and-drop, etc. These facets provide interfaces for specific behaviors and rely on callback functions provided by the programmer to specify the details of those behaviors. The goal of SkandhaJS is to provide a way to create interactions between different behaviors in a consistent and modular way.
 
 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.
+1. The application has a local state with a list of todos. The state contains a `todoSelection` facet so that clients can make a selection.
 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.
+3. The `todoSelection.selectItem` function runs the `select` function from its `callbackMap`.
+4. The `select` callback performs the selection and a side-effect: it highlights the item as well.
 
 ## Benefits
 
@@ -25,7 +17,7 @@ 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).
+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 how selection works, or even of the type of items that are being selected).
 
 ## Links
 
@@ -57,8 +49,7 @@ In Skandha, a behaviour such as selection is implemented in a "facet" class. The
 ```
 // file: Selection.ts
 import { input, output, operation } from 'skandha';
-import { host, stub } from 'aspiration';
-import { Selection_selectItem, SelectionParamsT } from 'SelectionCbs';
+import { DefineCbs, getCallbacks, withCbs, stub } from 'aspiration';
 
 export class Selection<ValueT = any> {
   static className = () => 'Selection';
@@ -68,30 +59,24 @@ export class Selection<ValueT = any> {
   @output anchorId?: string;
   @output items: Array<ValueT> = stub();
 
-  @operation @host(['selectionParams']) selectItem(
-    selectionParams: SelectionParamsT
-  ) {
-    const cbs = getCallbacks<Selection_selectItem>(this);
+  @operation @withCbs() selectItem(args: SelectionParamsT) {
+    const cbs = getCallbacks(this) as SelectionCbs['selectItem'];
     cbs.select();
   }
 }
-```
-
-```
-// file: SelectionCbs.ts
-import { stub } from 'aspiration';
 
-export type SelectionParamsT = { itemId?: string; isShift?: boolean; isCtrl?: boolean; };
+type Cbs<T> = {
+  selectItem: {
+    selectItem(): void;
+  };
+};
 
-export class Selection_selectItem extends Cbs {
-  selectionParams: SelectionParamsT = stub();
-  select() {}
-}
+export type SelectionCbs<T = any> = DefineCbs<Selection<T>, Cbs<T>>;
 ```
 
 ## 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.
+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 store the result of calling `selectItem()` and are marked as `@output` fields. 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`.
 
@@ -101,24 +86,22 @@ The `Selection` facet has a `selectItem()` operation that allows you to select f
 
 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 `@withCbs` 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:
+The `@withCbs` decorator comes from the `Aspiration` library. When you call a function `f` that is decorated with `@withCbs` 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)`;
+- if calls `f(arguments)`, which internally calls the installed callback functions;
 - 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`.
 
-## Callback functions have access to all operation arguments
-
-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).
-
 ## 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.
+The `className()` function is also used to look up facets in containers. Note that if you subclass a facet class then you should (in most cases)
+not override the `className()`. By keeping the original `className()` function, you will be able to replace facets with their subclassed versions without affecting the facet lookup mechanism.
 
 ## Example: a container with Selection, Highlight and Filtering
 
@@ -127,7 +110,7 @@ In this example we will take a look at a todos container. It uses the `Selection
 
 ```
 // file: createContainer.ts
-import { Selection_selectItem } from 'SelectionCbs';
+import { SelectionCbs } from 'SelectionCbs';
 import * as R from 'ramda';
 
 const createContainer() {
@@ -139,9 +122,9 @@ const createContainer() {
 
   setCallbackMap(todosCtr.selection, {
     selectItem: {
-      select(this: Selection_selectItem): {
-        handleSelectItem(todosCtr.selection, this.selectionParams);
-        highlightFollowsSelection(todosCtr, this.selectionParams);
+      select(this: SelectionCbs['selectItem']): {
+        handleSelectItem(todosCtr.selection, this.args);
+        highlightFollowsSelection(todosCtr, this.args);
       },
     }
   });
@@ -203,13 +186,13 @@ export function handleSelectItem(
 
 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.
 
-## 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. 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.
+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.args`. See the `aspiration` library documentation for details.
 
-## The callback function can access the callbackMap object through `this`.
+## Callbacks can take care of side effects
 
-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`.
+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.
 
 ## The `exit()` callback function is called at the end of an operation
 
@@ -226,7 +209,7 @@ We've seen how facets are implemented, and how they can be added to a container
 ```
 // file: createContainer.ts
 import * from 'ramda' as R;
-import { mapDataToProps, pmap } from 'skandha';
+import { mapDataToProps } from 'skandha';
 
 class TodosData {
   static className = () => 'Inputs';
@@ -247,30 +230,20 @@ const createContainer = () => {
     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)
-    ),
+  mapDataToProps(todosCtr,
+    filtering: {
+      inputItems: () => todosCtr.data.todos,
+      filteredItems: () => todosCtr.filtering.filteredItems,
+    },
+    selection: {
+      selectableIds: () => R.map(R.prop('id'), todosCtr.data.filteredTodos),
+      items: () => R.map(getTodoById, todosCtr.selection.ids),
+    },
+    highlight: {
+      item: () => getTodoById(todosCtr.highlight.id)
+    }
   )
 }
 
@@ -279,15 +252,11 @@ setOptions({logging: true});
 
 ## The `mapDataToProps()` function maps data between objects
 
-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.
-
-## The `pmap()` function adds type-checking
-
-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).
+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. In our example, we see that the `todosCtr.data.todos` field is mapped onto the `todosCtr.filtering.inputItems` field.
 
 ## Logging can be enabled using `setOptions()`
 
-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:
+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 similar to 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

package/index.d.ts

@@ -1,11 +1,11 @@
 export { getCtrState } from './internal/logging';
 export { decorateCb, getOptions, setOptions } from './internal/options';
-export { getc, getFacetMemberNames } from './lib/ctr';
+export { getFacetMemberNames, getc } 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, mapDataToProps, pmap } from './lib/patch';
+export { mapDataToProp, mapDataToProps } from './lib/patch';
 export { registerCtr } from './lib/registerCtr';
 export type { OptionsT as RegisterCtrOptionsT } from './lib/registerCtr';
-export declare type ClassT = any;
+export type ClassT = any;

package/index.js

@@ -1,9 +1,9 @@
 export { getCtrState } from './internal/logging';
 export { decorateCb, getOptions, setOptions } from './internal/options';
-export { getc, getFacetMemberNames } from './lib/ctr';
+export { getFacetMemberNames, getc } 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, mapDataToProps, pmap } from './lib/patch';
+export { mapDataToProp, mapDataToProps } from './lib/patch';
 export { registerCtr } from './lib/registerCtr';

package/lib/operation.js

@@ -13,7 +13,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {

package/lib/patch.d.ts

@@ -1,3 +1,8 @@
 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]))[];
+type Mappings<F> = {
+    [K in keyof F]?: {
+        [P in keyof F[K]]?: () => F[K][P];
+    };
+};
+export declare function mapDataToProps<T>(target: T, mappings: Mappings<T>): void;
+export {};

package/lib/patch.js

@@ -6,16 +6,21 @@ 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];
+export function mapDataToProps(target, mappings) {
+    for (var key in mappings) {
+        if (mappings.hasOwnProperty(key)) {
+            var facet = target[key];
+            var propMappings = mappings[key];
+            if (facet && propMappings) {
+                for (var prop in propMappings) {
+                    if (propMappings.hasOwnProperty(prop)) {
+                        var getter = propMappings[prop];
+                        if (getter) {
+                            mapDataToProp(facet, prop, getter);
+                        }
+                    }
+                }
+            }
+        }
     }
-    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,4 +1,4 @@
-export declare type OptionsT = {
+export type OptionsT = {
     name: string;
     facets?: string[];
     ctrState?: Function;

package/package.json

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