@genesislcap/foundation-utils 14.179.0 → 14.180.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.
Files changed (3) hide show
  1. package/README.md +31 -23
  2. package/dist/custom-elements.json +248 -248
  3. package/package.json +10 -10
package/README.md CHANGED
@@ -1,41 +1,49 @@
1
1
  # Genesis Foundation Utils
2
2
 
3
- Shared utils for foundation packages. *Please note that this shouldn't have any cross dependencies to other parts of
4
- foundation.*
5
-
6
- ### [Module Federation Details](https://webpack.js.org/concepts/module-federation):
7
-
8
- | Remote Name | Port |
9
- | --------------------- | ----- |
10
- | foundationUtils | 3040 |
11
-
12
- [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
13
- [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](https://www.typescriptlang.org/)
14
-
3
+ The `@genesislcap/foundation-utils` package provides a collection of utility services and helpers designed to facilitate common development tasks within Genesis applications. It aims to enhance productivity by offering reusable solutions for patterns and problems encountered across different projects.
4
+
5
+ ## API Documentation
6
+
7
+ For more detailed information on API and configurations, please refer to the [API documentation](docs/api/index.md) in the `docs/api` directory.
8
+
9
+ ## Features
10
+
11
+ The library encompasses a broad range of features, including:
12
+
13
+ - **[Data](src/data/README.md)** - Manages in-memory databases and data storage solutions.
14
+ - **[Decorators](src/decorators/README.md)** - Provides decorators for enhancing class functionalities, such as rendering on change.
15
+ - **[Design System](src/design-system/README.md)** - Holds the design system configurations and utilities.
16
+ - **[Directives](src/directives/README.md)** - Offers Angular-like directives for DOM manipulations, including conditional rendering and synchronization functionalities.
17
+ - **[ENV](src/env/README.md)** - Contains utilities for environment variable management and detection of development environments.
18
+ - **[Error](src/error/README.md)** - Deals with error mapping and handling strategies.
19
+ - **[Formatters](src/formatters/README.md)** - Includes functions for formatting dates and numbers according to locale settings.
20
+ - **[Logger](src/logger/README.md)** - A simple logging utility for debugging and information tracking.
21
+ - **[Mappers](src/mappers/README.md)** - Focuses on data transformation, especially for DTOs (Data Transfer Objects).
22
+ - **[Mixins](src/mixins/README.md)** - Provides mixins for common functionalities like lifecycle hooks and state management.
23
+ - **[Observer](src/observer/README.md)** - Implements the Observer pattern for reactive programming.
24
+ - **[Resource](src/observer/README.md)** - Defines types and interfaces for resource management.
25
+ - **[Serializers](src/serializers/README.md)** - Contains serializers, particularly for JSON data handling.
26
+ - **[State](src/state/README.md)** - Manages reactive state and provides utilities for state observation.
27
+ - **[Styles](src/styles/README.md)** - Includes utilities for styling, dealing with colors, typography, and DOM styles.
28
+ - **[UUID](src/uuid/README.md)** - Utilities for generating and managing UUIDs.
29
+ - **[Window](src/window/README.md)** - Provides abstractions and utilities for window object manipulations.
15
30
 
16
31
  ## Installation
17
32
 
18
- To enable this module in your application, follow the steps below.
19
-
20
- 1. Add `@genesislcap/foundation-utils` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) page.
33
+ To include `@genesislcap/foundation-utils` in your project, add it as a dependency in your `package.json` file and follow your project's routine for dependency installation.
21
34
 
22
35
  ```json
23
36
  {
24
- ...
25
37
  "dependencies": {
26
- ...
27
38
  "@genesislcap/foundation-utils": "latest"
28
- ...
29
- },
30
- ...
39
+ }
31
40
  }
32
41
  ```
33
42
 
34
- ## [API Docs](./docs/api/index.md)
35
-
36
43
  ## License
37
44
 
38
45
  Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
39
46
 
40
47
  ### Licensed components
41
- Genesis low-code platform
48
+
49
+ Genesis low-code platform
package/dist/custom-elements.json CHANGED
@@ -159,204 +159,6 @@
159
159
  }
160
160
  ]
161
161
  },
162
- {
163
- "kind": "javascript-module",
164
- "path": "src/data/inMemoryDatabase.ts",
165
- "declarations": [
166
- {
167
- "kind": "class",
168
- "description": "An in memory database of specific DatabaseRecord types.",
169
- "name": "InMemoryDatabase",
170
- "members": [
171
- {
172
- "kind": "field",
173
- "name": "isWorking",
174
- "type": {
175
- "text": "boolean"
176
- },
177
- "privacy": "public",
178
- "default": "false"
179
- },
180
- {
181
- "kind": "field",
182
- "name": "records",
183
- "type": {
184
- "text": "Record<string, T>"
185
- },
186
- "privacy": "private",
187
- "default": "{}"
188
- },
189
- {
190
- "kind": "field",
191
- "name": "beforeUpdateListeners",
192
- "privacy": "private"
193
- },
194
- {
195
- "kind": "field",
196
- "name": "afterUpdateListeners",
197
- "privacy": "private"
198
- },
199
- {
200
- "kind": "method",
201
- "name": "create",
202
- "privacy": "public",
203
- "return": {
204
- "type": {
205
- "text": "Promise<DatabaseAccessResult.Create<T>>"
206
- }
207
- },
208
- "parameters": [
209
- {
210
- "name": "newValue",
211
- "type": {
212
- "text": "Omit<T, 'id'>"
213
- }
214
- }
215
- ]
216
- },
217
- {
218
- "kind": "method",
219
- "name": "read",
220
- "privacy": "public",
221
- "return": {
222
- "type": {
223
- "text": "Promise<DatabaseAccessResult.Read<T>>"
224
- }
225
- },
226
- "parameters": [
227
- {
228
- "name": "id",
229
- "type": {
230
- "text": "string"
231
- }
232
- }
233
- ]
234
- },
235
- {
236
- "kind": "method",
237
- "name": "update",
238
- "privacy": "public",
239
- "return": {
240
- "type": {
241
- "text": "Promise<DatabaseAccessResult.Update<T>>"
242
- }
243
- },
244
- "parameters": [
245
- {
246
- "name": "id",
247
- "type": {
248
- "text": "string"
249
- }
250
- },
251
- {
252
- "name": "newValue",
253
- "type": {
254
- "text": "Omit<Partial<T>, 'id'>"
255
- }
256
- }
257
- ]
258
- },
259
- {
260
- "kind": "method",
261
- "name": "delete",
262
- "privacy": "public",
263
- "return": {
264
- "type": {
265
- "text": "Promise<DatabaseAccessResult.Delete>"
266
- }
267
- },
268
- "parameters": [
269
- {
270
- "name": "id",
271
- "type": {
272
- "text": "string"
273
- }
274
- }
275
- ]
276
- },
277
- {
278
- "kind": "method",
279
- "name": "visit",
280
- "privacy": "public",
281
- "return": {
282
- "type": {
283
- "text": "Promise<void>"
284
- }
285
- },
286
- "parameters": [
287
- {
288
- "name": "visitor",
289
- "type": {
290
- "text": "(record: T) => void"
291
- }
292
- }
293
- ]
294
- },
295
- {
296
- "kind": "method",
297
- "name": "onBeforeUpdate",
298
- "privacy": "public",
299
- "return": {
300
- "type": {
301
- "text": "() => void"
302
- }
303
- },
304
- "parameters": [
305
- {
306
- "name": "listener",
307
- "type": {
308
- "text": "Listener<DatabaseEvent.BeforeUpdate<T>>"
309
- }
310
- }
311
- ]
312
- },
313
- {
314
- "kind": "method",
315
- "name": "onAfterUpdate",
316
- "privacy": "public",
317
- "return": {
318
- "type": {
319
- "text": "() => void"
320
- }
321
- },
322
- "parameters": [
323
- {
324
- "name": "listener",
325
- "type": {
326
- "text": "Listener<DatabaseEvent.AfterUpdate<T>>"
327
- }
328
- }
329
- ]
330
- }
331
- ]
332
- }
333
- ],
334
- "exports": [
335
- {
336
- "kind": "js",
337
- "name": "InMemoryDatabase",
338
- "declaration": {
339
- "name": "InMemoryDatabase",
340
- "module": "src/data/inMemoryDatabase.ts"
341
- }
342
- }
343
- ]
344
- },
345
- {
346
- "kind": "javascript-module",
347
- "path": "src/data/index.ts",
348
- "declarations": [],
349
- "exports": [
350
- {
351
- "kind": "js",
352
- "name": "*",
353
- "declaration": {
354
- "name": "*",
355
- "package": "./inMemoryDatabase"
356
- }
357
- }
358
- ]
359
- },
360
162
  {
361
163
  "kind": "javascript-module",
362
164
  "path": "src/decorators/index.ts",
@@ -410,56 +212,6 @@
410
212
  }
411
213
  ]
412
214
  },
413
- {
414
- "kind": "javascript-module",
415
- "path": "src/design-system/design-system.ts",
416
- "declarations": [
417
- {
418
- "kind": "function",
419
- "name": "assureDesignSystem",
420
- "return": {
421
- "type": {
422
- "text": "DesignSystemModule"
423
- }
424
- },
425
- "parameters": [
426
- {
427
- "name": "module",
428
- "type": {
429
- "text": "DesignSystemModule"
430
- }
431
- }
432
- ],
433
- "description": "assureDesignSystem.",
434
- "privacy": "public"
435
- }
436
- ],
437
- "exports": [
438
- {
439
- "kind": "js",
440
- "name": "assureDesignSystem",
441
- "declaration": {
442
- "name": "assureDesignSystem",
443
- "module": "src/design-system/design-system.ts"
444
- }
445
- }
446
- ]
447
- },
448
- {
449
- "kind": "javascript-module",
450
- "path": "src/design-system/index.ts",
451
- "declarations": [],
452
- "exports": [
453
- {
454
- "kind": "js",
455
- "name": "*",
456
- "declaration": {
457
- "name": "*",
458
- "package": "./design-system"
459
- }
460
- }
461
- ]
462
- },
463
215
  {
464
216
  "kind": "javascript-module",
465
217
  "path": "src/directives/index.ts",
@@ -905,6 +657,254 @@
905
657
  }
906
658
  ]
907
659
  },
660
+ {
661
+ "kind": "javascript-module",
662
+ "path": "src/data/inMemoryDatabase.ts",
663
+ "declarations": [
664
+ {
665
+ "kind": "class",
666
+ "description": "An in memory database of specific DatabaseRecord types.",
667
+ "name": "InMemoryDatabase",
668
+ "members": [
669
+ {
670
+ "kind": "field",
671
+ "name": "isWorking",
672
+ "type": {
673
+ "text": "boolean"
674
+ },
675
+ "privacy": "public",
676
+ "default": "false"
677
+ },
678
+ {
679
+ "kind": "field",
680
+ "name": "records",
681
+ "type": {
682
+ "text": "Record<string, T>"
683
+ },
684
+ "privacy": "private",
685
+ "default": "{}"
686
+ },
687
+ {
688
+ "kind": "field",
689
+ "name": "beforeUpdateListeners",
690
+ "privacy": "private"
691
+ },
692
+ {
693
+ "kind": "field",
694
+ "name": "afterUpdateListeners",
695
+ "privacy": "private"
696
+ },
697
+ {
698
+ "kind": "method",
699
+ "name": "create",
700
+ "privacy": "public",
701
+ "return": {
702
+ "type": {
703
+ "text": "Promise<DatabaseAccessResult.Create<T>>"
704
+ }
705
+ },
706
+ "parameters": [
707
+ {
708
+ "name": "newValue",
709
+ "type": {
710
+ "text": "Omit<T, 'id'>"
711
+ }
712
+ }
713
+ ]
714
+ },
715
+ {
716
+ "kind": "method",
717
+ "name": "read",
718
+ "privacy": "public",
719
+ "return": {
720
+ "type": {
721
+ "text": "Promise<DatabaseAccessResult.Read<T>>"
722
+ }
723
+ },
724
+ "parameters": [
725
+ {
726
+ "name": "id",
727
+ "type": {
728
+ "text": "string"
729
+ }
730
+ }
731
+ ]
732
+ },
733
+ {
734
+ "kind": "method",
735
+ "name": "update",
736
+ "privacy": "public",
737
+ "return": {
738
+ "type": {
739
+ "text": "Promise<DatabaseAccessResult.Update<T>>"
740
+ }
741
+ },
742
+ "parameters": [
743
+ {
744
+ "name": "id",
745
+ "type": {
746
+ "text": "string"
747
+ }
748
+ },
749
+ {
750
+ "name": "newValue",
751
+ "type": {
752
+ "text": "Omit<Partial<T>, 'id'>"
753
+ }
754
+ }
755
+ ]
756
+ },
757
+ {
758
+ "kind": "method",
759
+ "name": "delete",
760
+ "privacy": "public",
761
+ "return": {
762
+ "type": {
763
+ "text": "Promise<DatabaseAccessResult.Delete>"
764
+ }
765
+ },
766
+ "parameters": [
767
+ {
768
+ "name": "id",
769
+ "type": {
770
+ "text": "string"
771
+ }
772
+ }
773
+ ]
774
+ },
775
+ {
776
+ "kind": "method",
777
+ "name": "visit",
778
+ "privacy": "public",
779
+ "return": {
780
+ "type": {
781
+ "text": "Promise<void>"
782
+ }
783
+ },
784
+ "parameters": [
785
+ {
786
+ "name": "visitor",
787
+ "type": {
788
+ "text": "(record: T) => void"
789
+ }
790
+ }
791
+ ]
792
+ },
793
+ {
794
+ "kind": "method",
795
+ "name": "onBeforeUpdate",
796
+ "privacy": "public",
797
+ "return": {
798
+ "type": {
799
+ "text": "() => void"
800
+ }
801
+ },
802
+ "parameters": [
803
+ {
804
+ "name": "listener",
805
+ "type": {
806
+ "text": "Listener<DatabaseEvent.BeforeUpdate<T>>"
807
+ }
808
+ }
809
+ ]
810
+ },
811
+ {
812
+ "kind": "method",
813
+ "name": "onAfterUpdate",
814
+ "privacy": "public",
815
+ "return": {
816
+ "type": {
817
+ "text": "() => void"
818
+ }
819
+ },
820
+ "parameters": [
821
+ {
822
+ "name": "listener",
823
+ "type": {
824
+ "text": "Listener<DatabaseEvent.AfterUpdate<T>>"
825
+ }
826
+ }
827
+ ]
828
+ }
829
+ ]
830
+ }
831
+ ],
832
+ "exports": [
833
+ {
834
+ "kind": "js",
835
+ "name": "InMemoryDatabase",
836
+ "declaration": {
837
+ "name": "InMemoryDatabase",
838
+ "module": "src/data/inMemoryDatabase.ts"
839
+ }
840
+ }
841
+ ]
842
+ },
843
+ {
844
+ "kind": "javascript-module",
845
+ "path": "src/data/index.ts",
846
+ "declarations": [],
847
+ "exports": [
848
+ {
849
+ "kind": "js",
850
+ "name": "*",
851
+ "declaration": {
852
+ "name": "*",
853
+ "package": "./inMemoryDatabase"
854
+ }
855
+ }
856
+ ]
857
+ },
858
+ {
859
+ "kind": "javascript-module",
860
+ "path": "src/design-system/design-system.ts",
861
+ "declarations": [
862
+ {
863
+ "kind": "function",
864
+ "name": "assureDesignSystem",
865
+ "return": {
866
+ "type": {
867
+ "text": "DesignSystemModule"
868
+ }
869
+ },
870
+ "parameters": [
871
+ {
872
+ "name": "module",
873
+ "type": {
874
+ "text": "DesignSystemModule"
875
+ }
876
+ }
877
+ ],
878
+ "description": "assureDesignSystem.",
879
+ "privacy": "public"
880
+ }
881
+ ],
882
+ "exports": [
883
+ {
884
+ "kind": "js",
885
+ "name": "assureDesignSystem",
886
+ "declaration": {
887
+ "name": "assureDesignSystem",
888
+ "module": "src/design-system/design-system.ts"
889
+ }
890
+ }
891
+ ]
892
+ },
893
+ {
894
+ "kind": "javascript-module",
895
+ "path": "src/design-system/index.ts",
896
+ "declarations": [],
897
+ "exports": [
898
+ {
899
+ "kind": "js",
900
+ "name": "*",
901
+ "declaration": {
902
+ "name": "*",
903
+ "package": "./design-system"
904
+ }
905
+ }
906
+ ]
907
+ },
908
908
  {
909
909
  "kind": "javascript-module",
910
910
  "path": "src/formatters/datetime.ts",
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-utils",
3
3
  "description": "Genesis Foundation Utils",
4
- "version": "14.179.0",
4
+ "version": "14.180.1",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -19,17 +19,17 @@
19
19
  "test": "genx test"
20
20
  },
21
21
  "devDependencies": {
22
- "@genesislcap/foundation-testing": "14.179.0",
23
- "@genesislcap/genx": "14.179.0",
24
- "@genesislcap/rollup-builder": "14.179.0",
25
- "@genesislcap/ts-builder": "14.179.0",
26
- "@genesislcap/uvu-playwright-builder": "14.179.0",
27
- "@genesislcap/vite-builder": "14.179.0",
28
- "@genesislcap/webpack-builder": "14.179.0",
22
+ "@genesislcap/foundation-testing": "14.180.1",
23
+ "@genesislcap/genx": "14.180.1",
24
+ "@genesislcap/rollup-builder": "14.180.1",
25
+ "@genesislcap/ts-builder": "14.180.1",
26
+ "@genesislcap/uvu-playwright-builder": "14.180.1",
27
+ "@genesislcap/vite-builder": "14.180.1",
28
+ "@genesislcap/webpack-builder": "14.180.1",
29
29
  "rimraf": "^3.0.2"
30
30
  },
31
31
  "dependencies": {
32
- "@genesislcap/foundation-logger": "14.179.0",
32
+ "@genesislcap/foundation-logger": "14.180.1",
33
33
  "@microsoft/fast-components": "^2.30.6",
34
34
  "@microsoft/fast-element": "^1.12.0",
35
35
  "@microsoft/fast-foundation": "^2.49.4",
@@ -47,5 +47,5 @@
47
47
  "access": "public"
48
48
  },
49
49
  "customElements": "dist/custom-elements.json",
50
- "gitHead": "fbb42975b9ecb82eac233685b37b0fa8118e2467"
50
+ "gitHead": "ea64c8fdf01822c686617271eb721b448c82f8c0"
51
51
  }