cdsclient-lib 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. package/LICENSE +205 -0
  2. package/README.md +198 -0
  3. package/package.json +56 -0
package/LICENSE ADDED
@@ -0,0 +1,205 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+
8
+ Copyright (C) 2019-2025 Rajdeep Rath (Cloudisense-core - cdscore).This library is intended for use solely within the Cloudisense program and its supporting codebases.
9
+
10
+
11
+ 1. Definitions
12
+
13
+ "License" shall mean the terms and conditions for use, reproduction,
14
+ and distribution as defined by Sections 1 through 9 of this document.
15
+
16
+ "Licensor" shall mean the copyright owner or entity authorized by
17
+ the copyright owner that is granting the License.
18
+
19
+ "Legal Entity" shall mean the union of the acting entity and all
20
+ other entities that control, are controlled by, or are under common
21
+ control with that entity. For the purposes of this definition,
22
+ "control" means (i) the power, direct or indirect, to cause the
23
+ direction or management of such entity, whether by contract or
24
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
25
+ outstanding shares, or (iii) beneficial ownership of such entity.
26
+
27
+ "You" (or "Your") shall mean an individual or Legal Entity
28
+ exercising permissions granted by this License.
29
+
30
+ "Source" form shall mean the preferred form for making modifications,
31
+ including but not limited to software source code, documentation
32
+ source, and configuration files.
33
+
34
+ "Object" form shall mean any form resulting from mechanical
35
+ transformation or translation of a Source form, including but
36
+ not limited to compiled object code, generated documentation,
37
+ and conversions to other media types.
38
+
39
+ "Work" shall mean the work of authorship, whether in Source or
40
+ Object form, made available under the License, as indicated by a
41
+ copyright notice that is included in or attached to the work
42
+ (an example is provided in the Appendix below).
43
+
44
+ "Derivative Works" shall mean any work, whether in Source or Object
45
+ form, that is based on (or derived from) the Work and for which the
46
+ editorial revisions, annotations, elaborations, or other modifications
47
+ represent, as a whole, an original work of authorship. For the purposes
48
+ of this License, Derivative Works shall not include works that remain
49
+ separable from, or merely link (or bind by name) to the interfaces of,
50
+ the Work and Derivative Works thereof.
51
+
52
+ "Contribution" shall mean any work of authorship, including
53
+ the original version of the Work and any modifications or additions
54
+ to that Work or Derivative Works thereof, that is intentionally
55
+ submitted to Licensor for inclusion in the Work by the copyright owner
56
+ or by an individual or Legal Entity authorized to submit on behalf of
57
+ the copyright owner. For the purposes of this definition, "submitted"
58
+ means any form of electronic, verbal, or written communication sent
59
+ to the Licensor or its representatives, including but not limited to
60
+ communication on electronic mailing lists, source code control systems,
61
+ and issue tracking systems that are managed by, or on behalf of, the
62
+ Licensor for the purpose of discussing and improving the Work, but
63
+ excluding communication that is conspicuously marked or otherwise
64
+ designated in writing by the copyright owner as "Not a Contribution."
65
+
66
+ "Contributor" shall mean Licensor and any individual or Legal Entity
67
+ on behalf of whom a Contribution has been received by Licensor and
68
+ subsequently incorporated within the Work.
69
+
70
+ 2. Grant of Copyright License. Subject to the terms and conditions of
71
+ this License, each Contributor hereby grants to You a perpetual,
72
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
73
+ copyright license to reproduce, prepare Derivative Works of,
74
+ publicly display, publicly perform, sublicense, and distribute the
75
+ Work and such Derivative Works in Source or Object form.
76
+
77
+ 3. Grant of Patent License. Subject to the terms and conditions of
78
+ this License, each Contributor hereby grants to You a perpetual,
79
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
80
+ (except as stated in this section) patent license to make, have made,
81
+ use, offer to sell, sell, import, and otherwise transfer the Work,
82
+ where such license applies only to those patent claims licensable
83
+ by such Contributor that are necessarily infringed by their
84
+ Contribution(s) alone or by combination of their Contribution(s)
85
+ with the Work to which such Contribution(s) was submitted. If You
86
+ institute patent litigation against any entity (including a
87
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
88
+ or a Contribution incorporated within the Work constitutes direct
89
+ or contributory patent infringement, then any patent licenses
90
+ granted to You under this License for that Work shall terminate
91
+ as of the date such litigation is filed.
92
+
93
+ 4. Redistribution. You may reproduce and distribute copies of the
94
+ Work or Derivative Works thereof in any medium, with or without
95
+ modifications, and in Source or Object form, provided that You
96
+ meet the following conditions:
97
+
98
+ (a) You must give any other recipients of the Work or
99
+ Derivative Works a copy of this License; and
100
+
101
+ (b) You must cause any modified files to carry prominent notices
102
+ stating that You changed the files; and
103
+
104
+ (c) You must retain, in the Source form of any Derivative Works
105
+ that You distribute, all copyright, patent, trademark, and
106
+ attribution notices from the Source form of the Work,
107
+ excluding those notices that do not pertain to any part of
108
+ the Derivative Works; and
109
+
110
+ (d) If the Work includes a "NOTICE" text file as part of its
111
+ distribution, then any Derivative Works that You distribute must
112
+ include a readable copy of the attribution notices contained
113
+ within such NOTICE file, excluding those notices that do not
114
+ pertain to any part of the Derivative Works, in at least one
115
+ of the following places: within a NOTICE text file distributed
116
+ as part of the Derivative Works; within the Source form or
117
+ documentation, if provided along with the Derivative Works; or,
118
+ within a display generated by the Derivative Works, if and
119
+ wherever such third-party notices normally appear. The contents
120
+ of the NOTICE file are for informational purposes only and
121
+ do not modify the License. You may add Your own attribution
122
+ notices within Derivative Works that You distribute, alongside
123
+ or as an addendum to the NOTICE text from the Work, provided
124
+ that such additional attribution notices cannot be construed
125
+ as modifying the License.
126
+
127
+ You may add Your own copyright statement to Your modifications and
128
+ may provide additional or different license terms and conditions
129
+ for use, reproduction, or distribution of Your modifications, or
130
+ for any such Derivative Works as a whole, provided Your use,
131
+ reproduction, and distribution of the Work otherwise complies with
132
+ the conditions stated in this License.
133
+
134
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
135
+ any Contribution intentionally submitted for inclusion in the Work
136
+ by You to the Licensor shall be under the terms and conditions of
137
+ this License, without any additional terms or conditions.
138
+ Notwithstanding the above, nothing herein shall supersede or modify
139
+ the terms of any separate license agreement you may have executed
140
+ with Licensor regarding such Contributions.
141
+
142
+ 6. Trademarks. This License does not grant permission to use the trade
143
+ names, trademarks, service marks, or product names of the Licensor,
144
+ except as required for reasonable and customary use in describing the
145
+ origin of the Work and reproducing the content of the NOTICE file.
146
+
147
+ 7. Disclaimer of Warranty. Unless required by applicable law or
148
+ agreed to in writing, Licensor provides the Work (and each
149
+ Contributor provides its Contributions) on an "AS IS" BASIS,
150
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
151
+ implied, including, without limitation, any warranties or conditions
152
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
153
+ PARTICULAR PURPOSE. You are solely responsible for determining the
154
+ appropriateness of using or redistributing the Work and assume any
155
+ risks associated with Your exercise of permissions under this License.
156
+
157
+ 8. Limitation of Liability. In no event and under no legal theory,
158
+ whether in tort (including negligence), contract, or otherwise,
159
+ unless required by applicable law (such as deliberate and grossly
160
+ negligent acts) or agreed to in writing, shall any Contributor be
161
+ liable to You for damages, including any direct, indirect, special,
162
+ incidental, or consequential damages of any character arising as a
163
+ result of this License or out of the use or inability to use the
164
+ Work (including but not limited to damages for loss of goodwill,
165
+ work stoppage, computer failure or malfunction, or any and all
166
+ other commercial damages or losses), even if such Contributor
167
+ has been advised of the possibility of such damages.
168
+
169
+ 9. Accepting Warranty or Additional Liability. While redistributing
170
+ the Work or Derivative Works thereof, You may choose to offer,
171
+ and charge a fee for, acceptance of support, warranty, indemnity,
172
+ or other liability obligations and/or rights consistent with this
173
+ License. However, in accepting such obligations, You may act only
174
+ on Your own behalf and on Your sole responsibility, not on behalf
175
+ of any other Contributor, and only if You agree to indemnify,
176
+ defend, and hold each Contributor harmless for any liability
177
+ incurred by, or claims asserted against, such Contributor by reason
178
+ of your accepting any such warranty or additional liability.
179
+
180
+ END OF TERMS AND CONDITIONS
181
+
182
+ APPENDIX: How to apply the Apache License to your work.
183
+
184
+ To apply the Apache License to your work, attach the following
185
+ boilerplate notice, with the fields enclosed by brackets "[]"
186
+ replaced with your own identifying information. (Don't include
187
+ the brackets!) The text should be enclosed in the appropriate
188
+ comment syntax for the file format. We also recommend that a
189
+ file or class name and description of purpose be included on the
190
+ same "printed page" as the copyright notice for easier
191
+ identification within third-party archives.
192
+
193
+ Copyright [yyyy] [name of copyright owner]
194
+
195
+ Licensed under the Apache License, Version 2.0 (the "License");
196
+ you may not use this file except in compliance with the License.
197
+ You may obtain a copy of the License at
198
+
199
+ http://www.apache.org/licenses/LICENSE-2.0
200
+
201
+ Unless required by applicable law or agreed to in writing, software
202
+ distributed under the License is distributed on an "AS IS" BASIS,
203
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
204
+ See the License for the specific language governing permissions and
205
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,198 @@
1
+ # Cloudisense API Library
2
+
3
+ ## ABOUT
4
+ ---
5
+
6
+ This library provides convenient access to the cloudisense backend service. It encapsulates communication mechanism for cloudisense's REST API as well as Real-time communication API.
7
+
8
+ This library is for use with the cloudisense frontend React project.
9
+
10
+
11
+ ## Usage
12
+ ---
13
+
14
+ The following code snippet from the react-redux project demonstrates how connection is established to service from client.
15
+
16
+ ### Main Authentication Function
17
+
18
+ ```javascript
19
+ var password_hash = sha256.create();
20
+ password_hash.update(password);
21
+ password_hash.hex();
22
+
23
+ var bodyFormData = new FormData();
24
+ bodyFormData.append('username', username);
25
+ bodyFormData.append('password', password_hash.hex());
26
+
27
+ axios({
28
+ method: "post",
29
+ url: "http://localhost:8000/authorize",
30
+ data: bodyFormData,
31
+ headers: { "Content-Type": "multipart/form-data" },
32
+ })
33
+ .then((response) => {
34
+
35
+ if (response.data) {
36
+ if (response.data.status == "success" && response.data.code == 200) {
37
+ if (rememberUser) {
38
+ localStorage.setItem(LAST_USER_KEY, username)
39
+ } else {
40
+ localStorage.removeItem(LAST_USER_KEY)
41
+ }
42
+
43
+ const authData = response.data.data;
44
+ localStorage.setItem(AUTH_DATA_KEY, JSON.stringify(authData))
45
+ initializeSocketClient(dispatch, authData).then((client) => {
46
+ client.connectWithAuthData(authData).then(() => {
47
+ connection_ready_timeout = setTimeout(() => {
48
+ on_connection_state_complete(client, dispatch)
49
+ }, 2000);
50
+
51
+ }).catch((err) => {
52
+ console.log(err)
53
+ dispatch(authFail(err))
54
+ })
55
+ })
56
+ .catch((error) => {
57
+ console.log("error initializing socket client")
58
+ dispatch(authFail("error initializing socket client"))
59
+ });
60
+ }
61
+ else {
62
+ dispatch(authFail(response.data.data));
63
+ }
64
+ }
65
+ else {
66
+ dispatch(authFail("Unknown Error"));
67
+ }
68
+ })
69
+ .catch((error) => {
70
+ dispatch(authFail(error.message));
71
+ });
72
+ ```
73
+
74
+ ### The `initializeSocketClient` Function
75
+
76
+
77
+
78
+ ```javascript
79
+ const initializeSocketClient = (dispatch, data) => {
80
+
81
+ return new Promise(function (resolve, reject) {
82
+
83
+ const client = new cloudisenseApiClient({
84
+ host: "localhost",
85
+ port: 8000,
86
+ reconnectOnFailure: false,
87
+ authdata: plainToInstance(AuthData, data)
88
+ });
89
+
90
+
91
+ client.onTextNotification.subscribe((evt) => {
92
+ switch (evt.type) {
93
+ case EventType.DATANOTIFICATION:
94
+ case EventType.NOTIFICATION:
95
+ dispatch(notificationReceived(evt))
96
+ break;
97
+ }
98
+ });
99
+
100
+
101
+ client.onUIEvent.subscribe((evt) => {
102
+ switch (evt.topic) {
103
+ case TOPIC_UI_INITIALIZATION:
104
+ subscribe_to_ui_updates(client, dispatch)
105
+ .then((result) => {
106
+ dispatch(uiUpdatesSubscribeSuccess(result))
107
+ on_connection_state_complete(client, dispatch, evt.data);
108
+ })
109
+ .catch((err) => {
110
+ dispatch(uiUpdatesSubscribeFailed(err))
111
+ });
112
+ break;
113
+ }
114
+ });
115
+
116
+
117
+
118
+ client.onClientStateUpdate.subscribe((stateObj) => {
119
+ switch (stateObj.state) {
120
+ case ClientStateType.CONNECTING:
121
+ console.debug("Connecting")
122
+ break;
123
+
124
+ case ClientStateType.CONNECTED:
125
+ console.debug("Connected")
126
+ dispatch(connectSuccess())
127
+ break;
128
+
129
+ case ClientStateType.CONNECTION_LOST:
130
+ dispatch(connectLoss("Connection lost"))
131
+ break;
132
+
133
+ case ClientStateType.CONNECTION_TERMINATED:
134
+ console.debug("Disconnected")
135
+ dispatch(authLogout())
136
+ break;
137
+
138
+ case ClientStateType.EVENT_RECEIVED:
139
+ console.debug("Event received")
140
+ break;
141
+
142
+ case ClientStateType.CONNECTION_ERROR:
143
+ console.error("Connection error")
144
+ break;
145
+ }
146
+
147
+ });
148
+
149
+ resolve(client);
150
+ });
151
+ }
152
+ ```
153
+
154
+
155
+ # Build
156
+ ---
157
+
158
+ 1. Simple compile - Generate output files
159
+
160
+ ```shell
161
+ npm run build
162
+ ```
163
+
164
+
165
+
166
+ 2. Compile (Platform specific)
167
+
168
+ **Linux**
169
+
170
+
171
+ ```shell
172
+ npm run build_linux
173
+ ```
174
+
175
+
176
+ **Windows**
177
+
178
+ ```shell
179
+ npm run build_win
180
+ ```
181
+
182
+
183
+ 3. Distribute compiled files for linux to react client project
184
+
185
+ **Linux**
186
+
187
+
188
+ ```shell
189
+ TO DO
190
+ ```
191
+
192
+ **Windows**
193
+
194
+
195
+ ```shell
196
+ TO DO
197
+ ```
198
+
package/package.json ADDED
@@ -0,0 +1,56 @@
1
+ {
2
+ "name": "cdsclient-lib",
3
+ "version": "0.0.1",
4
+ "description": "Api library for cloudisense react client",
5
+ "main": "lib/index.js",
6
+ "module": "dist/index.esm.js",
7
+ "types": "lib/index.d.ts",
8
+ "author": "Rajdeep Rath",
9
+ "license": "Apache 2.0",
10
+ "files": [
11
+ "/lib"
12
+ ],
13
+ "scripts": {
14
+ "build": "tsc",
15
+ "tsc": "tsc",
16
+ "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
17
+ "lint": "tslint -p tsconfig.json",
18
+ "prod": "tsc --sourceMap false && node ./lib/index.js",
19
+ "debug": "tsc --sourcemap",
20
+ "build_linux": "rm -rf ./dist && tsc --sourceMap false && tsc --build tsconfig.es5.json",
21
+ "share_linux": "rm -rf ../cloudisense-client-react/src/lib && cp -R ./dist/lib/es6 ../cloudisense-client-react/src/lib",
22
+ "build_win": "rmdir /q /S .\\dist && tsc --sourceMap false && tsc --build tsconfig.es5.json",
23
+ "share_win": "rmdir /q /S ..\\cloudisense-client-react\\src\\lib && xcopy .\\dist\\lib\\es6 ..\\cloudisense-client-react\\src\\lib\\ /E /Y"
24
+ },
25
+ "repository": {
26
+ "type": "git",
27
+ "url": "https://github.com/connessionetech/cloudisense-client-lib.git"
28
+ },
29
+ "keywords": ["cloudisense", "automation", "devops", "monitoring"],
30
+ "bugs": {
31
+ "url": "https://github.com/connessionetech/cloudisense-client-lib/issues"
32
+ },
33
+ "homepage": "https://github.com/connessionetech/cloudisense-client-lib#readme",
34
+ "devDependencies": {
35
+ "@types/node": "^7.0.71",
36
+ "class-transformer": "^0.5.1",
37
+ "prettier": "^2.2.1",
38
+ "ts-node": "^10.0.0",
39
+ "tsconfig-paths": "^3.9.0",
40
+ "tslint": "^6.1.3",
41
+ "tslint-config-prettier": "^1.18.0",
42
+ "typescript": "^3.9.10"
43
+ },
44
+ "dependencies": {
45
+ "axios": "^0.21.1",
46
+ "defer-promise": "^2.0.1",
47
+ "js-base64": "^3.6.1",
48
+ "js-sha256": "^0.9.0",
49
+ "json2typescript": "^1.4.1",
50
+ "nanoid": "^3.1.23",
51
+ "reflect-metadata": "^0.1.13",
52
+ "strongly-typed-events": "^2.1.7",
53
+ "tsify": "^5.0.2",
54
+ "websocket": "^1.0.34"
55
+ }
56
+ }