@genesislcap/foundation-utils 14.22.1 → 14.23.0
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/dist/custom-elements.json +286 -169
- package/dist/dts/data/inMemoryDatabase.d.ts +17 -0
- package/dist/dts/data/inMemoryDatabase.d.ts.map +1 -1
- package/dist/dts/directives/sync/sync.d.ts +16 -0
- package/dist/dts/directives/sync/sync.d.ts.map +1 -1
- package/dist/dts/directives/when-else/when-else.d.ts +1 -1
- package/dist/dts/env/is-dev.d.ts +4 -0
- package/dist/dts/env/is-dev.d.ts.map +1 -1
- package/dist/dts/env/variables.d.ts +37 -0
- package/dist/dts/env/variables.d.ts.map +1 -1
- package/dist/dts/formatters/datetime.d.ts +2 -2
- package/dist/dts/logger/logger.d.ts +29 -3
- package/dist/dts/logger/logger.d.ts.map +1 -1
- package/dist/dts/mappers/dto/serverRow.d.ts +46 -14
- package/dist/dts/mappers/dto/serverRow.d.ts.map +1 -1
- package/dist/dts/mappers/dto/types.d.ts +3 -0
- package/dist/dts/mappers/dto/types.d.ts.map +1 -1
- package/dist/dts/mixins/lifecycle/lifecycle.d.ts +11 -5
- package/dist/dts/mixins/lifecycle/lifecycle.d.ts.map +1 -1
- package/dist/dts/mixins/pendingState/pendingState.d.ts +55 -9
- package/dist/dts/mixins/pendingState/pendingState.d.ts.map +1 -1
- package/dist/dts/observer/observer.d.ts +19 -4
- package/dist/dts/observer/observer.d.ts.map +1 -1
- package/dist/dts/resource/types.d.ts +2 -0
- package/dist/dts/resource/types.d.ts.map +1 -1
- package/dist/dts/serializers/json/json.d.ts +28 -0
- package/dist/dts/serializers/json/json.d.ts.map +1 -1
- package/dist/dts/styles/color.d.ts +4 -0
- package/dist/dts/styles/color.d.ts.map +1 -1
- package/dist/dts/styles/dom.d.ts +13 -0
- package/dist/dts/styles/dom.d.ts.map +1 -1
- package/dist/dts/styles/slotted-styles.d.ts +13 -0
- package/dist/dts/styles/slotted-styles.d.ts.map +1 -1
- package/dist/dts/styles/typography.d.ts +27 -1
- package/dist/dts/styles/typography.d.ts.map +1 -1
- package/dist/dts/tsdoc-metadata.json +11 -0
- package/dist/dts/uuid/uuid.d.ts +22 -3
- package/dist/dts/uuid/uuid.d.ts.map +1 -1
- package/dist/dts/window/window.d.ts +27 -0
- package/dist/dts/window/window.d.ts.map +1 -1
- package/dist/esm/data/inMemoryDatabase.js +1 -0
- package/dist/esm/directives/sync/sync.js +8 -0
- package/dist/esm/directives/when-else/when-else.js +1 -1
- package/dist/esm/env/is-dev.js +4 -0
- package/dist/esm/env/variables.js +37 -0
- package/dist/esm/formatters/datetime.js +2 -2
- package/dist/esm/logger/logger.js +11 -0
- package/dist/esm/mappers/dto/serverRow.js +20 -0
- package/dist/esm/mixins/pendingState/pendingState.js +37 -1
- package/dist/esm/observer/observer.js +5 -1
- package/dist/esm/resource/types.js +1 -0
- package/dist/esm/serializers/json/json.js +14 -0
- package/dist/esm/styles/color.js +11 -1
- package/dist/esm/styles/dom.js +13 -0
- package/dist/esm/styles/slotted-styles.js +13 -0
- package/dist/esm/styles/typography.js +26 -0
- package/dist/esm/uuid/uuid.js +20 -11
- package/dist/esm/window/window.js +27 -0
- package/dist/foundation-utils.api.json +10996 -0
- package/dist/foundation-utils.d.ts +1462 -0
- package/docs/api/foundation-utils.activecolorscheme.md +13 -0
- package/docs/api/foundation-utils.api_host.md +18 -0
- package/docs/api/foundation-utils.assuredesignsystem.md +23 -0
- package/docs/api/foundation-utils.constructablelifecyclehandler.md +12 -0
- package/docs/api/foundation-utils.constructablependingstate.md +13 -0
- package/docs/api/foundation-utils.conversiontype.md +13 -0
- package/docs/api/foundation-utils.createlogger.md +27 -0
- package/docs/api/foundation-utils.createobserver.md +13 -0
- package/docs/api/foundation-utils.database.create.md +22 -0
- package/docs/api/foundation-utils.database.delete.md +22 -0
- package/docs/api/foundation-utils.database.isworking.md +11 -0
- package/docs/api/foundation-utils.database.md +32 -0
- package/docs/api/foundation-utils.database.onafterupdate.md +22 -0
- package/docs/api/foundation-utils.database.onbeforeupdate.md +22 -0
- package/docs/api/foundation-utils.database.read.md +22 -0
- package/docs/api/foundation-utils.database.update.md +23 -0
- package/docs/api/foundation-utils.database.visit.md +22 -0
- package/docs/api/foundation-utils.databaseaccessresult.access.md +18 -0
- package/docs/api/foundation-utils.databaseaccessresult.access.value.md +11 -0
- package/docs/api/foundation-utils.databaseaccessresult.create.md +13 -0
- package/docs/api/foundation-utils.databaseaccessresult.delete.id.md +11 -0
- package/docs/api/foundation-utils.databaseaccessresult.delete.md +19 -0
- package/docs/api/foundation-utils.databaseaccessresult.delete.success.md +11 -0
- package/docs/api/foundation-utils.databaseaccessresult.md +24 -0
- package/docs/api/foundation-utils.databaseaccessresult.read.md +13 -0
- package/docs/api/foundation-utils.databaseaccessresult.update.md +13 -0
- package/docs/api/foundation-utils.databaseevent.afterupdate.md +13 -0
- package/docs/api/foundation-utils.databaseevent.beforeupdate.md +19 -0
- package/docs/api/foundation-utils.databaseevent.beforeupdate.newvalue.md +11 -0
- package/docs/api/foundation-utils.databaseevent.md +22 -0
- package/docs/api/foundation-utils.databaseevent.update.md +18 -0
- package/docs/api/foundation-utils.databaseevent.update.value.md +11 -0
- package/docs/api/foundation-utils.databaserecord.id.md +11 -0
- package/docs/api/foundation-utils.databaserecord.md +20 -0
- package/docs/api/foundation-utils.default_organisation.md +18 -0
- package/docs/api/foundation-utils.default_password.md +18 -0
- package/docs/api/foundation-utils.default_user.md +18 -0
- package/docs/api/foundation-utils.defaulteventmap.md +13 -0
- package/docs/api/foundation-utils.defaultloggeroptions.md +13 -0
- package/docs/api/foundation-utils.defaultserverrowdtomapper.fromdto.md +13 -0
- package/docs/api/foundation-utils.defaultserverrowdtomapper.md +22 -0
- package/docs/api/foundation-utils.defaultserverrowdtomapper.todto.md +13 -0
- package/docs/api/foundation-utils.designsystemmodule.md +19 -0
- package/docs/api/foundation-utils.designsystemmodule.providedesignsystem.md +23 -0
- package/docs/api/foundation-utils.designsystemresource.md +14 -0
- package/docs/api/foundation-utils.dtomapper.fromargs.md +11 -0
- package/docs/api/foundation-utils.dtomapper.fromdto.md +11 -0
- package/docs/api/foundation-utils.dtomapper.md +21 -0
- package/docs/api/foundation-utils.dtomapper.todto.md +11 -0
- package/docs/api/foundation-utils.eventname.md +13 -0
- package/docs/api/foundation-utils.fontstyle.md +21 -0
- package/docs/api/foundation-utils.fontweight.md +25 -0
- package/docs/api/foundation-utils.force_http.md +18 -0
- package/docs/api/foundation-utils.formatdatetimestamp.md +24 -0
- package/docs/api/foundation-utils.formatdatetimetimestamp.md +24 -0
- package/docs/api/foundation-utils.formattimestamp.md +25 -0
- package/docs/api/foundation-utils.getfontmixin.md +13 -0
- package/docs/api/foundation-utils.http_config.md +18 -0
- package/docs/api/foundation-utils.iniframe.md +13 -0
- package/docs/api/foundation-utils.inmemorydatabase._constructor_.md +20 -0
- package/docs/api/foundation-utils.inmemorydatabase.create.md +22 -0
- package/docs/api/foundation-utils.inmemorydatabase.delete.md +22 -0
- package/docs/api/foundation-utils.inmemorydatabase.isworking.md +11 -0
- package/docs/api/foundation-utils.inmemorydatabase.md +39 -0
- package/docs/api/foundation-utils.inmemorydatabase.onafterupdate.md +22 -0
- package/docs/api/foundation-utils.inmemorydatabase.onbeforeupdate.md +22 -0
- package/docs/api/foundation-utils.inmemorydatabase.read.md +22 -0
- package/docs/api/foundation-utils.inmemorydatabase.update.md +23 -0
- package/docs/api/foundation-utils.inmemorydatabase.visit.md +22 -0
- package/docs/api/foundation-utils.insertdocumentcssrule.md +13 -0
- package/docs/api/foundation-utils.insertdocumentlink.md +13 -0
- package/docs/api/foundation-utils.insymphonydesktop.md +13 -0
- package/docs/api/foundation-utils.isdev.md +13 -0
- package/docs/api/foundation-utils.jsonserializer.deserialize.md +26 -0
- package/docs/api/foundation-utils.jsonserializer.deserialize_1.md +26 -0
- package/docs/api/foundation-utils.jsonserializer.deserialize_2.md +26 -0
- package/docs/api/foundation-utils.jsonserializer.md +13 -0
- package/docs/api/foundation-utils.jsonserializer.serialize.md +26 -0
- package/docs/api/foundation-utils.layoutcachedocument.md +13 -0
- package/docs/api/foundation-utils.lifecyclemixin.md +342 -0
- package/docs/api/foundation-utils.listener.md +13 -0
- package/docs/api/foundation-utils.loadfontfaces.md +13 -0
- package/docs/api/foundation-utils.logger.deprecated.md +45 -0
- package/docs/api/foundation-utils.logger.md +25 -0
- package/docs/api/foundation-utils.loggeroptions.md +15 -0
- package/docs/api/foundation-utils.md +111 -0
- package/docs/api/foundation-utils.observer.md +21 -0
- package/docs/api/foundation-utils.observer.publish.md +11 -0
- package/docs/api/foundation-utils.observer.subscribe.md +11 -0
- package/docs/api/foundation-utils.openpopup.md +13 -0
- package/docs/api/foundation-utils.pendingstate.md +334 -0
- package/docs/api/foundation-utils.pendingstateerrorevent.md +13 -0
- package/docs/api/foundation-utils.pendingstateevent.md +13 -0
- package/docs/api/foundation-utils.pendingstateevents.md +21 -0
- package/docs/api/foundation-utils.popup_default_height.md +13 -0
- package/docs/api/foundation-utils.popup_default_width.md +13 -0
- package/docs/api/foundation-utils.publish.md +13 -0
- package/docs/api/foundation-utils.renderonchange.md +51 -0
- package/docs/api/foundation-utils.resourcetype.md +16 -0
- package/docs/api/foundation-utils.respondtovisibility.md +13 -0
- package/docs/api/foundation-utils.serverrowdto.md +18 -0
- package/docs/api/foundation-utils.serverrowdtomapper.md +13 -0
- package/docs/api/foundation-utils.serverrowentity.md +18 -0
- package/docs/api/foundation-utils.slottedstyles.md +27 -0
- package/docs/api/foundation-utils.slottedstyles.styles.md +13 -0
- package/docs/api/foundation-utils.slottedstyles.styleschanged.md +25 -0
- package/docs/api/foundation-utils.socket_ext.md +18 -0
- package/docs/api/foundation-utils.subscribe.md +15 -0
- package/docs/api/foundation-utils.sync.md +27 -0
- package/docs/api/foundation-utils.typerampvalues.md +22 -0
- package/docs/api/foundation-utils.uuid.createid.md +26 -0
- package/docs/api/foundation-utils.uuid.createremoteid.md +26 -0
- package/docs/api/foundation-utils.uuid.md +13 -0
- package/docs/api/foundation-utils.uuidconfig.md +13 -0
- package/docs/api/foundation-utils.whenelse.md +26 -0
- package/docs/api/index.md +12 -0
- package/docs/api-report.md +1075 -0
- package/package.json +6 -9
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [DEFAULT\_PASSWORD](./foundation-utils.default_password.md)
|
|
4
|
+
|
|
5
|
+
## DEFAULT\_PASSWORD variable
|
|
6
|
+
|
|
7
|
+
The default Password value, used in auth/login flow \[`genesislcap-foundation-login`<!-- -->\](https://link-to-docs).
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
_DEFAULT_PASSWORD: string
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Remarks
|
|
16
|
+
|
|
17
|
+
Optional.
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [DEFAULT\_USER](./foundation-utils.default_user.md)
|
|
4
|
+
|
|
5
|
+
## DEFAULT\_USER variable
|
|
6
|
+
|
|
7
|
+
The default Username value, used in auth/login flow \[`genesislcap-foundation-login`<!-- -->\](https://link-to-docs).
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
_DEFAULT_USER: string
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Remarks
|
|
16
|
+
|
|
17
|
+
Optional.
|
|
18
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [defaultEventMap](./foundation-utils.defaulteventmap.md)
|
|
4
|
+
|
|
5
|
+
## defaultEventMap variable
|
|
6
|
+
|
|
7
|
+
A map that associates specific HTML element tags with their corresponding default event names.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
defaultEventMap: Map<string, EventName>
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [defaultLoggerOptions](./foundation-utils.defaultloggeroptions.md)
|
|
4
|
+
|
|
5
|
+
## defaultLoggerOptions variable
|
|
6
|
+
|
|
7
|
+
The default logger options.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
defaultLoggerOptions: LoggerOptions
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [DefaultServerRowDTOMapper](./foundation-utils.defaultserverrowdtomapper.md) > [fromDTO](./foundation-utils.defaultserverrowdtomapper.fromdto.md)
|
|
4
|
+
|
|
5
|
+
## DefaultServerRowDTOMapper.fromDTO property
|
|
6
|
+
|
|
7
|
+
Converts a server row DTO to an entity.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
fromDTO: (dto: ServerRowDTO) => ServerRowEntity;
|
|
13
|
+
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [DefaultServerRowDTOMapper](./foundation-utils.defaultserverrowdtomapper.md)
|
|
4
|
+
|
|
5
|
+
## DefaultServerRowDTOMapper class
|
|
6
|
+
|
|
7
|
+
The default `ServerRowDTOMapper`<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare class DefaultServerRowDTOMapper implements ServerRowDTOMapper
|
|
13
|
+
```
|
|
14
|
+
**Implements:** [ServerRowDTOMapper](./foundation-utils.serverrowdtomapper.md)
|
|
15
|
+
|
|
16
|
+
## Properties
|
|
17
|
+
|
|
18
|
+
| Property | Modifiers | Type | Description |
|
|
19
|
+
| --- | --- | --- | --- |
|
|
20
|
+
| [fromDTO](./foundation-utils.defaultserverrowdtomapper.fromdto.md) | | (dto: [ServerRowDTO](./foundation-utils.serverrowdto.md)<!-- -->) => [ServerRowEntity](./foundation-utils.serverrowentity.md) | Converts a server row DTO to an entity. |
|
|
21
|
+
| [toDTO](./foundation-utils.defaultserverrowdtomapper.todto.md) | | (entity: [ServerRowEntity](./foundation-utils.serverrowentity.md)<!-- -->) => [ServerRowDTO](./foundation-utils.serverrowdto.md) | Converts a server row entity to a DTO. |
|
|
22
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [DefaultServerRowDTOMapper](./foundation-utils.defaultserverrowdtomapper.md) > [toDTO](./foundation-utils.defaultserverrowdtomapper.todto.md)
|
|
4
|
+
|
|
5
|
+
## DefaultServerRowDTOMapper.toDTO property
|
|
6
|
+
|
|
7
|
+
Converts a server row entity to a DTO.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
toDTO: (entity: ServerRowEntity) => ServerRowDTO;
|
|
13
|
+
```
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [DesignSystemModule](./foundation-utils.designsystemmodule.md)
|
|
4
|
+
|
|
5
|
+
## DesignSystemModule interface
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
**Signature:**
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
export interface DesignSystemModule
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Methods
|
|
15
|
+
|
|
16
|
+
| Method | Description |
|
|
17
|
+
| --- | --- |
|
|
18
|
+
| [provideDesignSystem(element, prefix)](./foundation-utils.designsystemmodule.providedesignsystem.md) | |
|
|
19
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [DesignSystemModule](./foundation-utils.designsystemmodule.md) > [provideDesignSystem](./foundation-utils.designsystemmodule.providedesignsystem.md)
|
|
4
|
+
|
|
5
|
+
## DesignSystemModule.provideDesignSystem() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
provideDesignSystem(element?: HTMLElement, prefix?: string): DesignSystem | Pick<DesignSystem, 'register'>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| element | HTMLElement | _(Optional)_ |
|
|
18
|
+
| prefix | string | _(Optional)_ |
|
|
19
|
+
|
|
20
|
+
**Returns:**
|
|
21
|
+
|
|
22
|
+
DesignSystem \| Pick<DesignSystem, 'register'>
|
|
23
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [DesignSystemResource](./foundation-utils.designsystemresource.md)
|
|
4
|
+
|
|
5
|
+
## DesignSystemResource type
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
**Signature:**
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
export type DesignSystemResource<T = DesignSystemModule> = Promise<T>;
|
|
12
|
+
```
|
|
13
|
+
**References:** [DesignSystemModule](./foundation-utils.designsystemmodule.md)
|
|
14
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [DTOMapper](./foundation-utils.dtomapper.md) > [fromArgs](./foundation-utils.dtomapper.fromargs.md)
|
|
4
|
+
|
|
5
|
+
## DTOMapper.fromArgs property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
fromArgs?: (...args: any[]) => TEntity;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [DTOMapper](./foundation-utils.dtomapper.md) > [fromDTO](./foundation-utils.dtomapper.fromdto.md)
|
|
4
|
+
|
|
5
|
+
## DTOMapper.fromDTO property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
fromDTO: (dto: TDTO) => TEntity;
|
|
11
|
+
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [DTOMapper](./foundation-utils.dtomapper.md)
|
|
4
|
+
|
|
5
|
+
## DTOMapper interface
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
**Signature:**
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
export interface DTOMapper<TDTO, TEntity>
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
| Property | Modifiers | Type | Description |
|
|
17
|
+
| --- | --- | --- | --- |
|
|
18
|
+
| [fromArgs?](./foundation-utils.dtomapper.fromargs.md) | | (...args: any\[\]) => TEntity | _(Optional)_ |
|
|
19
|
+
| [fromDTO](./foundation-utils.dtomapper.fromdto.md) | | (dto: TDTO) => TEntity | |
|
|
20
|
+
| [toDTO](./foundation-utils.dtomapper.todto.md) | | (entity: Partial<TEntity>) => TDTO | |
|
|
21
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [DTOMapper](./foundation-utils.dtomapper.md) > [toDTO](./foundation-utils.dtomapper.todto.md)
|
|
4
|
+
|
|
5
|
+
## DTOMapper.toDTO property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
toDTO: (entity: Partial<TEntity>) => TDTO;
|
|
11
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [EventName](./foundation-utils.eventname.md)
|
|
4
|
+
|
|
5
|
+
## EventName type
|
|
6
|
+
|
|
7
|
+
Represents the possible event names for data synchronization.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export type EventName = 'input' | 'change' | 'default';
|
|
13
|
+
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [FontStyle](./foundation-utils.fontstyle.md)
|
|
4
|
+
|
|
5
|
+
## FontStyle enum
|
|
6
|
+
|
|
7
|
+
An enum of possible font styles.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare enum FontStyle
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Enumeration Members
|
|
16
|
+
|
|
17
|
+
| Member | Value | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| Italic | <code>"italic"</code> | |
|
|
20
|
+
| Normal | <code>"normal"</code> | |
|
|
21
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [FontWeight](./foundation-utils.fontweight.md)
|
|
4
|
+
|
|
5
|
+
## FontWeight enum
|
|
6
|
+
|
|
7
|
+
An enum of possible font weights.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare enum FontWeight
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Enumeration Members
|
|
16
|
+
|
|
17
|
+
| Member | Value | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| Black | <code>900</code> | |
|
|
20
|
+
| Bold | <code>700</code> | |
|
|
21
|
+
| Light | <code>300</code> | |
|
|
22
|
+
| Medium | <code>500</code> | |
|
|
23
|
+
| Regular | <code>400</code> | |
|
|
24
|
+
| Thin | <code>100</code> | |
|
|
25
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [FORCE\_HTTP](./foundation-utils.force_http.md)
|
|
4
|
+
|
|
5
|
+
## FORCE\_HTTP variable
|
|
6
|
+
|
|
7
|
+
The path to a JSON config file for the HTTP mode.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
_FORCE_HTTP: string
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Remarks
|
|
16
|
+
|
|
17
|
+
Optional.
|
|
18
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [formatDateTimestamp](./foundation-utils.formatdatetimestamp.md)
|
|
4
|
+
|
|
5
|
+
## formatDateTimestamp() function
|
|
6
|
+
|
|
7
|
+
Formats \[DATE\] UNIX Timestamps (without time) to readable strings
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare function formatDateTimestamp(timestamp: number): string;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| timestamp | number | |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
string
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [formatDateTimeTimestamp](./foundation-utils.formatdatetimetimestamp.md)
|
|
4
|
+
|
|
5
|
+
## formatDateTimeTimestamp() function
|
|
6
|
+
|
|
7
|
+
Formats \[DATETIME\] UNIX Timestamps (with time) to readable strings
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare function formatDateTimeTimestamp(timestamp: number): string;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| timestamp | number | |
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
string
|
|
24
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [formatTimestamp](./foundation-utils.formattimestamp.md)
|
|
4
|
+
|
|
5
|
+
## formatTimestamp() function
|
|
6
|
+
|
|
7
|
+
Formats \[DATE\|DATETIME\] Unix Timestamps to readable strings
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare function formatTimestamp(timestamp: number, withTime: boolean): string;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| timestamp | number | The UNIX Timestamp. |
|
|
20
|
+
| withTime | boolean | The flag to determine if formatted value should contain 'time' info. |
|
|
21
|
+
|
|
22
|
+
**Returns:**
|
|
23
|
+
|
|
24
|
+
string
|
|
25
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [getFontMixin](./foundation-utils.getfontmixin.md)
|
|
4
|
+
|
|
5
|
+
## getFontMixin variable
|
|
6
|
+
|
|
7
|
+
Generates a CSS mixin for the specified font family, style, and weight.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
getFontMixin: (family: string, style?: FontStyle, weight?: FontWeight) => string
|
|
13
|
+
```
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [HTTP\_CONFIG](./foundation-utils.http_config.md)
|
|
4
|
+
|
|
5
|
+
## HTTP\_CONFIG variable
|
|
6
|
+
|
|
7
|
+
Configuration settings for HTTP, used in http connect flow \[`genesislcap-foundation-comms.HttpConnectConfig`<!-- -->\](https://link-to-docs).
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
_HTTP_CONFIG: string
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Remarks
|
|
16
|
+
|
|
17
|
+
Optional.
|
|
18
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [inIFrame](./foundation-utils.iniframe.md)
|
|
4
|
+
|
|
5
|
+
## inIFrame variable
|
|
6
|
+
|
|
7
|
+
Returns a boolean value indicating whether the current window is inside an iframe.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
inIFrame: () => boolean
|
|
13
|
+
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [InMemoryDatabase](./foundation-utils.inmemorydatabase.md) > [(constructor)](./foundation-utils.inmemorydatabase._constructor_.md)
|
|
4
|
+
|
|
5
|
+
## InMemoryDatabase.(constructor)
|
|
6
|
+
|
|
7
|
+
Constructs a new instance of the `InMemoryDatabase` class
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
constructor(uuid: UUID);
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| uuid | [UUID](./foundation-utils.uuid.md) | |
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [InMemoryDatabase](./foundation-utils.inmemorydatabase.md) > [create](./foundation-utils.inmemorydatabase.create.md)
|
|
4
|
+
|
|
5
|
+
## InMemoryDatabase.create() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
create(newValue: Omit<T, 'id'>): Promise<DatabaseAccessResult.Create<T>>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| newValue | Omit<T, 'id'> | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
Promise<[DatabaseAccessResult.Create](./foundation-utils.databaseaccessresult.create.md)<!-- --><T>>
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [InMemoryDatabase](./foundation-utils.inmemorydatabase.md) > [delete](./foundation-utils.inmemorydatabase.delete.md)
|
|
4
|
+
|
|
5
|
+
## InMemoryDatabase.delete() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
delete(id: string): Promise<DatabaseAccessResult.Delete>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| id | string | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
Promise<[DatabaseAccessResult.Delete](./foundation-utils.databaseaccessresult.delete.md)<!-- -->>
|
|
22
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [InMemoryDatabase](./foundation-utils.inmemorydatabase.md) > [isWorking](./foundation-utils.inmemorydatabase.isworking.md)
|
|
4
|
+
|
|
5
|
+
## InMemoryDatabase.isWorking property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
isWorking: boolean;
|
|
11
|
+
```
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [InMemoryDatabase](./foundation-utils.inmemorydatabase.md)
|
|
4
|
+
|
|
5
|
+
## InMemoryDatabase class
|
|
6
|
+
|
|
7
|
+
An in memory database of specific DatabaseRecord types.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare class InMemoryDatabase<T extends DatabaseRecord> implements Database<T>
|
|
13
|
+
```
|
|
14
|
+
**Implements:** [Database](./foundation-utils.database.md)<!-- --><T>
|
|
15
|
+
|
|
16
|
+
## Constructors
|
|
17
|
+
|
|
18
|
+
| Constructor | Modifiers | Description |
|
|
19
|
+
| --- | --- | --- |
|
|
20
|
+
| [(constructor)(uuid)](./foundation-utils.inmemorydatabase._constructor_.md) | | Constructs a new instance of the <code>InMemoryDatabase</code> class |
|
|
21
|
+
|
|
22
|
+
## Properties
|
|
23
|
+
|
|
24
|
+
| Property | Modifiers | Type | Description |
|
|
25
|
+
| --- | --- | --- | --- |
|
|
26
|
+
| [isWorking](./foundation-utils.inmemorydatabase.isworking.md) | | boolean | |
|
|
27
|
+
|
|
28
|
+
## Methods
|
|
29
|
+
|
|
30
|
+
| Method | Modifiers | Description |
|
|
31
|
+
| --- | --- | --- |
|
|
32
|
+
| [create(newValue)](./foundation-utils.inmemorydatabase.create.md) | | |
|
|
33
|
+
| [delete(id)](./foundation-utils.inmemorydatabase.delete.md) | | |
|
|
34
|
+
| [onAfterUpdate(listener)](./foundation-utils.inmemorydatabase.onafterupdate.md) | | |
|
|
35
|
+
| [onBeforeUpdate(listener)](./foundation-utils.inmemorydatabase.onbeforeupdate.md) | | |
|
|
36
|
+
| [read(id)](./foundation-utils.inmemorydatabase.read.md) | | |
|
|
37
|
+
| [update(id, newValue)](./foundation-utils.inmemorydatabase.update.md) | | |
|
|
38
|
+
| [visit(visitor)](./foundation-utils.inmemorydatabase.visit.md) | | |
|
|
39
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [InMemoryDatabase](./foundation-utils.inmemorydatabase.md) > [onAfterUpdate](./foundation-utils.inmemorydatabase.onafterupdate.md)
|
|
4
|
+
|
|
5
|
+
## InMemoryDatabase.onAfterUpdate() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
onAfterUpdate(listener: Listener<DatabaseEvent.AfterUpdate<T>>): () => void;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| listener | [Listener](./foundation-utils.listener.md)<!-- --><[DatabaseEvent.AfterUpdate](./foundation-utils.databaseevent.afterupdate.md)<!-- --><T>> | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
() => void
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [InMemoryDatabase](./foundation-utils.inmemorydatabase.md) > [onBeforeUpdate](./foundation-utils.inmemorydatabase.onbeforeupdate.md)
|
|
4
|
+
|
|
5
|
+
## InMemoryDatabase.onBeforeUpdate() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
onBeforeUpdate(listener: Listener<DatabaseEvent.BeforeUpdate<T>>): () => void;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| listener | [Listener](./foundation-utils.listener.md)<!-- --><[DatabaseEvent.BeforeUpdate](./foundation-utils.databaseevent.beforeupdate.md)<!-- --><T>> | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
() => void
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [InMemoryDatabase](./foundation-utils.inmemorydatabase.md) > [read](./foundation-utils.inmemorydatabase.read.md)
|
|
4
|
+
|
|
5
|
+
## InMemoryDatabase.read() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
read(id: string): Promise<DatabaseAccessResult.Read<T>>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| id | string | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
Promise<[DatabaseAccessResult.Read](./foundation-utils.databaseaccessresult.read.md)<!-- --><T>>
|
|
22
|
+
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [InMemoryDatabase](./foundation-utils.inmemorydatabase.md) > [update](./foundation-utils.inmemorydatabase.update.md)
|
|
4
|
+
|
|
5
|
+
## InMemoryDatabase.update() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
update(id: string, newValue: Omit<Partial<T>, 'id'>): Promise<DatabaseAccessResult.Update<T>>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| id | string | |
|
|
18
|
+
| newValue | Omit<Partial<T>, 'id'> | |
|
|
19
|
+
|
|
20
|
+
**Returns:**
|
|
21
|
+
|
|
22
|
+
Promise<[DatabaseAccessResult.Update](./foundation-utils.databaseaccessresult.update.md)<!-- --><T>>
|
|
23
|
+
|