@42.nl/react-flash-messages 2.0.0 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/hooks.js +2 -2
- package/lib/models.d.ts +6 -6
- package/lib/provider.d.ts +1 -1
- package/lib/provider.js +1 -1
- package/lib/service.d.ts +2 -2
- package/package.json +29 -32
- package/CHANGELOG.md +0 -6
package/lib/hooks.js
CHANGED
|
@@ -8,8 +8,8 @@ const service_1 = require("./service");
|
|
|
8
8
|
* flash message store.
|
|
9
9
|
*/
|
|
10
10
|
function useFlashMessages() {
|
|
11
|
-
const [state, setState] = react_1.useState(service_1.flashMessageService.getFlashMessages());
|
|
12
|
-
react_1.useEffect(() => {
|
|
11
|
+
const [state, setState] = (0, react_1.useState)(service_1.flashMessageService.getFlashMessages());
|
|
12
|
+
(0, react_1.useEffect)(() => {
|
|
13
13
|
const subscriber = (nextState) => {
|
|
14
14
|
setState(nextState);
|
|
15
15
|
};
|
package/lib/models.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export
|
|
1
|
+
export type OnFlashMessageClicked<Data> = (flashMessage: FlashMessage<Data>) => void;
|
|
2
2
|
/**
|
|
3
3
|
* The reason a flash message was removed.
|
|
4
4
|
*
|
|
@@ -7,13 +7,13 @@ export declare type OnFlashMessageClicked<Data> = (flashMessage: FlashMessage<Da
|
|
|
7
7
|
* it is 'manually-removed' it was because the `removeFlashMessage`
|
|
8
8
|
* action was called.
|
|
9
9
|
*/
|
|
10
|
-
export
|
|
11
|
-
export
|
|
10
|
+
export type FlashMessageRemovedReason = 'duration-elapsed' | 'manually-removed';
|
|
11
|
+
export type OnFlashMessageRemoved<Data> = (flashMessage: FlashMessage<Data>, reason: FlashMessageRemovedReason) => void;
|
|
12
12
|
/**
|
|
13
13
|
* Represents a FlashMessage as it will be represented in the
|
|
14
14
|
* flashMessageService.
|
|
15
15
|
*/
|
|
16
|
-
export
|
|
16
|
+
export type FlashMessage<Data> = {
|
|
17
17
|
/**
|
|
18
18
|
* The id of the flashMessage must be unique for each flash message.
|
|
19
19
|
*/
|
|
@@ -77,7 +77,7 @@ export declare type FlashMessage<Data> = {
|
|
|
77
77
|
* creating a the FlashMessage from the FlashMessageConfig and they
|
|
78
78
|
* will be re-written.
|
|
79
79
|
*/
|
|
80
|
-
export
|
|
80
|
+
export type FlashMessageConfig<Data> = {
|
|
81
81
|
/**
|
|
82
82
|
* The type of flash message, can be useful to distinguish
|
|
83
83
|
* between types of messages. For example you might have a type
|
|
@@ -119,7 +119,7 @@ export declare type FlashMessageConfig<Data> = {
|
|
|
119
119
|
* etc etc, so the developer can quickly spawn flash messages without
|
|
120
120
|
* resorting to the more low level `addFlashMessage` action.
|
|
121
121
|
*/
|
|
122
|
-
export
|
|
122
|
+
export type FlashMessageCreatorConfig<Data> = {
|
|
123
123
|
/**
|
|
124
124
|
* The text message you want to show to the user.
|
|
125
125
|
*/
|
package/lib/provider.d.ts
CHANGED
package/lib/provider.js
CHANGED
|
@@ -16,7 +16,7 @@ exports.FlashMessagesContext = react_1.default.createContext(service_1.flashMess
|
|
|
16
16
|
* @param children The children to render
|
|
17
17
|
*/
|
|
18
18
|
function FlashMessagesProvider({ children }) {
|
|
19
|
-
const flashMessages = hooks_1.useFlashMessages();
|
|
19
|
+
const flashMessages = (0, hooks_1.useFlashMessages)();
|
|
20
20
|
return (react_1.default.createElement(exports.FlashMessagesContext.Provider, { value: flashMessages }, children));
|
|
21
21
|
}
|
|
22
22
|
exports.FlashMessagesProvider = FlashMessagesProvider;
|
package/lib/service.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { FlashMessage, FlashMessageRemovedReason } from './models';
|
|
2
|
-
export
|
|
3
|
-
export
|
|
2
|
+
export type Subscriber = (flashMessages: FlashMessage<unknown>[]) => void;
|
|
3
|
+
export type FlashMessageService = {
|
|
4
4
|
addFlashMessage(flashMessage: FlashMessage<unknown>): void;
|
|
5
5
|
removeFlashMessage(flashMessage: FlashMessage<unknown>, reason: FlashMessageRemovedReason): void;
|
|
6
6
|
clearFlashMessages(): void;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@42.nl/react-flash-messages",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.2",
|
|
4
4
|
"description": "Storing flash messages via a nice api for use with React.",
|
|
5
5
|
"files": [
|
|
6
6
|
"lib"
|
|
@@ -21,29 +21,29 @@
|
|
|
21
21
|
},
|
|
22
22
|
"homepage": "https://github.com/42BV/flash-messages#readme",
|
|
23
23
|
"devDependencies": {
|
|
24
|
-
"@testing-library/
|
|
25
|
-
"@testing-library/
|
|
26
|
-
"@types/jest": "
|
|
27
|
-
"@types/react": "
|
|
28
|
-
"@types/react-dom": "
|
|
29
|
-
"@typescript-eslint/eslint-plugin": "
|
|
30
|
-
"@typescript-eslint/parser": "
|
|
31
|
-
"eslint": "
|
|
32
|
-
"eslint-config-react-app": "
|
|
33
|
-
"eslint-plugin-jest": "
|
|
34
|
-
"eslint-plugin-react": "7.
|
|
35
|
-
"eslint-plugin-react-hooks": "4.
|
|
36
|
-
"
|
|
37
|
-
"jest
|
|
38
|
-
"
|
|
39
|
-
"
|
|
40
|
-
"
|
|
41
|
-
"
|
|
42
|
-
"
|
|
43
|
-
"react": "
|
|
44
|
-
"react-
|
|
45
|
-
"
|
|
46
|
-
"
|
|
24
|
+
"@testing-library/jest-dom": "5.16.5",
|
|
25
|
+
"@testing-library/react": "14.0.0",
|
|
26
|
+
"@types/jest": "29.4.0",
|
|
27
|
+
"@types/react": "18.0.28",
|
|
28
|
+
"@types/react-dom": "18.0.11",
|
|
29
|
+
"@typescript-eslint/eslint-plugin": "5.52.0",
|
|
30
|
+
"@typescript-eslint/parser": "5.52.0",
|
|
31
|
+
"eslint": "8.34.0",
|
|
32
|
+
"eslint-config-react-app": "7.0.1",
|
|
33
|
+
"eslint-plugin-jest": "27.2.1",
|
|
34
|
+
"eslint-plugin-react": "7.32.2",
|
|
35
|
+
"eslint-plugin-react-hooks": "4.6.0",
|
|
36
|
+
"husky": "8.0.3",
|
|
37
|
+
"jest": "29.4.3",
|
|
38
|
+
"jest-environment-jsdom": "^29.4.3",
|
|
39
|
+
"jest-watch-typeahead": "2.2.2",
|
|
40
|
+
"lint-staged": "13.1.2",
|
|
41
|
+
"np": "^7.6.3",
|
|
42
|
+
"prettier": "2.8.4",
|
|
43
|
+
"react": "18.2.0",
|
|
44
|
+
"react-dom": "18.2.0",
|
|
45
|
+
"ts-jest": "29.0.5",
|
|
46
|
+
"typescript": "4.9.5"
|
|
47
47
|
},
|
|
48
48
|
"scripts": {
|
|
49
49
|
"start": "jest --watch --coverage",
|
|
@@ -56,9 +56,10 @@
|
|
|
56
56
|
"lint": "npm run lint:test && npm run lint:src",
|
|
57
57
|
"lint:test": "eslint \"tests/**\" --max-warnings=0",
|
|
58
58
|
"lint:src": "eslint \"src/**\" --max-warnings=0",
|
|
59
|
-
"release": "npm run tsc && np
|
|
59
|
+
"release": "npm run tsc && np",
|
|
60
60
|
"dev:publish": "./scripts/dev-publish.sh",
|
|
61
|
-
"version": "npm run tsc && jekyll build"
|
|
61
|
+
"version": "npm run tsc && jekyll build",
|
|
62
|
+
"prepare": "husky install"
|
|
62
63
|
},
|
|
63
64
|
"jest": {
|
|
64
65
|
"preset": "ts-jest",
|
|
@@ -81,16 +82,12 @@
|
|
|
81
82
|
"watchPlugins": [
|
|
82
83
|
"jest-watch-typeahead/filename",
|
|
83
84
|
"jest-watch-typeahead/testname"
|
|
84
|
-
]
|
|
85
|
+
],
|
|
86
|
+
"testEnvironment": "jsdom"
|
|
85
87
|
},
|
|
86
88
|
"lint-staged": {
|
|
87
89
|
"{src,test}/**/*.{js,jsx,json,scss,tsx,ts}": [
|
|
88
90
|
"prettier --single-quote --trailing-comma none --write"
|
|
89
91
|
]
|
|
90
|
-
},
|
|
91
|
-
"husky": {
|
|
92
|
-
"hooks": {
|
|
93
|
-
"pre-commit": "lint-staged"
|
|
94
|
-
}
|
|
95
92
|
}
|
|
96
93
|
}
|