@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.
Files changed (178) hide show
  1. package/dist/custom-elements.json +286 -169
  2. package/dist/dts/data/inMemoryDatabase.d.ts +17 -0
  3. package/dist/dts/data/inMemoryDatabase.d.ts.map +1 -1
  4. package/dist/dts/directives/sync/sync.d.ts +16 -0
  5. package/dist/dts/directives/sync/sync.d.ts.map +1 -1
  6. package/dist/dts/directives/when-else/when-else.d.ts +1 -1
  7. package/dist/dts/env/is-dev.d.ts +4 -0
  8. package/dist/dts/env/is-dev.d.ts.map +1 -1
  9. package/dist/dts/env/variables.d.ts +37 -0
  10. package/dist/dts/env/variables.d.ts.map +1 -1
  11. package/dist/dts/formatters/datetime.d.ts +2 -2
  12. package/dist/dts/logger/logger.d.ts +29 -3
  13. package/dist/dts/logger/logger.d.ts.map +1 -1
  14. package/dist/dts/mappers/dto/serverRow.d.ts +46 -14
  15. package/dist/dts/mappers/dto/serverRow.d.ts.map +1 -1
  16. package/dist/dts/mappers/dto/types.d.ts +3 -0
  17. package/dist/dts/mappers/dto/types.d.ts.map +1 -1
  18. package/dist/dts/mixins/lifecycle/lifecycle.d.ts +11 -5
  19. package/dist/dts/mixins/lifecycle/lifecycle.d.ts.map +1 -1
  20. package/dist/dts/mixins/pendingState/pendingState.d.ts +55 -9
  21. package/dist/dts/mixins/pendingState/pendingState.d.ts.map +1 -1
  22. package/dist/dts/observer/observer.d.ts +19 -4
  23. package/dist/dts/observer/observer.d.ts.map +1 -1
  24. package/dist/dts/resource/types.d.ts +2 -0
  25. package/dist/dts/resource/types.d.ts.map +1 -1
  26. package/dist/dts/serializers/json/json.d.ts +28 -0
  27. package/dist/dts/serializers/json/json.d.ts.map +1 -1
  28. package/dist/dts/styles/color.d.ts +4 -0
  29. package/dist/dts/styles/color.d.ts.map +1 -1
  30. package/dist/dts/styles/dom.d.ts +13 -0
  31. package/dist/dts/styles/dom.d.ts.map +1 -1
  32. package/dist/dts/styles/slotted-styles.d.ts +13 -0
  33. package/dist/dts/styles/slotted-styles.d.ts.map +1 -1
  34. package/dist/dts/styles/typography.d.ts +27 -1
  35. package/dist/dts/styles/typography.d.ts.map +1 -1
  36. package/dist/dts/tsdoc-metadata.json +11 -0
  37. package/dist/dts/uuid/uuid.d.ts +22 -3
  38. package/dist/dts/uuid/uuid.d.ts.map +1 -1
  39. package/dist/dts/window/window.d.ts +27 -0
  40. package/dist/dts/window/window.d.ts.map +1 -1
  41. package/dist/esm/data/inMemoryDatabase.js +1 -0
  42. package/dist/esm/directives/sync/sync.js +8 -0
  43. package/dist/esm/directives/when-else/when-else.js +1 -1
  44. package/dist/esm/env/is-dev.js +4 -0
  45. package/dist/esm/env/variables.js +37 -0
  46. package/dist/esm/formatters/datetime.js +2 -2
  47. package/dist/esm/logger/logger.js +11 -0
  48. package/dist/esm/mappers/dto/serverRow.js +20 -0
  49. package/dist/esm/mixins/pendingState/pendingState.js +37 -1
  50. package/dist/esm/observer/observer.js +5 -1
  51. package/dist/esm/resource/types.js +1 -0
  52. package/dist/esm/serializers/json/json.js +14 -0
  53. package/dist/esm/styles/color.js +11 -1
  54. package/dist/esm/styles/dom.js +13 -0
  55. package/dist/esm/styles/slotted-styles.js +13 -0
  56. package/dist/esm/styles/typography.js +26 -0
  57. package/dist/esm/uuid/uuid.js +20 -11
  58. package/dist/esm/window/window.js +27 -0
  59. package/dist/foundation-utils.api.json +10996 -0
  60. package/dist/foundation-utils.d.ts +1462 -0
  61. package/docs/api/foundation-utils.activecolorscheme.md +13 -0
  62. package/docs/api/foundation-utils.api_host.md +18 -0
  63. package/docs/api/foundation-utils.assuredesignsystem.md +23 -0
  64. package/docs/api/foundation-utils.constructablelifecyclehandler.md +12 -0
  65. package/docs/api/foundation-utils.constructablependingstate.md +13 -0
  66. package/docs/api/foundation-utils.conversiontype.md +13 -0
  67. package/docs/api/foundation-utils.createlogger.md +27 -0
  68. package/docs/api/foundation-utils.createobserver.md +13 -0
  69. package/docs/api/foundation-utils.database.create.md +22 -0
  70. package/docs/api/foundation-utils.database.delete.md +22 -0
  71. package/docs/api/foundation-utils.database.isworking.md +11 -0
  72. package/docs/api/foundation-utils.database.md +32 -0
  73. package/docs/api/foundation-utils.database.onafterupdate.md +22 -0
  74. package/docs/api/foundation-utils.database.onbeforeupdate.md +22 -0
  75. package/docs/api/foundation-utils.database.read.md +22 -0
  76. package/docs/api/foundation-utils.database.update.md +23 -0
  77. package/docs/api/foundation-utils.database.visit.md +22 -0
  78. package/docs/api/foundation-utils.databaseaccessresult.access.md +18 -0
  79. package/docs/api/foundation-utils.databaseaccessresult.access.value.md +11 -0
  80. package/docs/api/foundation-utils.databaseaccessresult.create.md +13 -0
  81. package/docs/api/foundation-utils.databaseaccessresult.delete.id.md +11 -0
  82. package/docs/api/foundation-utils.databaseaccessresult.delete.md +19 -0
  83. package/docs/api/foundation-utils.databaseaccessresult.delete.success.md +11 -0
  84. package/docs/api/foundation-utils.databaseaccessresult.md +24 -0
  85. package/docs/api/foundation-utils.databaseaccessresult.read.md +13 -0
  86. package/docs/api/foundation-utils.databaseaccessresult.update.md +13 -0
  87. package/docs/api/foundation-utils.databaseevent.afterupdate.md +13 -0
  88. package/docs/api/foundation-utils.databaseevent.beforeupdate.md +19 -0
  89. package/docs/api/foundation-utils.databaseevent.beforeupdate.newvalue.md +11 -0
  90. package/docs/api/foundation-utils.databaseevent.md +22 -0
  91. package/docs/api/foundation-utils.databaseevent.update.md +18 -0
  92. package/docs/api/foundation-utils.databaseevent.update.value.md +11 -0
  93. package/docs/api/foundation-utils.databaserecord.id.md +11 -0
  94. package/docs/api/foundation-utils.databaserecord.md +20 -0
  95. package/docs/api/foundation-utils.default_organisation.md +18 -0
  96. package/docs/api/foundation-utils.default_password.md +18 -0
  97. package/docs/api/foundation-utils.default_user.md +18 -0
  98. package/docs/api/foundation-utils.defaulteventmap.md +13 -0
  99. package/docs/api/foundation-utils.defaultloggeroptions.md +13 -0
  100. package/docs/api/foundation-utils.defaultserverrowdtomapper.fromdto.md +13 -0
  101. package/docs/api/foundation-utils.defaultserverrowdtomapper.md +22 -0
  102. package/docs/api/foundation-utils.defaultserverrowdtomapper.todto.md +13 -0
  103. package/docs/api/foundation-utils.designsystemmodule.md +19 -0
  104. package/docs/api/foundation-utils.designsystemmodule.providedesignsystem.md +23 -0
  105. package/docs/api/foundation-utils.designsystemresource.md +14 -0
  106. package/docs/api/foundation-utils.dtomapper.fromargs.md +11 -0
  107. package/docs/api/foundation-utils.dtomapper.fromdto.md +11 -0
  108. package/docs/api/foundation-utils.dtomapper.md +21 -0
  109. package/docs/api/foundation-utils.dtomapper.todto.md +11 -0
  110. package/docs/api/foundation-utils.eventname.md +13 -0
  111. package/docs/api/foundation-utils.fontstyle.md +21 -0
  112. package/docs/api/foundation-utils.fontweight.md +25 -0
  113. package/docs/api/foundation-utils.force_http.md +18 -0
  114. package/docs/api/foundation-utils.formatdatetimestamp.md +24 -0
  115. package/docs/api/foundation-utils.formatdatetimetimestamp.md +24 -0
  116. package/docs/api/foundation-utils.formattimestamp.md +25 -0
  117. package/docs/api/foundation-utils.getfontmixin.md +13 -0
  118. package/docs/api/foundation-utils.http_config.md +18 -0
  119. package/docs/api/foundation-utils.iniframe.md +13 -0
  120. package/docs/api/foundation-utils.inmemorydatabase._constructor_.md +20 -0
  121. package/docs/api/foundation-utils.inmemorydatabase.create.md +22 -0
  122. package/docs/api/foundation-utils.inmemorydatabase.delete.md +22 -0
  123. package/docs/api/foundation-utils.inmemorydatabase.isworking.md +11 -0
  124. package/docs/api/foundation-utils.inmemorydatabase.md +39 -0
  125. package/docs/api/foundation-utils.inmemorydatabase.onafterupdate.md +22 -0
  126. package/docs/api/foundation-utils.inmemorydatabase.onbeforeupdate.md +22 -0
  127. package/docs/api/foundation-utils.inmemorydatabase.read.md +22 -0
  128. package/docs/api/foundation-utils.inmemorydatabase.update.md +23 -0
  129. package/docs/api/foundation-utils.inmemorydatabase.visit.md +22 -0
  130. package/docs/api/foundation-utils.insertdocumentcssrule.md +13 -0
  131. package/docs/api/foundation-utils.insertdocumentlink.md +13 -0
  132. package/docs/api/foundation-utils.insymphonydesktop.md +13 -0
  133. package/docs/api/foundation-utils.isdev.md +13 -0
  134. package/docs/api/foundation-utils.jsonserializer.deserialize.md +26 -0
  135. package/docs/api/foundation-utils.jsonserializer.deserialize_1.md +26 -0
  136. package/docs/api/foundation-utils.jsonserializer.deserialize_2.md +26 -0
  137. package/docs/api/foundation-utils.jsonserializer.md +13 -0
  138. package/docs/api/foundation-utils.jsonserializer.serialize.md +26 -0
  139. package/docs/api/foundation-utils.layoutcachedocument.md +13 -0
  140. package/docs/api/foundation-utils.lifecyclemixin.md +342 -0
  141. package/docs/api/foundation-utils.listener.md +13 -0
  142. package/docs/api/foundation-utils.loadfontfaces.md +13 -0
  143. package/docs/api/foundation-utils.logger.deprecated.md +45 -0
  144. package/docs/api/foundation-utils.logger.md +25 -0
  145. package/docs/api/foundation-utils.loggeroptions.md +15 -0
  146. package/docs/api/foundation-utils.md +111 -0
  147. package/docs/api/foundation-utils.observer.md +21 -0
  148. package/docs/api/foundation-utils.observer.publish.md +11 -0
  149. package/docs/api/foundation-utils.observer.subscribe.md +11 -0
  150. package/docs/api/foundation-utils.openpopup.md +13 -0
  151. package/docs/api/foundation-utils.pendingstate.md +334 -0
  152. package/docs/api/foundation-utils.pendingstateerrorevent.md +13 -0
  153. package/docs/api/foundation-utils.pendingstateevent.md +13 -0
  154. package/docs/api/foundation-utils.pendingstateevents.md +21 -0
  155. package/docs/api/foundation-utils.popup_default_height.md +13 -0
  156. package/docs/api/foundation-utils.popup_default_width.md +13 -0
  157. package/docs/api/foundation-utils.publish.md +13 -0
  158. package/docs/api/foundation-utils.renderonchange.md +51 -0
  159. package/docs/api/foundation-utils.resourcetype.md +16 -0
  160. package/docs/api/foundation-utils.respondtovisibility.md +13 -0
  161. package/docs/api/foundation-utils.serverrowdto.md +18 -0
  162. package/docs/api/foundation-utils.serverrowdtomapper.md +13 -0
  163. package/docs/api/foundation-utils.serverrowentity.md +18 -0
  164. package/docs/api/foundation-utils.slottedstyles.md +27 -0
  165. package/docs/api/foundation-utils.slottedstyles.styles.md +13 -0
  166. package/docs/api/foundation-utils.slottedstyles.styleschanged.md +25 -0
  167. package/docs/api/foundation-utils.socket_ext.md +18 -0
  168. package/docs/api/foundation-utils.subscribe.md +15 -0
  169. package/docs/api/foundation-utils.sync.md +27 -0
  170. package/docs/api/foundation-utils.typerampvalues.md +22 -0
  171. package/docs/api/foundation-utils.uuid.createid.md +26 -0
  172. package/docs/api/foundation-utils.uuid.createremoteid.md +26 -0
  173. package/docs/api/foundation-utils.uuid.md +13 -0
  174. package/docs/api/foundation-utils.uuidconfig.md +13 -0
  175. package/docs/api/foundation-utils.whenelse.md +26 -0
  176. package/docs/api/index.md +12 -0
  177. package/docs/api-report.md +1075 -0
  178. 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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Database](./foundation-utils.database.md) &gt; [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&lt;T, 'id'&gt; | |
18
+
19
+ **Returns:**
20
+
21
+ Promise&lt;[DatabaseAccessResult.Create](./foundation-utils.databaseaccessresult.create.md)<!-- -->&lt;T&gt;&gt;
22
+
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Database](./foundation-utils.database.md) &gt; [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&lt;[DatabaseAccessResult.Delete](./foundation-utils.databaseaccessresult.delete.md)<!-- -->&gt;
22
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Database](./foundation-utils.database.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Database](./foundation-utils.database.md) &gt; [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)<!-- -->&lt;[DatabaseEvent.AfterUpdate](./foundation-utils.databaseevent.afterupdate.md)<!-- -->&lt;T&gt;&gt; | |
18
+
19
+ **Returns:**
20
+
21
+ () =&gt; void
22
+
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Database](./foundation-utils.database.md) &gt; [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)<!-- -->&lt;[DatabaseEvent.BeforeUpdate](./foundation-utils.databaseevent.beforeupdate.md)<!-- -->&lt;T&gt;&gt; | |
18
+
19
+ **Returns:**
20
+
21
+ () =&gt; void
22
+
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Database](./foundation-utils.database.md) &gt; [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&lt;[DatabaseAccessResult.Read](./foundation-utils.databaseaccessresult.read.md)<!-- -->&lt;T&gt;&gt;
22
+
@@ -0,0 +1,23 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Database](./foundation-utils.database.md) &gt; [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&lt;Partial&lt;T&gt;, 'id'&gt; | |
19
+
20
+ **Returns:**
21
+
22
+ Promise&lt;[DatabaseAccessResult.Update](./foundation-utils.databaseaccessresult.update.md)<!-- -->&lt;T&gt;&gt;
23
+
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [Database](./foundation-utils.database.md) &gt; [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) =&gt; void | |
18
+
19
+ **Returns:**
20
+
21
+ Promise&lt;void&gt;
22
+
@@ -0,0 +1,18 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [Access](./foundation-utils.databaseaccessresult.access.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [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&lt;T&gt;
13
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [Delete](./foundation-utils.databaseaccessresult.delete.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [Delete](./foundation-utils.databaseaccessresult.delete.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [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&lt;T&gt;
13
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [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&lt;T&gt;
13
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseEvent](./foundation-utils.databaseevent.md) &gt; [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&lt;T&gt;
13
+
@@ -0,0 +1,19 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseEvent](./foundation-utils.databaseevent.md) &gt; [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&lt;T&gt;
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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseEvent](./foundation-utils.databaseevent.md) &gt; [BeforeUpdate](./foundation-utils.databaseevent.beforeupdate.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseEvent](./foundation-utils.databaseevent.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseEvent](./foundation-utils.databaseevent.md) &gt; [Update](./foundation-utils.databaseevent.update.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DatabaseRecord](./foundation-utils.databaserecord.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [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) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [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
+