@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,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) > [activeColorScheme](./foundation-utils.activecolorscheme.md)
|
|
4
|
+
|
|
5
|
+
## activeColorScheme variable
|
|
6
|
+
|
|
7
|
+
A design token that represents the active color scheme (light or dark).
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
activeColorScheme: import("@microsoft/fast-foundation").CSSDesignToken<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) > [API\_HOST](./foundation-utils.api_host.md)
|
|
4
|
+
|
|
5
|
+
## API\_HOST variable
|
|
6
|
+
|
|
7
|
+
The Genesis Server (host0 to establish a connection (WebSocket or HTTP)). Example: wss://localhost:9064
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
_API_HOST: string
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Remarks
|
|
16
|
+
|
|
17
|
+
Required.
|
|
18
|
+
|
|
@@ -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) > [assureDesignSystem](./foundation-utils.assuredesignsystem.md)
|
|
4
|
+
|
|
5
|
+
## assureDesignSystem() function
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
**Signature:**
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
export declare function assureDesignSystem(module: DesignSystemModule): DesignSystemModule;
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Parameters
|
|
15
|
+
|
|
16
|
+
| Parameter | Type | Description |
|
|
17
|
+
| --- | --- | --- |
|
|
18
|
+
| module | [DesignSystemModule](./foundation-utils.designsystemmodule.md) | |
|
|
19
|
+
|
|
20
|
+
**Returns:**
|
|
21
|
+
|
|
22
|
+
[DesignSystemModule](./foundation-utils.designsystemmodule.md)
|
|
23
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [ConstructableLifecycleHandler](./foundation-utils.constructablelifecyclehandler.md)
|
|
4
|
+
|
|
5
|
+
## ConstructableLifecycleHandler type
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
**Signature:**
|
|
9
|
+
|
|
10
|
+
```typescript
|
|
11
|
+
export type ConstructableLifecycleHandler = Constructable<FASTElement & HTMLElement>;
|
|
12
|
+
```
|
|
@@ -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) > [ConstructablePendingState](./foundation-utils.constructablependingstate.md)
|
|
4
|
+
|
|
5
|
+
## ConstructablePendingState type
|
|
6
|
+
|
|
7
|
+
A mixin that provides functionality for raising `pending-state` events.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare type ConstructablePendingState = Constructable<FASTElement & HTMLElement>;
|
|
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) > [ConversionType](./foundation-utils.conversiontype.md)
|
|
4
|
+
|
|
5
|
+
## ConversionType type
|
|
6
|
+
|
|
7
|
+
Represents the possible types of value conversion for data synchronization.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export type ConversionType = 'string' | 'number' | 'time' | 'boolean';
|
|
13
|
+
```
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [createLogger](./foundation-utils.createlogger.md)
|
|
4
|
+
|
|
5
|
+
## createLogger() function
|
|
6
|
+
|
|
7
|
+
Creates a logger with the given name and options.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare function createLogger(name: string, options?: LoggerOptions): Logger;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Parameters
|
|
16
|
+
|
|
17
|
+
| Parameter | Type | Description |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| name | string | The name to give the logger. |
|
|
20
|
+
| options | [LoggerOptions](./foundation-utils.loggeroptions.md) | _(Optional)_ The options to use when creating the logger. |
|
|
21
|
+
|
|
22
|
+
**Returns:**
|
|
23
|
+
|
|
24
|
+
[Logger](./foundation-utils.logger.md)
|
|
25
|
+
|
|
26
|
+
The resulting logger.
|
|
27
|
+
|
|
@@ -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) > [createObserver](./foundation-utils.createobserver.md)
|
|
4
|
+
|
|
5
|
+
## createObserver variable
|
|
6
|
+
|
|
7
|
+
Creates a new event observer instance.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
createObserver: <EventType>() => Observer<EventType>
|
|
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) > [Database](./foundation-utils.database.md) > [create](./foundation-utils.database.create.md)
|
|
4
|
+
|
|
5
|
+
## Database.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) > [Database](./foundation-utils.database.md) > [delete](./foundation-utils.database.delete.md)
|
|
4
|
+
|
|
5
|
+
## Database.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) > [Database](./foundation-utils.database.md) > [isWorking](./foundation-utils.database.isworking.md)
|
|
4
|
+
|
|
5
|
+
## Database.isWorking property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
isWorking: boolean;
|
|
11
|
+
```
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-utils](./foundation-utils.md) > [Database](./foundation-utils.database.md)
|
|
4
|
+
|
|
5
|
+
## Database interface
|
|
6
|
+
|
|
7
|
+
Represents a database with basic CRUD operations.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface Database<T extends DatabaseRecord>
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Modifiers | Type | Description |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| [isWorking](./foundation-utils.database.isworking.md) | | boolean | |
|
|
20
|
+
|
|
21
|
+
## Methods
|
|
22
|
+
|
|
23
|
+
| Method | Description |
|
|
24
|
+
| --- | --- |
|
|
25
|
+
| [create(newValue)](./foundation-utils.database.create.md) | |
|
|
26
|
+
| [delete(id)](./foundation-utils.database.delete.md) | |
|
|
27
|
+
| [onAfterUpdate(listener)](./foundation-utils.database.onafterupdate.md) | |
|
|
28
|
+
| [onBeforeUpdate(listener)](./foundation-utils.database.onbeforeupdate.md) | |
|
|
29
|
+
| [read(id)](./foundation-utils.database.read.md) | |
|
|
30
|
+
| [update(id, newValue)](./foundation-utils.database.update.md) | |
|
|
31
|
+
| [visit(visitor)](./foundation-utils.database.visit.md) | |
|
|
32
|
+
|
|
@@ -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) > [Database](./foundation-utils.database.md) > [onAfterUpdate](./foundation-utils.database.onafterupdate.md)
|
|
4
|
+
|
|
5
|
+
## Database.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) > [Database](./foundation-utils.database.md) > [onBeforeUpdate](./foundation-utils.database.onbeforeupdate.md)
|
|
4
|
+
|
|
5
|
+
## Database.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) > [Database](./foundation-utils.database.md) > [read](./foundation-utils.database.read.md)
|
|
4
|
+
|
|
5
|
+
## Database.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) > [Database](./foundation-utils.database.md) > [update](./foundation-utils.database.update.md)
|
|
4
|
+
|
|
5
|
+
## Database.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
|
+
|
|
@@ -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) > [Database](./foundation-utils.database.md) > [visit](./foundation-utils.database.visit.md)
|
|
4
|
+
|
|
5
|
+
## Database.visit() method
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
visit(visitor: (record: T) => void): Promise<void>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
| Parameter | Type | Description |
|
|
16
|
+
| --- | --- | --- |
|
|
17
|
+
| visitor | (record: T) => void | |
|
|
18
|
+
|
|
19
|
+
**Returns:**
|
|
20
|
+
|
|
21
|
+
Promise<void>
|
|
22
|
+
|
|
@@ -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) > [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) > [Access](./foundation-utils.databaseaccessresult.access.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseAccessResult.Access interface
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
interface Access<T>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
| Property | Modifiers | Type | Description |
|
|
16
|
+
| --- | --- | --- | --- |
|
|
17
|
+
| [value](./foundation-utils.databaseaccessresult.access.value.md) | | T | |
|
|
18
|
+
|
|
@@ -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) > [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) > [Access](./foundation-utils.databaseaccessresult.access.md) > [value](./foundation-utils.databaseaccessresult.access.value.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseAccessResult.Access.value property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
value: T;
|
|
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) > [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) > [Create](./foundation-utils.databaseaccessresult.create.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseAccessResult.Create interface
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export interface Create<T> extends Access<T>
|
|
11
|
+
```
|
|
12
|
+
**Extends:** Access<T>
|
|
13
|
+
|
|
@@ -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) > [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) > [Delete](./foundation-utils.databaseaccessresult.delete.md) > [id](./foundation-utils.databaseaccessresult.delete.id.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseAccessResult.Delete.id property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
id: string;
|
|
11
|
+
```
|
|
@@ -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) > [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) > [Delete](./foundation-utils.databaseaccessresult.delete.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseAccessResult.Delete interface
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export interface Delete
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
| Property | Modifiers | Type | Description |
|
|
16
|
+
| --- | --- | --- | --- |
|
|
17
|
+
| [id](./foundation-utils.databaseaccessresult.delete.id.md) | | string | |
|
|
18
|
+
| [success](./foundation-utils.databaseaccessresult.delete.success.md) | | boolean | |
|
|
19
|
+
|
|
@@ -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) > [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) > [Delete](./foundation-utils.databaseaccessresult.delete.md) > [success](./foundation-utils.databaseaccessresult.delete.success.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseAccessResult.Delete.success property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
success: boolean;
|
|
11
|
+
```
|
|
@@ -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) > [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseAccessResult namespace
|
|
6
|
+
|
|
7
|
+
Namespace for database access result types.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare namespace DatabaseAccessResult
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Interfaces
|
|
16
|
+
|
|
17
|
+
| Interface | Description |
|
|
18
|
+
| --- | --- |
|
|
19
|
+
| [Access](./foundation-utils.databaseaccessresult.access.md) | |
|
|
20
|
+
| [Create](./foundation-utils.databaseaccessresult.create.md) | |
|
|
21
|
+
| [Delete](./foundation-utils.databaseaccessresult.delete.md) | |
|
|
22
|
+
| [Read](./foundation-utils.databaseaccessresult.read.md) | |
|
|
23
|
+
| [Update](./foundation-utils.databaseaccessresult.update.md) | |
|
|
24
|
+
|
|
@@ -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) > [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) > [Read](./foundation-utils.databaseaccessresult.read.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseAccessResult.Read interface
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export interface Read<T> extends Access<T>
|
|
11
|
+
```
|
|
12
|
+
**Extends:** Access<T>
|
|
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) > [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) > [Update](./foundation-utils.databaseaccessresult.update.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseAccessResult.Update interface
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export interface Update<T> extends Access<T>
|
|
11
|
+
```
|
|
12
|
+
**Extends:** Access<T>
|
|
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) > [DatabaseEvent](./foundation-utils.databaseevent.md) > [AfterUpdate](./foundation-utils.databaseevent.afterupdate.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseEvent.AfterUpdate interface
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export interface AfterUpdate<T> extends Update<T>
|
|
11
|
+
```
|
|
12
|
+
**Extends:** Update<T>
|
|
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) > [DatabaseEvent](./foundation-utils.databaseevent.md) > [BeforeUpdate](./foundation-utils.databaseevent.beforeupdate.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseEvent.BeforeUpdate interface
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
export interface BeforeUpdate<T> extends Update<T>
|
|
11
|
+
```
|
|
12
|
+
**Extends:** Update<T>
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
| Property | Modifiers | Type | Description |
|
|
17
|
+
| --- | --- | --- | --- |
|
|
18
|
+
| [newValue](./foundation-utils.databaseevent.beforeupdate.newvalue.md) | | T | |
|
|
19
|
+
|
|
@@ -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) > [DatabaseEvent](./foundation-utils.databaseevent.md) > [BeforeUpdate](./foundation-utils.databaseevent.beforeupdate.md) > [newValue](./foundation-utils.databaseevent.beforeupdate.newvalue.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseEvent.BeforeUpdate.newValue property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
newValue: T;
|
|
11
|
+
```
|
|
@@ -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) > [DatabaseEvent](./foundation-utils.databaseevent.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseEvent namespace
|
|
6
|
+
|
|
7
|
+
Namespace for database events.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export declare namespace DatabaseEvent
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Interfaces
|
|
16
|
+
|
|
17
|
+
| Interface | Description |
|
|
18
|
+
| --- | --- |
|
|
19
|
+
| [AfterUpdate](./foundation-utils.databaseevent.afterupdate.md) | |
|
|
20
|
+
| [BeforeUpdate](./foundation-utils.databaseevent.beforeupdate.md) | |
|
|
21
|
+
| [Update](./foundation-utils.databaseevent.update.md) | |
|
|
22
|
+
|
|
@@ -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) > [DatabaseEvent](./foundation-utils.databaseevent.md) > [Update](./foundation-utils.databaseevent.update.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseEvent.Update interface
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
interface Update<T>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
| Property | Modifiers | Type | Description |
|
|
16
|
+
| --- | --- | --- | --- |
|
|
17
|
+
| [value](./foundation-utils.databaseevent.update.value.md) | | T | |
|
|
18
|
+
|
|
@@ -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) > [DatabaseEvent](./foundation-utils.databaseevent.md) > [Update](./foundation-utils.databaseevent.update.md) > [value](./foundation-utils.databaseevent.update.value.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseEvent.Update.value property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
value: T;
|
|
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) > [DatabaseRecord](./foundation-utils.databaserecord.md) > [id](./foundation-utils.databaserecord.id.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseRecord.id property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
id: string;
|
|
11
|
+
```
|
|
@@ -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) > [DatabaseRecord](./foundation-utils.databaserecord.md)
|
|
4
|
+
|
|
5
|
+
## DatabaseRecord interface
|
|
6
|
+
|
|
7
|
+
Represents a database record.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface DatabaseRecord
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Modifiers | Type | Description |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| [id](./foundation-utils.databaserecord.id.md) | | string | |
|
|
20
|
+
|
|
@@ -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\_ORGANISATION](./foundation-utils.default_organisation.md)
|
|
4
|
+
|
|
5
|
+
## DEFAULT\_ORGANISATION variable
|
|
6
|
+
|
|
7
|
+
The default Organisation value, used in auth/login flow \[`genesislcap-foundation-login`<!-- -->\](https://link-to-docs).
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
_DEFAULT_ORGANISATION: string
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Remarks
|
|
16
|
+
|
|
17
|
+
Optional.
|
|
18
|
+
|