aberdeen 1.5.0 → 1.7.0

package/skill/dispatcher.md

@@ -0,0 +1,129 @@
+[**Aberdeen v1.7.0**](README.md)
+
+***
+
+[Aberdeen](README.md) / dispatcher
+
+# dispatcher
+
+## Classes
+
+### Dispatcher
+
+Defined in: [dispatcher.ts:61](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/dispatcher.ts#L61)
+
+Simple route matcher and dispatcher.
+
+Example usage:
+
+```ts
+import * as route from 'aberdeen/route';
+import { Dispatcher, MATCH_REST } from 'aberdeen/dispatcher';
+
+const dispatcher = new Dispatcher();
+
+dispatcher.addRoute("user", Number, "stream", String, (id, stream) => {
+   console.log(`User ${id}, stream ${stream}`);
+});
+
+dispatcher.dispatch(["user", "42", "stream", "music"]);
+// Logs: User 42, stream music
+
+dispatcher.addRoute("search", MATCH_REST, (terms: string[]) => {
+    console.log("Search terms:", terms);
+});
+
+dispatcher.dispatch(["search", "classical", "piano"]);
+// Logs: Search terms: [ 'classical', 'piano' ]
+```
+
+#### Constructors
+
+##### Constructor
+
+> **new Dispatcher**(): [`Dispatcher`](#dispatcher)
+
+###### Returns
+
+[`Dispatcher`](#dispatcher)
+
+#### Methods
+
+##### addRoute()
+
+> **addRoute**\<`T`, `H`\>(...`args`): `void`
+
+Defined in: [dispatcher.ts:73](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/dispatcher.ts#L73)
+
+Add a route with matchers and a handler function.
+
+###### Type Parameters
+
+###### T
+
+`T` *extends* `Matcher`[]
+
+Array of matcher types.
+
+###### H
+
+`H` *extends* (...`args`) => `void`
+
+Handler function type, inferred from the matchers.
+
+###### Parameters
+
+###### args
+
+...\[`...T[]`, `H`\]
+
+An array of matchers followed by a handler function. Each matcher can be:
+- A string: matches exactly that string.
+- A function: takes a string segment and returns a value (of any type) if it matches, or [MATCH\_FAILED](#match_failed) if it doesn't match. The return value (if not `MATCH_FAILED` and not `NaN`) is passed as a parameter to the handler function. The standard JavaScript functions `Number` and `String` can be used to match numeric and string segments respectively.
+- The special [MATCH\_REST](#match_rest) symbol: matches the rest of the segments as an array of strings. Only one `MATCH_REST` is allowed.
+
+###### Returns
+
+`void`
+
+##### dispatch()
+
+> **dispatch**(`segments`): `boolean`
+
+Defined in: [dispatcher.ts:94](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/dispatcher.ts#L94)
+
+Dispatches the given segments to the first route handler that matches.
+
+###### Parameters
+
+###### segments
+
+`string`[]
+
+Array of string segments to match against the added routes. When using this class with the Aberdeen `route` module, one would typically pass `route.current.p`.
+
+###### Returns
+
+`boolean`
+
+True if a matching route was found and handled, false otherwise.
+
+## Variables
+
+### MATCH\_FAILED
+
+> `const` **MATCH\_FAILED**: unique `symbol`
+
+Defined in: [dispatcher.ts:4](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/dispatcher.ts#L4)
+
+Symbol to return when a custom [Dispatcher.addRoute](#addroute) matcher cannot match a segment.
+
+***
+
+### MATCH\_REST
+
+> `const` **MATCH\_REST**: unique `symbol`
+
+Defined in: [dispatcher.ts:9](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/dispatcher.ts#L9)
+
+Special [Dispatcher.addRoute](#addroute) matcher that matches the rest of the segments as an array of strings.

package/skill/prediction.md

@@ -0,0 +1,73 @@
+[**Aberdeen v1.7.0**](README.md)
+
+***
+
+[Aberdeen](README.md) / prediction
+
+# prediction
+
+## Functions
+
+### applyCanon()
+
+> **applyCanon**(`canonFunc?`, `dropPredictions?`): `void`
+
+Defined in: [prediction.ts:115](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/prediction.ts#L115)
+
+Temporarily revert all outstanding predictions, optionally run the provided function
+(which will generally make authoritative changes to the data based on a server response),
+and then attempt to reapply the predictions on top of the new canonical state, dropping
+any predictions that can no longer be applied cleanly (the data has been modified) or
+that were specified in `dropPredictions`.
+
+All of this is done such that redraws are only triggered if the overall effect is an
+actual change to an `Observable`.
+
+#### Parameters
+
+##### canonFunc?
+
+() => `void`
+
+The function to run without any predictions applied. This will typically
+ make authoritative changes to the data, based on a server response.
+
+##### dropPredictions?
+
+`Patch`[] = `[]`
+
+An optional list of predictions (as returned by `applyPrediction`)
+ to undo. Typically, when a server response for a certain request is being handled,
+ you'd want to drop the prediction that was done for that request.
+
+#### Returns
+
+`void`
+
+***
+
+### applyPrediction()
+
+> **applyPrediction**(`predictFunc`): `Patch`
+
+Defined in: [prediction.ts:93](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/prediction.ts#L93)
+
+Run the provided function, while treating all changes to Observables as predictions,
+meaning they will be reverted when changes come back from the server (or some other
+async source).
+
+#### Parameters
+
+##### predictFunc
+
+() => `void`
+
+The function to run. It will generally modify some Observables
+	to immediately reflect state (as closely as possible) that we expect the server
+ to communicate back to us later on.
+
+#### Returns
+
+`Patch`
+
+A `Patch` object. Don't modify it. This is only meant to be passed to `applyCanon`.

package/skill/route.md

@@ -0,0 +1,277 @@
+[**Aberdeen v1.7.0**](README.md)
+
+***
+
+[Aberdeen](README.md) / route
+
+# route
+
+## Interfaces
+
+### Route
+
+Defined in: [route.ts:8](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L8)
+
+The class for the global `route` object.
+
+#### Properties
+
+##### depth
+
+> **depth**: `number`
+
+Defined in: [route.ts:20](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L20)
+
+The navigation depth of the current session. Starts at 1. Writing to this property has no effect.
+
+##### hash
+
+> **hash**: `string`
+
+Defined in: [route.ts:14](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L14)
+
+The hash fragment including the leading `#`, or an empty string. For instance `"#my_section"` or `""`.
+
+##### nav
+
+> **nav**: `NavType`
+
+Defined in: [route.ts:28](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L28)
+
+The navigation action that got us to this page. Writing to this property has no effect.
+- `"load"`: An initial page load.
+- `"back"` or `"forward"`: When we navigated backwards or forwards in the stack.
+- `"go"`: When we added a new page on top of the stack.
+- `"push"`: When we added a new page on top of the stack, merging with the current page.
+Mostly useful for page transition animations. Writing to this property has no effect.
+
+##### p
+
+> **p**: `string`[]
+
+Defined in: [route.ts:12](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L12)
+
+An convenience array containing path segments, mapping to `path`. For instance `[]` (for `"/"`) or `['users', '123', 'feed']` (for `"/users/123/feed"`).
+
+##### path
+
+> **path**: `string`
+
+Defined in: [route.ts:10](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L10)
+
+The current path of the URL as a string. For instance `"/"` or `"/users/123/feed"`. Paths are normalized to always start with a `/` and never end with a `/` (unless it's the root path).
+
+##### search
+
+> **search**: `Record`\<`string`, `string`\>
+
+Defined in: [route.ts:16](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L16)
+
+The query string interpreted as search parameters. So `"a=x&b=y"` becomes `{a: "x", b: "y"}`.
+
+##### state
+
+> **state**: `Record`\<`string`, `any`\>
+
+Defined in: [route.ts:18](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L18)
+
+An object to be used for any additional data you want to associate with the current page. Data should be JSON-compatible.
+
+## Variables
+
+### current
+
+> `const` **current**: [`Route`](#route)
+
+Defined in: [route.ts:332](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L332)
+
+The global [Route](#route) object reflecting the current URL and browser history state. Changes you make to this affect the current browser history item (modifying the URL if needed).
+
+## Functions
+
+### back()
+
+> **back**(`target`): `void`
+
+Defined in: [route.ts:190](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L190)
+
+Try to go back in history to the first entry that matches the given target. If none is found, the given state will replace the current page. This is useful for "cancel" or "close" actions that should return to the previous page if possible, but create a new page if not (for instance when arriving at the current page through a direct link).
+
+Consider using [up](#up) to go up in the path hierarchy.
+
+#### Parameters
+
+##### target
+
+`RouteTarget` = `{}`
+
+The target route to go back to. May be a subset of [Route](#route), or a string (for `path`), or an array of strings (for `p`).
+
+#### Returns
+
+`void`
+
+***
+
+### go()
+
+> **go**(`target`, `nav`): `void`
+
+Defined in: [route.ts:156](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L156)
+
+Navigate to a new URL by pushing a new history entry.
+
+Note that this happens synchronously, immediately updating `route` and processing any reactive updates based on that.
+
+#### Parameters
+
+##### target
+
+`RouteTarget`
+
+A subset of the [Route](#route) properties to navigate to. If neither `p` nor `path` is given, the current path is used. For other properties, an empty/default value is assumed if not given. For convenience:
+- You may pass a string instead of an object, which is interpreted as the `path`.
+- You may pass an array instead of an object, which is interpreted as the `p` array.
+- If you pass `p`, it may contain numbers, which will be converted to strings.
+- If you pass `search`, its values may be numbers, which will be converted to strings.
+
+Examples:
+```js
+// Navigate to /users/123
+route.go("/users/123");
+
+// Navigate to /users/123?tab=feed#top
+route.go({p: ["users", 123], search: {tab: "feed"}, hash: "top"});
+```
+
+##### nav
+
+`NavType` = `"go"`
+
+#### Returns
+
+`void`
+
+***
+
+### interceptLinks()
+
+> **interceptLinks**(): `void`
+
+Defined in: [route.ts:277](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L277)
+
+Intercept clicks and Enter key presses on links (`<a>` tags) and use Aberdeen routing
+instead of browser navigation for local paths (paths without a protocol or host).
+
+This allows you to use regular HTML anchor tags for navigation without needing to
+manually attach click handlers to each link.
+
+#### Returns
+
+`void`
+
+#### Example
+
+```js
+// In your root component:
+route.interceptLinks();
+
+// Now you can use regular anchor tags:
+$('a text=About href=/corporate/about');
+```
+
+***
+
+### persistScroll()
+
+> **persistScroll**(`name`): `void`
+
+Defined in: [route.ts:242](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L242)
+
+Restore and store the vertical and horizontal scroll position for
+the parent element to the page state.
+
+#### Parameters
+
+##### name
+
+`string` = `"main"`
+
+A unique (within this page) name for this
+scrollable element. Defaults to 'main'.
+
+The scroll position will be persisted in `route.aux.scroll.<name>`.
+
+#### Returns
+
+`void`
+
+***
+
+### push()
+
+> **push**(`target`): `void`
+
+Defined in: [route.ts:177](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L177)
+
+Modify the current route by merging `target` into it (using [merge](aberdeen.md#merge)), pushing a new history entry.
+
+This is useful for things like opening modals or side panels, where you want a browser back action to return to the previous state.
+
+#### Parameters
+
+##### target
+
+`RouteTarget`
+
+Same as for [go](#go), but merged into the current route instead deleting all state.
+
+#### Returns
+
+`void`
+
+***
+
+### setLog()
+
+> **setLog**(`value`): `void`
+
+Defined in: [route.ts:37](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L37)
+
+Configure logging on route changes.
+
+#### Parameters
+
+##### value
+
+`true` to enable logging to console, `false` to disable logging, or a custom logging function. Defaults to `false`.
+
+`boolean` | (...`args`) => `void`
+
+#### Returns
+
+`void`
+
+***
+
+### up()
+
+> **up**(`stripCount`): `void`
+
+Defined in: [route.ts:215](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/route.ts#L215)
+
+Navigate up in the path hierarchy, by going back to the first history entry
+that has a shorter path than the current one. If there's none, we just shorten
+the current path.
+
+Note that going back in browser history happens asynchronously, so `route` will not be updated immediately.
+
+#### Parameters
+
+##### stripCount
+
+`number` = `1`
+
+#### Returns
+
+`void`

package/skill/transitions.md

@@ -0,0 +1,59 @@
+[**Aberdeen v1.7.0**](README.md)
+
+***
+
+[Aberdeen](README.md) / transitions
+
+# transitions
+
+## Functions
+
+### grow()
+
+> **grow**(`el`): `Promise`\<`void`\>
+
+Defined in: [transitions.ts:33](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/transitions.ts#L33)
+
+Do a grow transition for the given element. This is meant to be used as a
+handler for the `create` property.
+
+#### Parameters
+
+##### el
+
+`HTMLElement`
+
+The element to transition.
+
+The transition doesn't look great for table elements, and may have problems
+for other specific cases as well.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### shrink()
+
+> **shrink**(`el`): `Promise`\<`void`\>
+
+Defined in: [transitions.ts:56](https://github.com/vanviegen/aberdeen/blob/876d65e85fa77c9453fc72e223d2239e9c745656/src/transitions.ts#L56)
+
+Do a shrink transition for the given element, and remove it from the DOM
+afterwards. This is meant to be used as a handler for the `destroy` property.
+
+#### Parameters
+
+##### el
+
+`HTMLElement`
+
+The element to transition and remove.
+
+The transition doesn't look great for table elements, and may have problems
+for other specific cases as well.
+
+#### Returns
+
+`Promise`\<`void`\>