@slickgrid-universal/rxjs-observable 1.1.0 → 1.2.3
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/LICENSE +1 -1
- package/README.md +56 -56
- package/package.json +11 -11
- package/CHANGELOG.md +0 -135
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -1,56 +1,56 @@
|
|
|
1
|
-
[](https://opensource.org/licenses/MIT)
|
|
2
|
-
[](http://www.typescriptlang.org/)
|
|
3
|
-
[](https://www.npmjs.com/package/@slickgrid-universal/rxjs-observable)
|
|
5
|
-
[](https://www.npmjs.com/package/@slickgrid-universal/rxjs-observable)
|
|
6
|
-
|
|
7
|
-
[](https://github.com/ghiscoding/slickgrid-universal/actions)
|
|
8
|
-
[](https://www.cypress.io/)
|
|
9
|
-
[](https://github.com/facebook/jest)
|
|
10
|
-
[](https://codecov.io/gh/ghiscoding/slickgrid-universal)
|
|
11
|
-
|
|
12
|
-
## RxJS Observable Service Wrapper
|
|
13
|
-
#### @slickgrid-universal/rxjs-observable
|
|
14
|
-
|
|
15
|
-
An RxJS Observable Service Wrapper to make it possible to use RxJS with Slickgrid-Universal (with a Backend Service like OData/GraphQL). By default any Backend Service will be using Promises unless we use this RxJS Observable package.
|
|
16
|
-
|
|
17
|
-
This package is simply a bridge, a facade, to make it possible to use RxJS without adding RxJS to the `@slickgrid-universal/common` list of dependencies, so RxJS is a dependency of this package without being a dependency of the common (core) package, This will avoid adding dependencies not everyone need and won't clutter the common package (the common package will simply use an empty interface, which won't do anything, without requiring to install RxJS at all. We
|
|
18
|
-
|
|
19
|
-
### Internal Dependencies
|
|
20
|
-
- [@slickgrid-universal/common](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/common)
|
|
21
|
-
|
|
22
|
-
### External Dependencies
|
|
23
|
-
- [RxJS 7+](https://github.com/ReactiveX/RxJS)
|
|
24
|
-
|
|
25
|
-
### Installation
|
|
26
|
-
Follow the instruction provided in the main [README](https://github.com/ghiscoding/slickgrid-universal#installation), you can see a demo by looking at the [GitHub Demo](https://ghiscoding.github.io/slickgrid-universal) page.
|
|
27
|
-
|
|
28
|
-
### Usage
|
|
29
|
-
In order to use the Service, you will need to register it in your grid options via the `registerExternalResources` as shown below and of course install RxJS itself (this package requires [RxJS 7](https://github.com/ReactiveX/RxJS)).
|
|
30
|
-
|
|
31
|
-
##### ViewModel
|
|
32
|
-
```ts
|
|
33
|
-
import { GridOdataService } from '@slickgrid-universal/odata';
|
|
34
|
-
import { RxJsResource } from '@slickgrid-universal/rxjs-observable';
|
|
35
|
-
|
|
36
|
-
export class MyExample {
|
|
37
|
-
gridOptions: GridOption;
|
|
38
|
-
|
|
39
|
-
initializeGrid {
|
|
40
|
-
this.gridOptions = {
|
|
41
|
-
// you will most probably use it with a Backend Service, for example with OData or GraphQL
|
|
42
|
-
backendServiceApi: {
|
|
43
|
-
service: new GridOdataService(),
|
|
44
|
-
preProcess: () => this.displaySpinner(true),
|
|
45
|
-
postProcess: () => this.displaySpinner(false),
|
|
46
|
-
|
|
47
|
-
// assuming your Http call is with an RxJS Observable
|
|
48
|
-
process: (query) => this.getAllCustomers$(query),
|
|
49
|
-
} as OdataServiceApi,
|
|
50
|
-
|
|
51
|
-
// ...
|
|
52
|
-
registerExternalResources: [new RxJsResource()],
|
|
53
|
-
};
|
|
54
|
-
}
|
|
55
|
-
}
|
|
56
|
-
```
|
|
1
|
+
[](https://opensource.org/licenses/MIT)
|
|
2
|
+
[](http://www.typescriptlang.org/)
|
|
3
|
+
[](https://github.com/ghiscoding/lerna-lite)
|
|
4
|
+
[](https://www.npmjs.com/package/@slickgrid-universal/rxjs-observable)
|
|
5
|
+
[](https://www.npmjs.com/package/@slickgrid-universal/rxjs-observable)
|
|
6
|
+
|
|
7
|
+
[](https://github.com/ghiscoding/slickgrid-universal/actions)
|
|
8
|
+
[](https://www.cypress.io/)
|
|
9
|
+
[](https://github.com/facebook/jest)
|
|
10
|
+
[](https://codecov.io/gh/ghiscoding/slickgrid-universal)
|
|
11
|
+
|
|
12
|
+
## RxJS Observable Service Wrapper
|
|
13
|
+
#### @slickgrid-universal/rxjs-observable
|
|
14
|
+
|
|
15
|
+
An RxJS Observable Service Wrapper to make it possible to use RxJS with Slickgrid-Universal (with a Backend Service like OData/GraphQL). By default any Backend Service will be using Promises unless we use this RxJS Observable package.
|
|
16
|
+
|
|
17
|
+
This package is simply a bridge, a facade, to make it possible to use RxJS without adding RxJS to the `@slickgrid-universal/common` list of dependencies, so RxJS is a dependency of this package without being a dependency of the common (core) package, This will avoid adding dependencies not everyone need and won't clutter the common package (the common package will simply use an empty interface, which won't do anything, without requiring to install RxJS at all. We also have full unit tests coverage for all of that).
|
|
18
|
+
|
|
19
|
+
### Internal Dependencies
|
|
20
|
+
- [@slickgrid-universal/common](https://github.com/ghiscoding/slickgrid-universal/tree/master/packages/common)
|
|
21
|
+
|
|
22
|
+
### External Dependencies
|
|
23
|
+
- [RxJS 7+](https://github.com/ReactiveX/RxJS)
|
|
24
|
+
|
|
25
|
+
### Installation
|
|
26
|
+
Follow the instruction provided in the main [README](https://github.com/ghiscoding/slickgrid-universal#installation), you can see a demo by looking at the [GitHub Demo](https://ghiscoding.github.io/slickgrid-universal) page.
|
|
27
|
+
|
|
28
|
+
### Usage
|
|
29
|
+
In order to use the Service, you will need to register it in your grid options via the `registerExternalResources` as shown below and of course install RxJS itself (this package requires [RxJS 7](https://github.com/ReactiveX/RxJS)).
|
|
30
|
+
|
|
31
|
+
##### ViewModel
|
|
32
|
+
```ts
|
|
33
|
+
import { GridOdataService } from '@slickgrid-universal/odata';
|
|
34
|
+
import { RxJsResource } from '@slickgrid-universal/rxjs-observable';
|
|
35
|
+
|
|
36
|
+
export class MyExample {
|
|
37
|
+
gridOptions: GridOption;
|
|
38
|
+
|
|
39
|
+
initializeGrid {
|
|
40
|
+
this.gridOptions = {
|
|
41
|
+
// you will most probably use it with a Backend Service, for example with OData or GraphQL
|
|
42
|
+
backendServiceApi: {
|
|
43
|
+
service: new GridOdataService(),
|
|
44
|
+
preProcess: () => this.displaySpinner(true),
|
|
45
|
+
postProcess: () => this.displaySpinner(false),
|
|
46
|
+
|
|
47
|
+
// assuming your Http call is with an RxJS Observable
|
|
48
|
+
process: (query) => this.getAllCustomers$(query),
|
|
49
|
+
} as OdataServiceApi,
|
|
50
|
+
|
|
51
|
+
// ...
|
|
52
|
+
registerExternalResources: [new RxJsResource()],
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@slickgrid-universal/rxjs-observable",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.2.3",
|
|
4
4
|
"description": "RxJS Observable Wrapper",
|
|
5
5
|
"main": "dist/commonjs/index.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|
|
@@ -14,14 +14,14 @@
|
|
|
14
14
|
],
|
|
15
15
|
"scripts": {
|
|
16
16
|
"build": "cross-env tsc --build",
|
|
17
|
-
"postbuild": "npm-run-all bundle:commonjs",
|
|
17
|
+
"postbuild": "npm-run-all bundle:commonjs --npm-path npm",
|
|
18
18
|
"build:watch": "cross-env tsc --incremental --watch",
|
|
19
|
-
"dev": "run
|
|
20
|
-
"dev:watch": "run-p build:watch",
|
|
21
|
-
"bundle": "run-p bundle:commonjs bundle:esm",
|
|
19
|
+
"dev": "npm run build",
|
|
20
|
+
"dev:watch": "run-p build:watch --npm-path npm",
|
|
21
|
+
"bundle": "run-p bundle:commonjs bundle:esm --npm-path npm",
|
|
22
22
|
"bundle:commonjs": "tsc --project tsconfig.bundle.json --outDir dist/commonjs --module commonjs",
|
|
23
23
|
"bundle:esm": "cross-env tsc --project tsconfig.bundle.json --outDir dist/esm --module esnext --target es2018",
|
|
24
|
-
"prebundle": "npm-run-all delete:dist",
|
|
24
|
+
"prebundle": "npm-run-all delete:dist --npm-path npm",
|
|
25
25
|
"delete:dist": "cross-env rimraf --maxBusyTries=10 dist",
|
|
26
26
|
"package:add-browser-prop": "cross-env node ../change-package-browser.js --add-browser=true --folder-name=rxjs-observable",
|
|
27
27
|
"package:remove-browser-prop": "cross-env node ../change-package-browser.js --remove-browser=true --folder-name=rxjs-observable"
|
|
@@ -38,8 +38,8 @@
|
|
|
38
38
|
"url": "https://github.com/ghiscoding/slickgrid-universal/issues"
|
|
39
39
|
},
|
|
40
40
|
"engines": {
|
|
41
|
-
"node": ">=
|
|
42
|
-
"npm": ">=
|
|
41
|
+
"node": ">=16.11.0",
|
|
42
|
+
"npm": ">=8.0.0"
|
|
43
43
|
},
|
|
44
44
|
"browserslist": [
|
|
45
45
|
"last 2 version",
|
|
@@ -47,13 +47,13 @@
|
|
|
47
47
|
"not dead"
|
|
48
48
|
],
|
|
49
49
|
"dependencies": {
|
|
50
|
-
"@slickgrid-universal/common": "^
|
|
51
|
-
"rxjs": "^7.
|
|
50
|
+
"@slickgrid-universal/common": "^1.2.3",
|
|
51
|
+
"rxjs": "^7.5.2"
|
|
52
52
|
},
|
|
53
53
|
"devDependencies": {
|
|
54
54
|
"cross-env": "^7.0.3",
|
|
55
55
|
"npm-run-all": "^4.1.5",
|
|
56
56
|
"rimraf": "^3.0.2"
|
|
57
57
|
},
|
|
58
|
-
"gitHead": "
|
|
58
|
+
"gitHead": "8f9a87cfe68f6e1d6e196114cdf798065b823d01"
|
|
59
59
|
}
|
package/CHANGELOG.md
DELETED
|
@@ -1,135 +0,0 @@
|
|
|
1
|
-
# Change Log
|
|
2
|
-
|
|
3
|
-
All notable changes to this project will be documented in this file.
|
|
4
|
-
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
|
-
|
|
6
|
-
# [1.1.0](https://github.com/ghiscoding/slickgrid-universal/compare/v0.19.2...v1.1.0) (2021-12-11)
|
|
7
|
-
|
|
8
|
-
**Note:** Version bump only for package @slickgrid-universal/rxjs-observable
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
## [0.19.2](https://github.com/ghiscoding/slickgrid-universal/compare/v0.19.1...v0.19.2) (2021-11-19)
|
|
16
|
-
|
|
17
|
-
**Note:** Version bump only for package @slickgrid-universal/rxjs-observable
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
## [0.19.1](https://github.com/ghiscoding/slickgrid-universal/compare/v0.19.0...v0.19.1) (2021-11-15)
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
### Bug Fixes
|
|
28
|
-
|
|
29
|
-
* **build:** typo on script package name to rename ([76cee09](https://github.com/ghiscoding/slickgrid-universal/commit/76cee094f4ef771ebfdb79386c3e8577f89d397e))
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
# [0.19.0](https://github.com/ghiscoding/slickgrid-universal/compare/v0.18.0...v0.19.0) (2021-10-28)
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
### Features
|
|
40
|
-
|
|
41
|
-
* add async process to use with Promise/Observable ([7350a6d](https://github.com/ghiscoding/slickgrid-universal/commit/7350a6d06ef5bb8495a05e22421f9b7b5a4270cb))
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
# [0.18.0](https://github.com/ghiscoding/slickgrid-universal/compare/v0.17.0...v0.18.0) (2021-09-29)
|
|
49
|
-
|
|
50
|
-
**Note:** Version bump only for package @slickgrid-universal/rxjs-observable
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
# [0.17.0](https://github.com/ghiscoding/slickgrid-universal/compare/v0.16.2...v0.17.0) (2021-09-09)
|
|
58
|
-
|
|
59
|
-
**Note:** Version bump only for package @slickgrid-universal/rxjs-observable
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
## [0.16.2](https://github.com/ghiscoding/slickgrid-universal/compare/v0.16.1...v0.16.2) (2021-07-23)
|
|
66
|
-
|
|
67
|
-
**Note:** Version bump only for package @slickgrid-universal/rxjs-observable
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
## [0.16.1](https://github.com/ghiscoding/slickgrid-universal/compare/v0.16.0...v0.16.1) (2021-07-16)
|
|
74
|
-
|
|
75
|
-
**Note:** Version bump only for package @slickgrid-universal/rxjs-observable
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
# [0.16.0](https://github.com/ghiscoding/slickgrid-universal/compare/v0.15.0...v0.16.0) (2021-07-16)
|
|
82
|
-
|
|
83
|
-
**Note:** Version bump only for package @slickgrid-universal/rxjs-observable
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
# [0.15.0](https://github.com/ghiscoding/slickgrid-universal/compare/v0.14.1...v0.15.0) (2021-07-06)
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
### Bug Fixes
|
|
93
|
-
|
|
94
|
-
* **build:** the "files" property should be included in pkg.json ([3d8f12e](https://github.com/ghiscoding/slickgrid-universal/commit/3d8f12e5f55079445c6fb5cde767f8e0b4511ebb))
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
## [0.14.1](https://github.com/ghiscoding/slickgrid-universal/compare/v0.14.0...v0.14.1) (2021-05-22)
|
|
102
|
-
|
|
103
|
-
**Note:** Version bump only for package @slickgrid-universal/rxjs-observable
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
# [0.14.0](https://github.com/ghiscoding/slickgrid-universal/compare/v0.13.0...v0.14.0) (2021-05-22)
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
### Bug Fixes
|
|
113
|
-
|
|
114
|
-
* **frozen:** rollback previous commit since the issue was found in SlickGrid (core) ([780bcd7](https://github.com/ghiscoding/slickgrid-universal/commit/780bcd7bfae35e26cd84c9a6d220e2dab9eca3b4))
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
# [0.13.0](https://github.com/ghiscoding/slickgrid-universal/compare/v0.12.0...v0.13.0) (2021-04-27)
|
|
122
|
-
|
|
123
|
-
**Note:** Version bump only for package @slickgrid-universal/rxjs-observable
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
# [0.12.0](https://github.com/ghiscoding/slickgrid-universal/compare/v0.11.2...v0.12.0) (2021-03-24)
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
### Features
|
|
134
|
-
|
|
135
|
-
* **resources:** add RxJS support into Slickgrid-Universal via external package ([#280](https://github.com/ghiscoding/slickgrid-universal/issues/280)) ([c10fc33](https://github.com/ghiscoding/slickgrid-universal/commit/c10fc339019c04ec0f7c4357ccdb3949a2358460))
|