@digital-realty/ui-mfe-dcim 1.0.0-alpha.1

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/README.md ADDED
@@ -0,0 +1,165 @@
1
+ # ui-mfe-dcim
2
+
3
+ This is
4
+
5
+ ## Build status
6
+
7
+ - TODO hook up build status link
8
+
9
+ ## Creation
10
+
11
+ This React + Typescript application was created using [Vite](https://vitejs.dev/).
12
+
13
+ ## Setup
14
+
15
+ To get started:
16
+
17
+ ```sh
18
+ npm install
19
+ ```
20
+
21
+ ## Scripts
22
+
23
+ - `build` builds app and writes the output to the `dist` directory
24
+ - `build:workspace` used by the app shell to excute a build for this MFE
25
+ - `clean` delete `dist` and `node_modules` folders
26
+ - `dev` runs app for development, reloading on file changes
27
+ - `format` runs `prettier` rules on the source code to auto-fix formatting
28
+ - `lint` runs the linter for your project
29
+ - `lint:fix` runs the linter and attempts to fix as many problems as possible
30
+ - `preview` runs app on a local static web server that serves the files from dist at http://localhost:5173; used to check if the production build looks OK in the local environment
31
+ - `start` alias for the `dev` script
32
+ - `test` runs the unit tests
33
+
34
+ ---
35
+
36
+ ## Routes
37
+
38
+ ### /dcim/details
39
+
40
+ #### Query string arguments
41
+
42
+ | Param Name | Data Type | Description | Example |
43
+ | ---------- | --------- | ----------------------------- | -------------------------------- |
44
+ | assetName | string | The name of the asset | Starbucks Cage F150-B |
45
+ | locationId | string | The id of the location | 91aa7e54132e7600a501b7a66144b036 |
46
+ | sitecode | string | The site code of the location | IAD024 |
47
+
48
+ #### Example URL
49
+
50
+ http://localhost:5173/dcim/details?locationId=91aa7e54132e7600a501b7a66144b036&assetName=Starbucks%20Cage%20F150-B&sitecode=IAD024
51
+
52
+ ### /dcim/chart
53
+
54
+ #### Query string arguments
55
+
56
+ | Param Name | Data Type | Description | Example |
57
+ | ------------ | --------- | ------------------------------------ | -------------------------------------- |
58
+ | assetName | string | The name of the asset | Starbucks Cage F150-B |
59
+ | endDate | string | The end date of the chart data | 2024-04-23T20:29:00.000Z |
60
+ | functionName | string | The value being measured | TotITkW, KW,BMS_SLA_Temp |
61
+ | interval | string | The sampling interval for chart data | day, hour, 15 minute, 5 minute, minute |
62
+ | locationId | string | The id of the location | 91aa7e54132e7600a501b7a66144b036 |
63
+ | sitecode | string | The site code of the location | IAD024 |
64
+ | startDate | string | The start date of the chart data | 2024-04-16T20:29:00.000Z |
65
+ | subCategory | string | The subcategory of the device | PDU, Temperature, Total_IT_Load |
66
+ | tdcid | string | The device id | 31 |
67
+
68
+ #### Example URL
69
+
70
+ http://localhost:5173/dcim/chart/?assetName=Starbucks%20Cage%20F150-B&endDate=2024-04-23T20:29:00.000Z&functionName=TotITkW&interval=hour&locationId=91aa7e54132e7600a501b7a66144b036&sitecode=IAD024&startDate=2024-04-16T20:29:00.000Z&subCategory=Total_IT_Load&tdcid=31
71
+
72
+ ### /dcim/alerts
73
+
74
+ | Param Name | Data Type | Description | Example |
75
+ | ---------- | --------- | ----------------------------- | -------------------------------- |
76
+ | assetName | string | The name of the asset | Starbucks Cage F150-B |
77
+ | locationId | string | The id of the location | 91aa7e54132e7600a501b7a66144b036 |
78
+ | sitecode | string | The site code of the location | IAD024 |
79
+ | type | string | The alert type | critical, warning, custom |
80
+
81
+ TODO create a page for this
82
+
83
+ https://gp-tst.digitalrealty.com/locations/91aa7e54132e7600a501b7a66144b036/alerts?type=critical
84
+ https://gp-tst.digitalrealty.com/locations/91aa7e54132e7600a501b7a66144b036/alerts?type=custom
85
+ https://gp-tst.digitalrealty.com/locations/91aa7e54132e7600a501b7a66144b036/alerts?type=history
86
+
87
+ ### Unmatched routes
88
+
89
+ Any URL path which does not match a known route will redirect to the `/dcim/details` route.
90
+
91
+ ---
92
+
93
+ - `build` builds app and writes the output to the `dist` directory
94
+ - `build:workspace` used by the app shell to excute a build for this MFE
95
+ - `clean` delete `dist` and `node_modules` folders
96
+ - `dev` runs app for development, reloading on file changes
97
+ - `format` runs `prettier` rules on the source code to auto-fix formatting
98
+ - `lint` runs the linter for your project
99
+ - `lint:fix` runs the linter and attempts to fix as many problems as possible
100
+ - `preview` runs app on a local static web server that serves the files from dist at http://localhost:5173; used to check if the production build looks OK in the local environment
101
+ - `start` alias for the `dev` script
102
+ - `test` runs the unit tests
103
+
104
+ ---
105
+
106
+ ## Routes
107
+
108
+ ### /dcim/details
109
+
110
+ #### Query string arguments
111
+
112
+ | Param Name | Data Type | Description | Example |
113
+ | ---------- | --------- | ----------------------------- | -------------------------------- |
114
+ | assetName | string | The name of the asset | Starbucks Cage F150-B |
115
+ | locationId | string | The id of the location | 91aa7e54132e7600a501b7a66144b036 |
116
+ | sitecode | string | The site code of the location | IAD024 |
117
+
118
+ #### Example URL
119
+
120
+ http://localhost:5173/dcim/details?locationId=91aa7e54132e7600a501b7a66144b036&assetName=Starbucks%20Cage%20F150-B&sitecode=IAD024
121
+
122
+ ### /dcim/chart
123
+
124
+ #### Query string arguments
125
+
126
+ | Param Name | Data Type | Description | Example |
127
+ | ------------ | --------- | ------------------------------------ | -------------------------------------- |
128
+ | assetName | string | The name of the asset | Starbucks Cage F150-B |
129
+ | endDate | string | The end date of the chart data | 2024-04-23T20:29:00.000Z |
130
+ | functionName | string | The value being measured | TotITkW, KW,BMS_SLA_Temp |
131
+ | interval | string | The sampling interval for chart data | day, hour, 15 minute, 5 minute, minute |
132
+ | locationId | string | The id of the location | 91aa7e54132e7600a501b7a66144b036 |
133
+ | sitecode | string | The site code of the location | IAD024 |
134
+ | startDate | string | The start date of the chart data | 2024-04-16T20:29:00.000Z |
135
+ | subCategory | string | The subcategory of the device | PDU, Temperature,Total_IT_Load |
136
+ | tdcid | string | The device id | 31 |
137
+
138
+ #### Example URL
139
+
140
+ http://localhost:5173/dcim/chart/?assetName=Starbucks%20Cage%20F150-B&endDate=2024-04-23T20:29:00.000Z&functionName=TotITkW&interval=hour&locationId=91aa7e54132e7600a501b7a66144b036&sitecode=IAD024&startDate=2024-04-16T20:29:00.000Z&subCategory=Total_IT_Load&tdcid=31
141
+
142
+ ### /dcim/alerts
143
+
144
+ TODO this is not working yet in the codebase
145
+
146
+ | Param Name | Data Type | Description | Example |
147
+ | ---------- | --------- | ----------------------------- | -------------------------------- |
148
+ | assetName | string | The name of the asset | Starbucks Cage F150-B |
149
+ | locationId | string | The id of the location | 91aa7e54132e7600a501b7a66144b036 |
150
+ | sitecode | string | The site code of the location | IAD024 |
151
+ | type | string | The alert type | critical, |
152
+
153
+ TODO create a page for this
154
+
155
+ https://gp-tst.digitalrealty.com/locations/91aa7e54132e7600a501b7a66144b036/alerts?type=critical
156
+ https://gp-tst.digitalrealty.com/locations/91aa7e54132e7600a501b7a66144b036/alerts?type=custom
157
+ https://gp-tst.digitalrealty.com/locations/91aa7e54132e7600a501b7a66144b036/alerts?type=history
158
+
159
+ ### Unmatched routes
160
+
161
+ Any URL path which does not match a known route will redirect to the `/dcim/details` route.
162
+
163
+ ---
164
+
165
+ https://stackoverflow.com/questions/77007972/how-to-configure-vite-js-to-output-a-file-main-js-without-a-hash