@leaddreamer/inventorylogic 0.0.3-beta.0 → 0.0.3-beta.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 +199 -199
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -9,17 +9,20 @@ business "logic" - not browser services.
|
|
|
9
9
|
## Modules
|
|
10
10
|
|
|
11
11
|
<dl>
|
|
12
|
-
<dt><a href="#
|
|
13
|
-
<dd><p>
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
users</p>
|
|
12
|
+
<dt><a href="#module_InventoryLogic">InventoryLogic</a></dt>
|
|
13
|
+
<dd><p>Business Logic for the PaaS, wrapped
|
|
14
|
+
around FirebaseWrapper, to be shared between Back and Front End.
|
|
15
|
+
This particular library only provides the business "logic" - not browser
|
|
16
|
+
services.</p>
|
|
18
17
|
</dd>
|
|
19
18
|
<dt><a href="#module_InventoryLogic">InventoryLogic</a></dt>
|
|
20
19
|
<dd><p>A collection of Business logic and database functions. Shared between ReactJS
|
|
21
20
|
frontEnd and NodeJS BackEnd</p>
|
|
22
21
|
</dd>
|
|
22
|
+
<dt><a href="#module_Commodities">Commodities</a></dt>
|
|
23
|
+
<dd><p>Typedefs, constants, support functions and database operations related to Commodity Matrials
|
|
24
|
+
users</p>
|
|
25
|
+
</dd>
|
|
23
26
|
<dt><a href="#module_LineItem">LineItem</a></dt>
|
|
24
27
|
<dd><p>Typedefs, constants, support functions and database operations related to LineItem Matrials
|
|
25
28
|
users</p>
|
|
@@ -36,10 +39,6 @@ as an abstraction above a specific payment processor.</p>
|
|
|
36
39
|
<dt><a href="#module_Product">Product</a></dt>
|
|
37
40
|
<dd><p>Typedefs, constants, support functions and database operations related to Products</p>
|
|
38
41
|
</dd>
|
|
39
|
-
<dt><a href="#module_Units">Units</a></dt>
|
|
40
|
-
<dd><p>Typedefs, constants, support functions and database operations related to usage Units
|
|
41
|
-
and conversions</p>
|
|
42
|
-
</dd>
|
|
43
42
|
<dt><a href="#module_User">User</a></dt>
|
|
44
43
|
<dd><p>Typedefs, constants, support functions and database operations related to individual
|
|
45
44
|
users</p>
|
|
@@ -48,18 +47,136 @@ users</p>
|
|
|
48
47
|
<dd><p>Typedefs, constants, support functions and database operations related to usage Units
|
|
49
48
|
and conversions</p>
|
|
50
49
|
</dd>
|
|
51
|
-
<dt><a href="#
|
|
52
|
-
<dd><p>
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
50
|
+
<dt><a href="#module_Boilerplate">Boilerplate</a></dt>
|
|
51
|
+
<dd><p>Shared constants and symbols</p>
|
|
52
|
+
</dd>
|
|
53
|
+
<dt><a href="#module_Units">Units</a></dt>
|
|
54
|
+
<dd><p>Typedefs, constants, support functions and database operations related to usage Units
|
|
55
|
+
and conversions</p>
|
|
56
56
|
</dd>
|
|
57
57
|
</dl>
|
|
58
58
|
|
|
59
|
-
<a name="
|
|
59
|
+
<a name="module_InventoryLogic"></a>
|
|
60
|
+
|
|
61
|
+
## InventoryLogic
|
|
62
|
+
Business Logic for the PaaS, wrapped
|
|
63
|
+
around FirebaseWrapper, to be shared between Back and Front End.
|
|
64
|
+
This particular library only provides the business "logic" - not browser
|
|
65
|
+
services.
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
* [InventoryLogic](#module_InventoryLogic)
|
|
69
|
+
* _static_
|
|
70
|
+
* [.databaseStart(firebase, config, thisLogger)](#module_InventoryLogic.databaseStart) ⇒ <code>Promise.Firebase.app</code>
|
|
71
|
+
* _inner_
|
|
72
|
+
* [~FirebaseConfigObject](#module_InventoryLogic..FirebaseConfigObject) : <code>object</code>
|
|
73
|
+
|
|
74
|
+
<a name="module_InventoryLogic.databaseStart"></a>
|
|
75
|
+
|
|
76
|
+
### InventoryLogic.databaseStart(firebase, config, thisLogger) ⇒ <code>Promise.Firebase.app</code>
|
|
77
|
+
all-in-one wrapper for a solid subset of CLIENT-SIDE Firebase
|
|
78
|
+
functions, with a consistent interface. There is a parallel set for
|
|
79
|
+
ADMIN-SIDE functions as well.
|
|
80
|
+
Call/initialize with Firebase Configuration settings in an object as
|
|
81
|
+
described below
|
|
82
|
+
|
|
83
|
+
**Kind**: static method of [<code>InventoryLogic</code>](#module_InventoryLogic)
|
|
84
|
+
|
|
85
|
+
| Param | Type | Description |
|
|
86
|
+
| --- | --- | --- |
|
|
87
|
+
| firebase | <code>Firebase</code> | |
|
|
88
|
+
| config | <code>FirebaseConfigObject</code> | Firebase Admin object |
|
|
89
|
+
| thisLogger | <code>callback</code> | |
|
|
90
|
+
|
|
91
|
+
**Example**
|
|
92
|
+
```
|
|
93
|
+
//this specifically loads ALL the subsections, specifically for
|
|
94
|
+
//the Browser. See later (tbd) notes for NodeJS
|
|
95
|
+
|
|
96
|
+
import FirebaseWrapper from "@leaddreamer/firebase-wrapper";
|
|
97
|
+
FirebaseWrapper(config); //see below
|
|
98
|
+
export * from "@leaddreamer/firebase-wrapper";
|
|
99
|
+
```
|
|
100
|
+
<a name="module_InventoryLogic..FirebaseConfigObject"></a>
|
|
101
|
+
|
|
102
|
+
### InventoryLogic~FirebaseConfigObject : <code>object</code>
|
|
103
|
+
only authDomain, databaseURL and storageBucket are present when
|
|
104
|
+
called from a cloud environment
|
|
105
|
+
|
|
106
|
+
**Kind**: inner typedef of [<code>InventoryLogic</code>](#module_InventoryLogic)
|
|
107
|
+
**Properties**
|
|
108
|
+
|
|
109
|
+
| Name | Type | Description |
|
|
110
|
+
| --- | --- | --- |
|
|
111
|
+
| apiKey | <code>string</code> | required api Key from Firebase Console, |
|
|
112
|
+
| appId | <code>string</code> | required app ID from Firebase Console |
|
|
113
|
+
| projectId | <code>string</code> | required Firebase projectID from Firebase console |
|
|
114
|
+
| authDomain | <code>string</code> | (optional) auth domain from Firebase Console |
|
|
115
|
+
| databaseURL | <code>string</code> | (optional) Firestore database URL from Firebase console |
|
|
116
|
+
| storageBucket: | <code>string</code> | (optional) URL of Firestore Storage Bucket |
|
|
117
|
+
| messagingSenderId: | <code>string</code> | (optional) ID for Messaing service from Firebase Console |
|
|
118
|
+
| measurementId: | <code>string</code> | (optional) Analytics/Measurement ID from Firebase Console |
|
|
119
|
+
| mapsAPIKey | <code>string</code> | (optional) App ID for Google Maps API, from Google |
|
|
120
|
+
|
|
121
|
+
<a name="module_InventoryLogic"></a>
|
|
122
|
+
|
|
123
|
+
## InventoryLogic
|
|
124
|
+
A collection of Business logic and database functions. Shared between ReactJS
|
|
125
|
+
frontEnd and NodeJS BackEnd
|
|
60
126
|
|
|
61
|
-
|
|
62
|
-
|
|
127
|
+
|
|
128
|
+
* [InventoryLogic](#module_InventoryLogic)
|
|
129
|
+
* _static_
|
|
130
|
+
* [.databaseStart(firebase, config, thisLogger)](#module_InventoryLogic.databaseStart) ⇒ <code>Promise.Firebase.app</code>
|
|
131
|
+
* _inner_
|
|
132
|
+
* [~FirebaseConfigObject](#module_InventoryLogic..FirebaseConfigObject) : <code>object</code>
|
|
133
|
+
|
|
134
|
+
<a name="module_InventoryLogic.databaseStart"></a>
|
|
135
|
+
|
|
136
|
+
### InventoryLogic.databaseStart(firebase, config, thisLogger) ⇒ <code>Promise.Firebase.app</code>
|
|
137
|
+
all-in-one wrapper for a solid subset of CLIENT-SIDE Firebase
|
|
138
|
+
functions, with a consistent interface. There is a parallel set for
|
|
139
|
+
ADMIN-SIDE functions as well.
|
|
140
|
+
Call/initialize with Firebase Configuration settings in an object as
|
|
141
|
+
described below
|
|
142
|
+
|
|
143
|
+
**Kind**: static method of [<code>InventoryLogic</code>](#module_InventoryLogic)
|
|
144
|
+
|
|
145
|
+
| Param | Type | Description |
|
|
146
|
+
| --- | --- | --- |
|
|
147
|
+
| firebase | <code>Firebase</code> | |
|
|
148
|
+
| config | <code>FirebaseConfigObject</code> | Firebase Admin object |
|
|
149
|
+
| thisLogger | <code>callback</code> | |
|
|
150
|
+
|
|
151
|
+
**Example**
|
|
152
|
+
```
|
|
153
|
+
//this specifically loads ALL the subsections, specifically for
|
|
154
|
+
//the Browser. See later (tbd) notes for NodeJS
|
|
155
|
+
|
|
156
|
+
import FirebaseWrapper from "@leaddreamer/firebase-wrapper";
|
|
157
|
+
FirebaseWrapper(config); //see below
|
|
158
|
+
export * from "@leaddreamer/firebase-wrapper";
|
|
159
|
+
```
|
|
160
|
+
<a name="module_InventoryLogic..FirebaseConfigObject"></a>
|
|
161
|
+
|
|
162
|
+
### InventoryLogic~FirebaseConfigObject : <code>object</code>
|
|
163
|
+
only authDomain, databaseURL and storageBucket are present when
|
|
164
|
+
called from a cloud environment
|
|
165
|
+
|
|
166
|
+
**Kind**: inner typedef of [<code>InventoryLogic</code>](#module_InventoryLogic)
|
|
167
|
+
**Properties**
|
|
168
|
+
|
|
169
|
+
| Name | Type | Description |
|
|
170
|
+
| --- | --- | --- |
|
|
171
|
+
| apiKey | <code>string</code> | required api Key from Firebase Console, |
|
|
172
|
+
| appId | <code>string</code> | required app ID from Firebase Console |
|
|
173
|
+
| projectId | <code>string</code> | required Firebase projectID from Firebase console |
|
|
174
|
+
| authDomain | <code>string</code> | (optional) auth domain from Firebase Console |
|
|
175
|
+
| databaseURL | <code>string</code> | (optional) Firestore database URL from Firebase console |
|
|
176
|
+
| storageBucket: | <code>string</code> | (optional) URL of Firestore Storage Bucket |
|
|
177
|
+
| messagingSenderId: | <code>string</code> | (optional) ID for Messaing service from Firebase Console |
|
|
178
|
+
| measurementId: | <code>string</code> | (optional) Analytics/Measurement ID from Firebase Console |
|
|
179
|
+
| mapsAPIKey | <code>string</code> | (optional) App ID for Google Maps API, from Google |
|
|
63
180
|
|
|
64
181
|
<a name="module_Commodities"></a>
|
|
65
182
|
|
|
@@ -272,66 +389,6 @@ An object to allow for paginating a table read from Firestore. REQUIRES a sortin
|
|
|
272
389
|
| PageForward | <code>method</code> | pages the fetch forward |
|
|
273
390
|
| PageBack | <code>method</code> | pages the fetch backward |
|
|
274
391
|
|
|
275
|
-
<a name="module_InventoryLogic"></a>
|
|
276
|
-
|
|
277
|
-
## InventoryLogic
|
|
278
|
-
A collection of Business logic and database functions. Shared between ReactJS
|
|
279
|
-
frontEnd and NodeJS BackEnd
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
* [InventoryLogic](#module_InventoryLogic)
|
|
283
|
-
* _static_
|
|
284
|
-
* [.databaseStart(firebase, config, thisLogger)](#module_InventoryLogic.databaseStart) ⇒ <code>Promise.Firebase.app</code>
|
|
285
|
-
* _inner_
|
|
286
|
-
* [~FirebaseConfigObject](#module_InventoryLogic..FirebaseConfigObject) : <code>object</code>
|
|
287
|
-
|
|
288
|
-
<a name="module_InventoryLogic.databaseStart"></a>
|
|
289
|
-
|
|
290
|
-
### InventoryLogic.databaseStart(firebase, config, thisLogger) ⇒ <code>Promise.Firebase.app</code>
|
|
291
|
-
all-in-one wrapper for a solid subset of CLIENT-SIDE Firebase
|
|
292
|
-
functions, with a consistent interface. There is a parallel set for
|
|
293
|
-
ADMIN-SIDE functions as well.
|
|
294
|
-
Call/initialize with Firebase Configuration settings in an object as
|
|
295
|
-
described below
|
|
296
|
-
|
|
297
|
-
**Kind**: static method of [<code>InventoryLogic</code>](#module_InventoryLogic)
|
|
298
|
-
|
|
299
|
-
| Param | Type | Description |
|
|
300
|
-
| --- | --- | --- |
|
|
301
|
-
| firebase | <code>Firebase</code> | |
|
|
302
|
-
| config | <code>FirebaseConfigObject</code> | Firebase Admin object |
|
|
303
|
-
| thisLogger | <code>callback</code> | |
|
|
304
|
-
|
|
305
|
-
**Example**
|
|
306
|
-
```
|
|
307
|
-
//this specifically loads ALL the subsections, specifically for
|
|
308
|
-
//the Browser. See later (tbd) notes for NodeJS
|
|
309
|
-
|
|
310
|
-
import FirebaseWrapper from "@leaddreamer/firebase-wrapper";
|
|
311
|
-
FirebaseWrapper(config); //see below
|
|
312
|
-
export * from "@leaddreamer/firebase-wrapper";
|
|
313
|
-
```
|
|
314
|
-
<a name="module_InventoryLogic..FirebaseConfigObject"></a>
|
|
315
|
-
|
|
316
|
-
### InventoryLogic~FirebaseConfigObject : <code>object</code>
|
|
317
|
-
only authDomain, databaseURL and storageBucket are present when
|
|
318
|
-
called from a cloud environment
|
|
319
|
-
|
|
320
|
-
**Kind**: inner typedef of [<code>InventoryLogic</code>](#module_InventoryLogic)
|
|
321
|
-
**Properties**
|
|
322
|
-
|
|
323
|
-
| Name | Type | Description |
|
|
324
|
-
| --- | --- | --- |
|
|
325
|
-
| apiKey | <code>string</code> | required api Key from Firebase Console, |
|
|
326
|
-
| appId | <code>string</code> | required app ID from Firebase Console |
|
|
327
|
-
| projectId | <code>string</code> | required Firebase projectID from Firebase console |
|
|
328
|
-
| authDomain | <code>string</code> | (optional) auth domain from Firebase Console |
|
|
329
|
-
| databaseURL | <code>string</code> | (optional) Firestore database URL from Firebase console |
|
|
330
|
-
| storageBucket: | <code>string</code> | (optional) URL of Firestore Storage Bucket |
|
|
331
|
-
| messagingSenderId: | <code>string</code> | (optional) ID for Messaing service from Firebase Console |
|
|
332
|
-
| measurementId: | <code>string</code> | (optional) Analytics/Measurement ID from Firebase Console |
|
|
333
|
-
| mapsAPIKey | <code>string</code> | (optional) App ID for Google Maps API, from Google |
|
|
334
|
-
|
|
335
392
|
<a name="module_LineItem"></a>
|
|
336
393
|
|
|
337
394
|
## LineItem
|
|
@@ -1180,83 +1237,6 @@ a record
|
|
|
1180
1237
|
| created | <code>dateTime</code> | |
|
|
1181
1238
|
| modified | <code>dateTime</code> | |
|
|
1182
1239
|
|
|
1183
|
-
<a name="module_Units"></a>
|
|
1184
|
-
|
|
1185
|
-
## Units
|
|
1186
|
-
Typedefs, constants, support functions and database operations related to usage Units
|
|
1187
|
-
and conversions
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
* [Units](#module_Units)
|
|
1191
|
-
* _static_
|
|
1192
|
-
* [.saveUnit()](#module_Units.saveUnit) ⇒ <code>Promise.<void></code>
|
|
1193
|
-
* _inner_
|
|
1194
|
-
* [~UnitDefault](#module_Units..UnitDefault) : <code>Unit</code>
|
|
1195
|
-
* [~UnitForm](#module_Units..UnitForm) : <code>Unit</code>
|
|
1196
|
-
* [~UnitData](#module_Units..UnitData) : <code>Unit</code>
|
|
1197
|
-
* [~summarizeUnit(unit)](#module_Units..summarizeUnit) ⇒ <code>string</code>
|
|
1198
|
-
* [~Unit](#module_Units..Unit) : <code>object</code>
|
|
1199
|
-
|
|
1200
|
-
<a name="module_Units.saveUnit"></a>
|
|
1201
|
-
|
|
1202
|
-
### Units.saveUnit() ⇒ <code>Promise.<void></code>
|
|
1203
|
-
Saves a default Stage Settings object to the database
|
|
1204
|
-
|
|
1205
|
-
**Kind**: static method of [<code>Units</code>](#module_Units)
|
|
1206
|
-
**Properties**
|
|
1207
|
-
|
|
1208
|
-
| Name | Type |
|
|
1209
|
-
| --- | --- |
|
|
1210
|
-
| unit | <code>Unit</code> |
|
|
1211
|
-
|
|
1212
|
-
<a name="module_Units..UnitDefault"></a>
|
|
1213
|
-
|
|
1214
|
-
### Units~UnitDefault : <code>Unit</code>
|
|
1215
|
-
**Kind**: inner constant of [<code>Units</code>](#module_Units)
|
|
1216
|
-
**Default**: <code>{"Id":null,"refPath":null,"unit":null,"ratio":1,"otherUnit":null,"system":null}</code>
|
|
1217
|
-
**Read only**: true
|
|
1218
|
-
<a name="module_Units..UnitForm"></a>
|
|
1219
|
-
|
|
1220
|
-
### Units~UnitForm : <code>Unit</code>
|
|
1221
|
-
**Kind**: inner constant of [<code>Units</code>](#module_Units)
|
|
1222
|
-
**Default**: <code>{"unit":"text","ratio":"number","otherUnit":"","system":"string"}</code>
|
|
1223
|
-
**Read only**: true
|
|
1224
|
-
<a name="module_Units..UnitData"></a>
|
|
1225
|
-
|
|
1226
|
-
### Units~UnitData : <code>Unit</code>
|
|
1227
|
-
**Kind**: inner constant of [<code>Units</code>](#module_Units)
|
|
1228
|
-
**Default**: <code>{"unit":"science.unit","otherUnit":"science.unit","ratio":1}</code>
|
|
1229
|
-
**Read only**: true
|
|
1230
|
-
<a name="module_Units..summarizeUnit"></a>
|
|
1231
|
-
|
|
1232
|
-
### Units~summarizeUnit(unit) ⇒ <code>string</code>
|
|
1233
|
-
Returns a standardized formatted name string
|
|
1234
|
-
|
|
1235
|
-
**Kind**: inner method of [<code>Units</code>](#module_Units)
|
|
1236
|
-
**Returns**: <code>string</code> - formatted name string
|
|
1237
|
-
|
|
1238
|
-
| Param | Type |
|
|
1239
|
-
| --- | --- |
|
|
1240
|
-
| unit | <code>Unit</code> |
|
|
1241
|
-
|
|
1242
|
-
<a name="module_Units..Unit"></a>
|
|
1243
|
-
|
|
1244
|
-
### Units~Unit : <code>object</code>
|
|
1245
|
-
A structure to hold Unit name and conversion information
|
|
1246
|
-
This does NOT deal with length/area/volume changes
|
|
1247
|
-
|
|
1248
|
-
**Kind**: inner typedef of [<code>Units</code>](#module_Units)
|
|
1249
|
-
**Properties**
|
|
1250
|
-
|
|
1251
|
-
| Name | Type | Description |
|
|
1252
|
-
| --- | --- | --- |
|
|
1253
|
-
| Id | <code>string</code> | database record Id - random but unique |
|
|
1254
|
-
| refPath | <code>string</code> | database record/document storage path |
|
|
1255
|
-
| unit | <code>string</code> | text version of the unit name |
|
|
1256
|
-
| ratio | <code>number</code> | numerical conversion highValue |
|
|
1257
|
-
| otherUnit | <code>string</code> | other unit to reference against - "name" unit is "ratio" of "other" unit |
|
|
1258
|
-
| system | <code>string</code> | measurement system - imperial, metric, time |
|
|
1259
|
-
|
|
1260
1240
|
<a name="module_User"></a>
|
|
1261
1241
|
|
|
1262
1242
|
## User
|
|
@@ -1880,67 +1860,87 @@ Function Signature for UpdateChange functions(prev, value, itemFor, fullChoiceOb
|
|
|
1880
1860
|
| itemFor | <code>string</code> |
|
|
1881
1861
|
| fullChoiceObject | <code>object</code> |
|
|
1882
1862
|
|
|
1883
|
-
<a name="
|
|
1863
|
+
<a name="module_Boilerplate"></a>
|
|
1884
1864
|
|
|
1885
|
-
##
|
|
1886
|
-
|
|
1887
|
-
around FirebaseWrapper, to be shared between Back and Front End.
|
|
1888
|
-
This particular library only provides the business "logic" - not browser
|
|
1889
|
-
services.
|
|
1865
|
+
## Boilerplate
|
|
1866
|
+
Shared constants and symbols
|
|
1890
1867
|
|
|
1868
|
+
<a name="module_Units"></a>
|
|
1891
1869
|
|
|
1892
|
-
|
|
1870
|
+
## Units
|
|
1871
|
+
Typedefs, constants, support functions and database operations related to usage Units
|
|
1872
|
+
and conversions
|
|
1873
|
+
|
|
1874
|
+
|
|
1875
|
+
* [Units](#module_Units)
|
|
1893
1876
|
* _static_
|
|
1894
|
-
* [.
|
|
1877
|
+
* [.saveUnit()](#module_Units.saveUnit) ⇒ <code>Promise.<void></code>
|
|
1895
1878
|
* _inner_
|
|
1896
|
-
* [~
|
|
1879
|
+
* [~UnitDefault](#module_Units..UnitDefault) : <code>Unit</code>
|
|
1880
|
+
* [~UnitForm](#module_Units..UnitForm) : <code>Unit</code>
|
|
1881
|
+
* [~UnitData](#module_Units..UnitData) : <code>Unit</code>
|
|
1882
|
+
* [~summarizeUnit(unit)](#module_Units..summarizeUnit) ⇒ <code>string</code>
|
|
1883
|
+
* [~Unit](#module_Units..Unit) : <code>object</code>
|
|
1897
1884
|
|
|
1898
|
-
<a name="
|
|
1885
|
+
<a name="module_Units.saveUnit"></a>
|
|
1899
1886
|
|
|
1900
|
-
###
|
|
1901
|
-
|
|
1902
|
-
functions, with a consistent interface. There is a parallel set for
|
|
1903
|
-
ADMIN-SIDE functions as well.
|
|
1904
|
-
Call/initialize with Firebase Configuration settings in an object as
|
|
1905
|
-
described below
|
|
1887
|
+
### Units.saveUnit() ⇒ <code>Promise.<void></code>
|
|
1888
|
+
Saves a default Stage Settings object to the database
|
|
1906
1889
|
|
|
1907
|
-
**Kind**: static method of [<code>
|
|
1890
|
+
**Kind**: static method of [<code>Units</code>](#module_Units)
|
|
1891
|
+
**Properties**
|
|
1908
1892
|
|
|
1909
|
-
|
|
|
1910
|
-
| --- | --- |
|
|
1911
|
-
|
|
|
1912
|
-
| config | <code>FirebaseConfigObject</code> | Firebase Admin object |
|
|
1913
|
-
| thisLogger | <code>callback</code> | |
|
|
1893
|
+
| Name | Type |
|
|
1894
|
+
| --- | --- |
|
|
1895
|
+
| unit | <code>Unit</code> |
|
|
1914
1896
|
|
|
1915
|
-
|
|
1916
|
-
```
|
|
1917
|
-
//this specifically loads ALL the subsections, specifically for
|
|
1918
|
-
//the Browser. See later (tbd) notes for NodeJS
|
|
1897
|
+
<a name="module_Units..UnitDefault"></a>
|
|
1919
1898
|
|
|
1920
|
-
|
|
1921
|
-
|
|
1922
|
-
|
|
1923
|
-
|
|
1924
|
-
<a name="
|
|
1899
|
+
### Units~UnitDefault : <code>Unit</code>
|
|
1900
|
+
**Kind**: inner constant of [<code>Units</code>](#module_Units)
|
|
1901
|
+
**Default**: <code>{"Id":null,"refPath":null,"unit":null,"ratio":1,"otherUnit":null,"system":null}</code>
|
|
1902
|
+
**Read only**: true
|
|
1903
|
+
<a name="module_Units..UnitForm"></a>
|
|
1925
1904
|
|
|
1926
|
-
###
|
|
1927
|
-
|
|
1928
|
-
|
|
1905
|
+
### Units~UnitForm : <code>Unit</code>
|
|
1906
|
+
**Kind**: inner constant of [<code>Units</code>](#module_Units)
|
|
1907
|
+
**Default**: <code>{"unit":"text","ratio":"number","otherUnit":"","system":"string"}</code>
|
|
1908
|
+
**Read only**: true
|
|
1909
|
+
<a name="module_Units..UnitData"></a>
|
|
1929
1910
|
|
|
1930
|
-
|
|
1911
|
+
### Units~UnitData : <code>Unit</code>
|
|
1912
|
+
**Kind**: inner constant of [<code>Units</code>](#module_Units)
|
|
1913
|
+
**Default**: <code>{"unit":"science.unit","otherUnit":"science.unit","ratio":1}</code>
|
|
1914
|
+
**Read only**: true
|
|
1915
|
+
<a name="module_Units..summarizeUnit"></a>
|
|
1916
|
+
|
|
1917
|
+
### Units~summarizeUnit(unit) ⇒ <code>string</code>
|
|
1918
|
+
Returns a standardized formatted name string
|
|
1919
|
+
|
|
1920
|
+
**Kind**: inner method of [<code>Units</code>](#module_Units)
|
|
1921
|
+
**Returns**: <code>string</code> - formatted name string
|
|
1922
|
+
|
|
1923
|
+
| Param | Type |
|
|
1924
|
+
| --- | --- |
|
|
1925
|
+
| unit | <code>Unit</code> |
|
|
1926
|
+
|
|
1927
|
+
<a name="module_Units..Unit"></a>
|
|
1928
|
+
|
|
1929
|
+
### Units~Unit : <code>object</code>
|
|
1930
|
+
A structure to hold Unit name and conversion information
|
|
1931
|
+
This does NOT deal with length/area/volume changes
|
|
1932
|
+
|
|
1933
|
+
**Kind**: inner typedef of [<code>Units</code>](#module_Units)
|
|
1931
1934
|
**Properties**
|
|
1932
1935
|
|
|
1933
1936
|
| Name | Type | Description |
|
|
1934
1937
|
| --- | --- | --- |
|
|
1935
|
-
|
|
|
1936
|
-
|
|
|
1937
|
-
|
|
|
1938
|
-
|
|
|
1939
|
-
|
|
|
1940
|
-
|
|
|
1941
|
-
| messagingSenderId: | <code>string</code> | (optional) ID for Messaing service from Firebase Console |
|
|
1942
|
-
| measurementId: | <code>string</code> | (optional) Analytics/Measurement ID from Firebase Console |
|
|
1943
|
-
| mapsAPIKey | <code>string</code> | (optional) App ID for Google Maps API, from Google |
|
|
1938
|
+
| Id | <code>string</code> | database record Id - random but unique |
|
|
1939
|
+
| refPath | <code>string</code> | database record/document storage path |
|
|
1940
|
+
| unit | <code>string</code> | text version of the unit name |
|
|
1941
|
+
| ratio | <code>number</code> | numerical conversion highValue |
|
|
1942
|
+
| otherUnit | <code>string</code> | other unit to reference against - "name" unit is "ratio" of "other" unit |
|
|
1943
|
+
| system | <code>string</code> | measurement system - imperial, metric, time |
|
|
1944
1944
|
|
|
1945
1945
|
|
|
1946
1946
|
* * *
|
package/package.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"engines": {
|
|
4
4
|
"node": ">=22"
|
|
5
5
|
},
|
|
6
|
-
"version": "0.0.3-beta.
|
|
6
|
+
"version": "0.0.3-beta.1",
|
|
7
7
|
"description": "Business & Database Logic for Inventory Services",
|
|
8
8
|
"repository": {
|
|
9
9
|
"type": "git",
|
|
@@ -44,16 +44,16 @@
|
|
|
44
44
|
"access": "public"
|
|
45
45
|
},
|
|
46
46
|
"dependencies": {
|
|
47
|
-
"@leaddreamer/firebase-wrapper": "^2.1.
|
|
47
|
+
"@leaddreamer/firebase-wrapper": "^2.1.2-beta.0",
|
|
48
48
|
"@leaddreamer/genericutilities": "^0.1.6",
|
|
49
49
|
"@leaddreamer/staticforms": "^1.0.2-beta.0",
|
|
50
50
|
"lodash.clonedeep": "4.5.0",
|
|
51
|
-
"mathjs": "
|
|
52
|
-
"uuid": "
|
|
51
|
+
"mathjs": "15.2.0",
|
|
52
|
+
"uuid": "14.0.1"
|
|
53
53
|
},
|
|
54
54
|
"peerDependencies": {
|
|
55
|
-
"firebase": "
|
|
56
|
-
"firebase-admin": "
|
|
55
|
+
"firebase": "12.16.0",
|
|
56
|
+
"firebase-admin": "14.1.0"
|
|
57
57
|
},
|
|
58
58
|
"peerDependenciesMeta": {
|
|
59
59
|
"firebase-admin": {
|
|
@@ -65,7 +65,7 @@
|
|
|
65
65
|
},
|
|
66
66
|
"devDependencies": {
|
|
67
67
|
"accounting-js": "2.0.3",
|
|
68
|
-
"jsdoc-to-markdown": "9.1.
|
|
68
|
+
"jsdoc-to-markdown": "9.1.3",
|
|
69
69
|
"parcel": "latest"
|
|
70
70
|
},
|
|
71
71
|
"keywords": []
|