Skip to content

Commit

Permalink
chore: prepare release 1.7.1
Browse files Browse the repository at this point in the history
  • Loading branch information
zewa666 committed Feb 9, 2022
1 parent 6ccae8a commit 1991227
Show file tree
Hide file tree
Showing 11 changed files with 24 additions and 172 deletions.
2 changes: 1 addition & 1 deletion dist/amd/aurelia-store.js
Original file line number Diff line number Diff line change
Expand Up @@ -490,7 +490,7 @@ define('aurelia-store', ['exports', 'rxjs', 'aurelia-dependency-injection', 'aur
};
Store.prototype.setupDevTools = function () {
var _this = this;
if (aureliaPal.PLATFORM.global.devToolsExtension) {
if (aureliaPal.PLATFORM.global.__REDUX_DEVTOOLS_EXTENSION__) {
this.logger[getLogType(this.options, "devToolsStatus", exports.LogLevel.debug)]("DevTools are available");
this.devToolsAvailable = true;
this.devTools = aureliaPal.PLATFORM.global.__REDUX_DEVTOOLS_EXTENSION__.connect(this.options.devToolsOptions);
Expand Down
166 changes: 4 additions & 162 deletions dist/aurelia-store.d.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { EnhancerOptions } from '@redux-devtools/extension';
import { Container } from 'aurelia-dependency-injection';
import { Logger } from 'aurelia-logging';
import { Observable } from 'rxjs';
Expand Down Expand Up @@ -60,168 +61,9 @@ export interface Action<T = any> {
export interface ActionCreator<T> {
(...args: any[]): T;
}
export interface DevToolsOptions {
/**
* If disable is true, devtools monitoring
* will be disabled in the browser (disallowing a user to see your state using Redux Dev Tools)
*/
disable?: boolean;
/**
* the instance name to be showed on the monitor page. Default value is `document.title`.
* If not specified and there's no document title, it will consist of `tabId` and `instanceId`.
*/
name?: string;
/**
* action creators functions to be available in the Dispatcher.
*/
actionCreators?: ActionCreator<any>[] | {
[key: string]: ActionCreator<any>;
};
/**
* if more than one action is dispatched in the indicated interval, all new actions will be collected and sent at once.
* It is the joint between performance and speed. When set to `0`, all actions will be sent instantly.
* Set it to a higher value when experiencing perf issues (also `maxAge` to a lower value).
*
* @default 500 ms.
*/
latency?: number;
/**
* (> 1) - maximum allowed actions to be stored in the history tree. The oldest actions are removed once maxAge is reached. It's critical for performance.
*
* @default 50
*/
maxAge?: number;
/**
* - `undefined` - will use regular `JSON.stringify` to send data (it's the fast mode).
* - `false` - will handle also circular references.
* - `true` - will handle also date, regex, undefined, error objects, symbols, maps, sets and functions.
* - object, which contains `date`, `regex`, `undefined`, `error`, `symbol`, `map`, `set` and `function` keys.
* For each of them you can indicate if to include (by setting as `true`).
* For `function` key you can also specify a custom function which handles serialization.
* See [`jsan`](https://github.com/kolodny/jsan) for more details.
*/
serialize?: boolean | {
date?: boolean;
regex?: boolean;
undefined?: boolean;
error?: boolean;
symbol?: boolean;
map?: boolean;
set?: boolean;
function?: boolean | Function;
};
/**
* function which takes `action` object and id number as arguments, and should return `action` object back.
*/
actionSanitizer?: <A extends Action>(action: A, id: number) => A;
/**
* function which takes `state` object and index as arguments, and should return `state` object back.
*/
stateSanitizer?: <S>(state: S, index: number) => S;
/**
* *array of strings as regex* - actions types to be hidden / shown in the monitors (while passed to the reducers).
* If `actionsWhitelist` specified, `actionsBlacklist` is ignored.
*/
actionsBlacklist?: string[];
/**
* *array of strings as regex* - actions types to be hidden / shown in the monitors (while passed to the reducers).
* If `actionsWhitelist` specified, `actionsBlacklist` is ignored.
*/
actionsWhitelist?: string[];
/**
* called for every action before sending, takes `state` and `action` object, and returns `true` in case it allows sending the current data to the monitor.
* Use it as a more advanced version of `actionsBlacklist`/`actionsWhitelist` parameters.
*/
predicate?: <S, A extends Action>(state: S, action: A) => boolean;
/**
* if specified as `false`, it will not record the changes till clicking on `Start recording` button.
* Available only for Redux enhancer, for others use `autoPause`.
*
* @default true
*/
shouldRecordChanges?: boolean;
/**
* if specified, whenever clicking on `Pause recording` button and there are actions in the history log, will add this action type.
* If not specified, will commit when paused. Available only for Redux enhancer.
*
* @default "@@PAUSED""
*/
pauseActionType?: string;
/**
* auto pauses when the extension’s window is not opened, and so has zero impact on your app when not in use.
* Not available for Redux enhancer (as it already does it but storing the data to be sent).
*
* @default false
*/
autoPause?: boolean;
/**
* if specified as `true`, it will not allow any non-monitor actions to be dispatched till clicking on `Unlock changes` button.
* Available only for Redux enhancer.
*
* @default false
*/
shouldStartLocked?: boolean;
/**
* if set to `false`, will not recompute the states on hot reloading (or on replacing the reducers). Available only for Redux enhancer.
*
* @default true
*/
shouldHotReload?: boolean;
/**
* if specified as `true`, whenever there's an exception in reducers, the monitors will show the error message, and next actions will not be dispatched.
*
* @default false
*/
shouldCatchErrors?: boolean;
/**
* If you want to restrict the extension, specify the features you allow.
* If not specified, all of the features are enabled. When set as an object, only those included as `true` will be allowed.
* Note that except `true`/`false`, `import` and `export` can be set as `custom` (which is by default for Redux enhancer), meaning that the importing/exporting occurs on the client side.
* Otherwise, you'll get/set the data right from the monitor part.
*/
features?: {
/**
* start/pause recording of dispatched actions
*/
pause?: boolean;
/**
* lock/unlock dispatching actions and side effects
*/
lock?: boolean;
/**
* persist states on page reloading
*/
persist?: boolean;
/**
* export history of actions in a file
*/
export?: boolean | "custom";
/**
* import history of actions from a file
*/
import?: boolean | "custom";
/**
* jump back and forth (time travelling)
*/
jump?: boolean;
/**
* skip (cancel) actions
*/
skip?: boolean;
/**
* drag and drop actions in the history list
*/
reorder?: boolean;
/**
* dispatch custom actions or action creators
*/
dispatch?: boolean;
/**
* generate tests for the selected actions
*/
test?: boolean;
};
}
export declare type DevToolsOptions = import("@redux-devtools/extension").EnhancerOptions | {
disable: boolean;
};
export declare type Reducer<T, P extends any[] = any[]> = (state: T, ...params: P) => T | false | Promise<T | false>;
export declare enum PerformanceMeasurement {
StartEnd = "startEnd",
Expand Down
2 changes: 1 addition & 1 deletion dist/commonjs/aurelia-store.js
Original file line number Diff line number Diff line change
Expand Up @@ -498,7 +498,7 @@ var Store = /** @class */ (function () {
};
Store.prototype.setupDevTools = function () {
var _this = this;
if (aureliaPal.PLATFORM.global.devToolsExtension) {
if (aureliaPal.PLATFORM.global.__REDUX_DEVTOOLS_EXTENSION__) {
this.logger[getLogType(this.options, "devToolsStatus", exports.LogLevel.debug)]("DevTools are available");
this.devToolsAvailable = true;
this.devTools = aureliaPal.PLATFORM.global.__REDUX_DEVTOOLS_EXTENSION__.connect(this.options.devToolsOptions);
Expand Down
2 changes: 1 addition & 1 deletion dist/es2015/aurelia-store.js
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ class Store {
}), state);
}
setupDevTools() {
if (PLATFORM.global.devToolsExtension) {
if (PLATFORM.global.__REDUX_DEVTOOLS_EXTENSION__) {
this.logger[getLogType(this.options, "devToolsStatus", LogLevel.debug)]("DevTools are available");
this.devToolsAvailable = true;
this.devTools = PLATFORM.global.__REDUX_DEVTOOLS_EXTENSION__.connect(this.options.devToolsOptions);
Expand Down
2 changes: 1 addition & 1 deletion dist/es2017/aurelia-store.js
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ class Store {
}, state);
}
setupDevTools() {
if (PLATFORM.global.devToolsExtension) {
if (PLATFORM.global.__REDUX_DEVTOOLS_EXTENSION__) {
this.logger[getLogType(this.options, "devToolsStatus", LogLevel.debug)]("DevTools are available");
this.devToolsAvailable = true;
this.devTools = PLATFORM.global.__REDUX_DEVTOOLS_EXTENSION__.connect(this.options.devToolsOptions);
Expand Down
2 changes: 1 addition & 1 deletion dist/native-modules/aurelia-store.js
Original file line number Diff line number Diff line change
Expand Up @@ -497,7 +497,7 @@ var Store = /** @class */ (function () {
};
Store.prototype.setupDevTools = function () {
var _this = this;
if (PLATFORM.global.devToolsExtension) {
if (PLATFORM.global.__REDUX_DEVTOOLS_EXTENSION__) {
this.logger[getLogType(this.options, "devToolsStatus", LogLevel.debug)]("DevTools are available");
this.devToolsAvailable = true;
this.devTools = PLATFORM.global.__REDUX_DEVTOOLS_EXTENSION__.connect(this.options.devToolsOptions);
Expand Down
2 changes: 1 addition & 1 deletion dist/umd-es2015/aurelia-store.js
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@
}), state);
}
setupDevTools() {
if (aureliaPal.PLATFORM.global.devToolsExtension) {
if (aureliaPal.PLATFORM.global.__REDUX_DEVTOOLS_EXTENSION__) {
this.logger[getLogType(this.options, "devToolsStatus", exports.LogLevel.debug)]("DevTools are available");
this.devToolsAvailable = true;
this.devTools = aureliaPal.PLATFORM.global.__REDUX_DEVTOOLS_EXTENSION__.connect(this.options.devToolsOptions);
Expand Down
2 changes: 1 addition & 1 deletion dist/umd/aurelia-store.js
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,7 @@
};
Store.prototype.setupDevTools = function () {
var _this = this;
if (aureliaPal.PLATFORM.global.devToolsExtension) {
if (aureliaPal.PLATFORM.global.__REDUX_DEVTOOLS_EXTENSION__) {
this.logger[getLogType(this.options, "devToolsStatus", exports.LogLevel.debug)]("DevTools are available");
this.devToolsAvailable = true;
this.devTools = aureliaPal.PLATFORM.global.__REDUX_DEVTOOLS_EXTENSION__.connect(this.options.devToolsOptions);
Expand Down
10 changes: 10 additions & 0 deletions doc/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
<a name="1.7.1"></a>
## [1.7.1](https://github.com/aurelia/store/compare/1.7.0...1.7.1) (2022-02-09)


### Bug Fixes

* **devtools:** drop deprecated window global; use typings from upstream ([6ccae8a](https://github.com/aurelia/store/commit/6ccae8a))



<a name="1.7.0"></a>
# [1.7.0](https://github.com/aurelia/store/compare/1.6.0...1.7.0) (2021-03-27)

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "aurelia-store",
"version": "1.7.0",
"version": "1.7.1",
"description": "Aurelia single state store based on RxJS",
"keywords": [
"aurelia",
Expand Down

0 comments on commit 1991227

Please sign in to comment.