@genesislcap/foundation-comms 14.187.1-alpha-3406925.0 → 14.187.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (156) hide show
  1. package/dist/dts/connect/connect.d.ts +6 -11
  2. package/dist/dts/connect/connect.d.ts.map +1 -1
  3. package/dist/dts/connect/http.connect.d.ts +2 -2
  4. package/dist/dts/connect/http.connect.d.ts.map +1 -1
  5. package/dist/dts/connect/message.d.ts +0 -11
  6. package/dist/dts/connect/message.d.ts.map +1 -1
  7. package/dist/dts/connect/socket.d.ts +2 -6
  8. package/dist/dts/connect/socket.d.ts.map +1 -1
  9. package/dist/dts/datasource/datasource.d.ts +19 -49
  10. package/dist/dts/datasource/datasource.d.ts.map +1 -1
  11. package/dist/dts/datasource/datasource.types.d.ts +22 -14
  12. package/dist/dts/datasource/datasource.types.d.ts.map +1 -1
  13. package/dist/dts/datasource/entityDatasource.d.ts +8 -5
  14. package/dist/dts/datasource/entityDatasource.d.ts.map +1 -1
  15. package/dist/dts/datasource/index.d.ts +0 -2
  16. package/dist/dts/datasource/index.d.ts.map +1 -1
  17. package/dist/dts/index.d.ts +0 -1
  18. package/dist/dts/index.d.ts.map +1 -1
  19. package/dist/dts/testing/mocks/auth/auth.d.ts +0 -3
  20. package/dist/dts/testing/mocks/auth/auth.d.ts.map +1 -1
  21. package/dist/dts/testing/mocks/connect/connect.d.ts +2 -3
  22. package/dist/dts/testing/mocks/connect/connect.d.ts.map +1 -1
  23. package/dist/dts/testing/mocks/connect/socket.d.ts +0 -1
  24. package/dist/dts/testing/mocks/connect/socket.d.ts.map +1 -1
  25. package/dist/dts/testing/mocks/datasource/datasource.d.ts +4 -22
  26. package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
  27. package/dist/dts/testing/mocks/index.d.ts +0 -1
  28. package/dist/dts/testing/mocks/index.d.ts.map +1 -1
  29. package/dist/esm/connect/connect.js +15 -12
  30. package/dist/esm/connect/http.connect.js +3 -5
  31. package/dist/esm/connect/message.js +0 -2
  32. package/dist/esm/connect/socket.js +6 -19
  33. package/dist/esm/datasource/datasource.js +58 -133
  34. package/dist/esm/datasource/datasource.types.js +18 -2
  35. package/dist/esm/datasource/entityDatasource.js +0 -6
  36. package/dist/esm/datasource/index.js +0 -2
  37. package/dist/esm/index.js +0 -1
  38. package/dist/esm/testing/mocks/auth/auth.js +0 -10
  39. package/dist/esm/testing/mocks/connect/connect.js +2 -9
  40. package/dist/esm/testing/mocks/connect/socket.js +0 -2
  41. package/dist/esm/testing/mocks/datasource/datasource.js +0 -59
  42. package/dist/esm/testing/mocks/index.js +0 -1
  43. package/dist/foundation-comms.api.json +6042 -10797
  44. package/dist/foundation-comms.d.ts +37 -696
  45. package/docs/api/foundation-comms.connect.connect.md +2 -2
  46. package/docs/api/foundation-comms.connect.getavailableresources.md +2 -2
  47. package/docs/api/foundation-comms.connect.md +0 -1
  48. package/docs/api/{foundation-comms.datasource.status.md → foundation-comms.datasource.fieldmetadata.md} +4 -3
  49. package/docs/api/foundation-comms.datasource.init.md +2 -2
  50. package/docs/api/foundation-comms.datasource.md +2 -3
  51. package/docs/api/foundation-comms.datasourceconfig.md +1 -2
  52. package/docs/api/foundation-comms.defaultconnect.connect.md +2 -2
  53. package/docs/api/foundation-comms.defaultconnect.getavailableresources.md +2 -2
  54. package/docs/api/foundation-comms.defaultconnect.md +0 -1
  55. package/docs/api/foundation-comms.defaultdatasource._constructor_.md +2 -3
  56. package/docs/api/{foundation-comms.defaultdatasource.fetchmetadatarequired.md → foundation-comms.defaultdatasource._stream.md} +3 -4
  57. package/docs/api/foundation-comms.defaultdatasource.availableindexes.md +1 -2
  58. package/docs/api/foundation-comms.defaultdatasource.fieldmetadata.md +0 -1
  59. package/docs/api/foundation-comms.defaultdatasource.initialized.md +1 -3
  60. package/docs/api/foundation-comms.defaultdatasource.md +7 -10
  61. package/docs/api/foundation-comms.defaultdatasource.originalfielddef.md +1 -2
  62. package/docs/api/foundation-comms.defaultdatasource.requestfields.md +1 -2
  63. package/docs/api/foundation-comms.defaultdatasource.stream.md +1 -1
  64. package/docs/api/foundation-comms.defaultdatasource.validresourcename.md +0 -5
  65. package/docs/api/foundation-comms.defaultdatasourceconfig.md +1 -1
  66. package/docs/api/foundation-comms.defaulthttpconnect.getavailableresources.md +2 -2
  67. package/docs/api/foundation-comms.defaultsocket._constructor_.md +1 -2
  68. package/docs/api/foundation-comms.defaultsocket.connect.md +2 -2
  69. package/docs/api/foundation-comms.defaultsocket.md +1 -3
  70. package/docs/api/foundation-comms.eventmessagetype.md +0 -2
  71. package/docs/api/foundation-comms.md +2 -19
  72. package/docs/api/foundation-comms.socket.md +0 -6
  73. package/docs/api-report.md +25 -550
  74. package/package.json +12 -13
  75. package/dist/dts/datasource/datasource.config.d.ts +0 -44
  76. package/dist/dts/datasource/datasource.config.d.ts.map +0 -1
  77. package/dist/dts/datasource/datasource.mixins.d.ts +0 -367
  78. package/dist/dts/datasource/datasource.mixins.d.ts.map +0 -1
  79. package/dist/dts/resources/genesis/config.d.ts +0 -81
  80. package/dist/dts/resources/genesis/config.d.ts.map +0 -1
  81. package/dist/dts/resources/genesis/genesis.d.ts +0 -69
  82. package/dist/dts/resources/genesis/genesis.d.ts.map +0 -1
  83. package/dist/dts/resources/genesis/index.d.ts +0 -4
  84. package/dist/dts/resources/genesis/index.d.ts.map +0 -1
  85. package/dist/dts/resources/genesis/types.d.ts +0 -19
  86. package/dist/dts/resources/genesis/types.d.ts.map +0 -1
  87. package/dist/dts/resources/index.d.ts +0 -2
  88. package/dist/dts/resources/index.d.ts.map +0 -1
  89. package/dist/dts/testing/mocks/resources/genesis/genesis.d.ts +0 -16
  90. package/dist/dts/testing/mocks/resources/genesis/genesis.d.ts.map +0 -1
  91. package/dist/dts/testing/mocks/resources/genesis/index.d.ts +0 -2
  92. package/dist/dts/testing/mocks/resources/genesis/index.d.ts.map +0 -1
  93. package/dist/dts/testing/mocks/resources/index.d.ts +0 -2
  94. package/dist/dts/testing/mocks/resources/index.d.ts.map +0 -1
  95. package/dist/esm/datasource/datasource.config.js +0 -41
  96. package/dist/esm/datasource/datasource.mixins.js +0 -86
  97. package/dist/esm/resources/genesis/config.js +0 -51
  98. package/dist/esm/resources/genesis/genesis.js +0 -114
  99. package/dist/esm/resources/genesis/index.js +0 -3
  100. package/dist/esm/resources/genesis/types.js +0 -4
  101. package/dist/esm/resources/index.js +0 -1
  102. package/dist/esm/testing/mocks/resources/genesis/genesis.js +0 -25
  103. package/dist/esm/testing/mocks/resources/genesis/index.js +0 -1
  104. package/dist/esm/testing/mocks/resources/index.js +0 -1
  105. package/docs/api/foundation-comms.connect.host.md +0 -11
  106. package/docs/api/foundation-comms.datasourceconfig.eventemitter.md +0 -18
  107. package/docs/api/foundation-comms.datasourceeventhandler.md +0 -353
  108. package/docs/api/foundation-comms.datasourcemetadata.availableindexes.md +0 -11
  109. package/docs/api/foundation-comms.datasourcemetadata.fetchmetadatarequired.md +0 -11
  110. package/docs/api/foundation-comms.datasourcemetadata.fieldmetadata.md +0 -11
  111. package/docs/api/foundation-comms.datasourcemetadata.md +0 -24
  112. package/docs/api/foundation-comms.datasourcemetadata.originalfielddef.md +0 -11
  113. package/docs/api/foundation-comms.datasourcemetadata.requestfields.md +0 -11
  114. package/docs/api/foundation-comms.datasourcestatus.md +0 -21
  115. package/docs/api/foundation-comms.datasourcestatuschanged.md +0 -13
  116. package/docs/api/foundation-comms.datasourcestatuschangedevent.md +0 -15
  117. package/docs/api/foundation-comms.defaultconnect.host.md +0 -11
  118. package/docs/api/foundation-comms.defaultdatasource.fetchandapplymetadata.md +0 -22
  119. package/docs/api/foundation-comms.defaultdatasource.resources.md +0 -11
  120. package/docs/api/foundation-comms.defaultdatasource.status.md +0 -12
  121. package/docs/api/foundation-comms.defaultgenesisresources._constructor_.md +0 -21
  122. package/docs/api/foundation-comms.defaultgenesisresources.config.md +0 -11
  123. package/docs/api/foundation-comms.defaultgenesisresources.connect.md +0 -11
  124. package/docs/api/foundation-comms.defaultgenesisresources.destroy.md +0 -17
  125. package/docs/api/foundation-comms.defaultgenesisresources.getresources.md +0 -15
  126. package/docs/api/foundation-comms.defaultgenesisresources.getresourcetypefor.md +0 -24
  127. package/docs/api/foundation-comms.defaultgenesisresources.isvalidresource.md +0 -24
  128. package/docs/api/foundation-comms.defaultgenesisresources.md +0 -40
  129. package/docs/api/foundation-comms.defaultgenesisresources.postloadedmessage.md +0 -15
  130. package/docs/api/foundation-comms.defaultgenesisresources.resources.md +0 -11
  131. package/docs/api/foundation-comms.defaultgenesisresources.resourcespromise.md +0 -11
  132. package/docs/api/foundation-comms.defaultgenesisresourcesconfig.md +0 -13
  133. package/docs/api/foundation-comms.defaultsocket.config.md +0 -11
  134. package/docs/api/foundation-comms.defaultsocket.host.md +0 -11
  135. package/docs/api/foundation-comms.genesisresources.destroy.md +0 -13
  136. package/docs/api/foundation-comms.genesisresources.getresourcetypefor.md +0 -13
  137. package/docs/api/foundation-comms.genesisresources.isvalidresource.md +0 -13
  138. package/docs/api/foundation-comms.genesisresources.md +0 -26
  139. package/docs/api/foundation-comms.genesisresourceschannel.md +0 -33
  140. package/docs/api/foundation-comms.genesisresourceschannelid.md +0 -12
  141. package/docs/api/foundation-comms.genesisresourcesconfig.md +0 -21
  142. package/docs/api/foundation-comms.genesisresourcesconfig.throwwhenunavailable.md +0 -13
  143. package/docs/api/foundation-comms.genesisresourcesconfig.throwwhenunknown.md +0 -13
  144. package/docs/api/foundation-comms.genesisresourcesevents.md +0 -17
  145. package/docs/api/foundation-comms.genesisresourcesmock.destroy.md +0 -15
  146. package/docs/api/foundation-comms.genesisresourcesmock.getresourcetypefor.md +0 -24
  147. package/docs/api/foundation-comms.genesisresourcesmock.isvalidresource.md +0 -24
  148. package/docs/api/foundation-comms.genesisresourcesmock.md +0 -30
  149. package/docs/api/foundation-comms.genesisresourcesmock.nextisvalidresourceresponse.md +0 -11
  150. package/docs/api/foundation-comms.genesisresourcesmock.nextresourcetypeforresponse.md +0 -11
  151. package/docs/api/foundation-comms.genesisresourcesmock.resources.md +0 -11
  152. package/docs/api/foundation-comms.getgenesisresources.md +0 -30
  153. package/docs/api/foundation-comms.getgenesisresourceschannel.md +0 -39
  154. package/docs/api/foundation-comms.resourceitem.md +0 -15
  155. package/docs/api/foundation-comms.resourcesmessage.md +0 -18
  156. package/docs/api/foundation-comms.socket.host.md +0 -11
@@ -9,14 +9,14 @@ Connects to a server at the specified host.
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- connect(host?: string): Promise<boolean>;
12
+ connect(host: string): Promise<boolean>;
13
13
  ```
14
14
 
15
15
  ## Parameters
16
16
 
17
17
  | Parameter | Type | Description |
18
18
  | --- | --- | --- |
19
- | host | string | _(Optional)_ The host to connect to. Defaults to . |
19
+ | host | string | The host to connect to. |
20
20
 
21
21
  **Returns:**
22
22
 
@@ -9,7 +9,7 @@ Sends a request to the server to get available resources.
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
12
+ getAvailableResources(params?: RequestParams): Promise<Message>;
13
13
  ```
14
14
 
15
15
  ## Parameters
@@ -20,7 +20,7 @@ getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
20
20
 
21
21
  **Returns:**
22
22
 
23
- Promise&lt;[ResourcesMessage](./foundation-comms.resourcesmessage.md)<!-- -->&gt;
23
+ Promise&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
24
24
 
25
25
  A promise that resolves to a Message containing the server's response with available resources.
26
26
 
@@ -16,7 +16,6 @@ export interface Connect
16
16
 
17
17
  | Property | Modifiers | Type | Description |
18
18
  | --- | --- | --- | --- |
19
- | [host](./foundation-comms.connect.host.md) | | string | |
20
19
  | [isConnected](./foundation-comms.connect.isconnected.md) | <code>readonly</code> | boolean | Indicates whether the connection is currently established. |
21
20
  | [isConnected$?](./foundation-comms.connect.isconnected_.md) | <code>readonly</code> | Observable&lt;boolean&gt; | _(Optional)_ An Observable that emits a boolean value indicating whether the connection is currently established. |
22
21
  | [isConnectedSubject?](./foundation-comms.connect.isconnectedsubject.md) | <code>readonly</code> | BehaviorSubject&lt;boolean&gt; | _(Optional)_ A behavior subject holding the current connection status. |
@@ -1,12 +1,13 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [Datasource](./foundation-comms.datasource.md) &gt; [status](./foundation-comms.datasource.status.md)
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [Datasource](./foundation-comms.datasource.md) &gt; [fieldMetadata](./foundation-comms.datasource.fieldmetadata.md)
4
4
 
5
- ## Datasource.status property
5
+ ## Datasource.fieldMetadata property
6
6
 
7
+ Metadata about the fields of the datasource.
7
8
 
8
9
  **Signature:**
9
10
 
10
11
  ```typescript
11
- status: Partial<DatasourceStatus>;
12
+ fieldMetadata: FieldMetadata[];
12
13
  ```
@@ -9,7 +9,7 @@ Initializes the datasource with the given options and fetches metadata if specif
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
12
+ init(options: DatasourceOptions, fetchMeta: boolean): Promise<boolean>;
13
13
  ```
14
14
 
15
15
  ## Parameters
@@ -17,7 +17,7 @@ init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
17
17
  | Parameter | Type | Description |
18
18
  | --- | --- | --- |
19
19
  | options | [DatasourceOptions](./foundation-comms.datasourceoptions.md) | The options to initialize the datasource with. |
20
- | fetchMeta | boolean | _(Optional)_ Optional flag to fetch metadata for the datasource. Defaults to true. |
20
+ | fetchMeta | boolean | Whether to fetch metadata for the datasource. |
21
21
 
22
22
  **Returns:**
23
23
 
@@ -9,9 +9,8 @@ Datasource interface.
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- export interface Datasource extends DatasourceMetadata
12
+ export interface Datasource
13
13
  ```
14
- **Extends:** [DatasourceMetadata](./foundation-comms.datasourcemetadata.md)
15
14
 
16
15
  ## Remarks
17
16
 
@@ -21,10 +20,10 @@ The public interface available on the injected store fragment.
21
20
 
22
21
  | Property | Modifiers | Type | Description |
23
22
  | --- | --- | --- | --- |
23
+ | [fieldMetadata](./foundation-comms.datasource.fieldmetadata.md) | | [FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\] | Metadata about the fields of the datasource. |
24
24
  | [initialized](./foundation-comms.datasource.initialized.md) | | boolean | Indicates whether the datasource has been initialized. |
25
25
  | [readOnly](./foundation-comms.datasource.readonly.md) | | boolean | Indicates whether the datasource is read-only. TODO: Should have is prefix |
26
26
  | [resourceType](./foundation-comms.datasource.resourcetype.md) | | [ResourceType](./foundation-comms.resourcetype.md) | The type of resource the datasource represents. |
27
- | [status](./foundation-comms.datasource.status.md) | | Partial&lt;[DatasourceStatus](./foundation-comms.datasourcestatus.md)<!-- -->&gt; | |
28
27
  | [stream](./foundation-comms.datasource.stream.md) | | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;[FilteredDataServerResult](./foundation-comms.filtereddataserverresult.md) \| [RequestServerResult](./foundation-comms.requestserverresult.md)<!-- -->&gt; | A stream of data from the datasource. |
29
28
 
30
29
  ## Methods
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## DatasourceConfig interface
6
6
 
7
- DatasourceConfig DI interface.
7
+ The configuration object for a Datasource
8
8
 
9
9
  **Signature:**
10
10
 
@@ -16,7 +16,6 @@ export interface DatasourceConfig
16
16
 
17
17
  | Property | Modifiers | Type | Description |
18
18
  | --- | --- | --- | --- |
19
- | [eventEmitter?](./foundation-comms.datasourceconfig.eventemitter.md) | | HTMLElement | _(Optional)_ The element to emit events from. |
20
19
  | [options](./foundation-comms.datasourceconfig.options.md) | | [DatasourceOptions](./foundation-comms.datasourceoptions.md) | |
21
20
 
22
21
  ## Methods
@@ -7,14 +7,14 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- connect(host?: string): Promise<boolean>;
10
+ connect(host: string): Promise<boolean>;
11
11
  ```
12
12
 
13
13
  ## Parameters
14
14
 
15
15
  | Parameter | Type | Description |
16
16
  | --- | --- | --- |
17
- | host | string | _(Optional)_ |
17
+ | host | string | |
18
18
 
19
19
  **Returns:**
20
20
 
@@ -7,7 +7,7 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- getAvailableResources(params?: any): Promise<ResourcesMessage>;
10
+ getAvailableResources(params?: any): Promise<Message>;
11
11
  ```
12
12
 
13
13
  ## Parameters
@@ -18,5 +18,5 @@ getAvailableResources(params?: any): Promise<ResourcesMessage>;
18
18
 
19
19
  **Returns:**
20
20
 
21
- Promise&lt;[ResourcesMessage](./foundation-comms.resourcesmessage.md)<!-- -->&gt;
21
+ Promise&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
22
22
 
@@ -23,7 +23,6 @@ export declare class DefaultConnect implements Connect
23
23
 
24
24
  | Property | Modifiers | Type | Description |
25
25
  | --- | --- | --- | --- |
26
- | [host](./foundation-comms.defaultconnect.host.md) | <code>readonly</code> | string | |
27
26
  | [isConnected](./foundation-comms.defaultconnect.isconnected.md) | <code>readonly</code> | boolean | |
28
27
  | [isConnected$](./foundation-comms.defaultconnect.isconnected_.md) | <code>readonly</code> | Observable&lt;boolean&gt; | |
29
28
  | [isConnectedSubject](./foundation-comms.defaultconnect.isconnectedsubject.md) | <code>readonly</code> | BehaviorSubject&lt;boolean&gt; | |
@@ -9,7 +9,7 @@ Constructs a new instance of the `DefaultDatasource` class
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- constructor(connect: Connect, auth: Auth, resources: GenesisResources, config: DatasourceConfig);
12
+ constructor(connect: Connect, auth: Auth, config?: DatasourceConfig);
13
13
  ```
14
14
 
15
15
  ## Parameters
@@ -18,6 +18,5 @@ constructor(connect: Connect, auth: Auth, resources: GenesisResources, config: D
18
18
  | --- | --- | --- |
19
19
  | connect | [Connect](./foundation-comms.connect.md) | |
20
20
  | auth | [Auth](./foundation-comms.auth.md) | |
21
- | resources | [GenesisResources](./foundation-comms.genesisresources.md) | |
22
- | config | [DatasourceConfig](./foundation-comms.datasourceconfig.md) | |
21
+ | config | [DatasourceConfig](./foundation-comms.datasourceconfig.md) | _(Optional)_ |
23
22
 
@@ -1,12 +1,11 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [fetchMetadataRequired](./foundation-comms.defaultdatasource.fetchmetadatarequired.md)
4
-
5
- ## DefaultDatasource.fetchMetadataRequired property
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [\_stream](./foundation-comms.defaultdatasource._stream.md)
6
4
 
5
+ ## DefaultDatasource.\_stream property
7
6
 
8
7
  **Signature:**
9
8
 
10
9
  ```typescript
11
- fetchMetadataRequired: boolean;
10
+ protected _stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
12
11
  ```
@@ -4,9 +4,8 @@
4
4
 
5
5
  ## DefaultDatasource.availableIndexes property
6
6
 
7
-
8
7
  **Signature:**
9
8
 
10
9
  ```typescript
11
- availableIndexes: IndexDetail[];
10
+ protected availableIndexes: IndexDetail[];
12
11
  ```
@@ -4,7 +4,6 @@
4
4
 
5
5
  ## DefaultDatasource.fieldMetadata property
6
6
 
7
-
8
7
  **Signature:**
9
8
 
10
9
  ```typescript
@@ -4,10 +4,8 @@
4
4
 
5
5
  ## DefaultDatasource.initialized property
6
6
 
7
- Indicates whether the datasource has been initialized.
8
-
9
7
  **Signature:**
10
8
 
11
9
  ```typescript
12
- get initialized(): boolean;
10
+ initialized: boolean;
13
11
  ```
@@ -17,28 +17,26 @@ export declare class DefaultDatasource implements Datasource
17
17
 
18
18
  | Constructor | Modifiers | Description |
19
19
  | --- | --- | --- |
20
- | [(constructor)(connect, auth, resources, config)](./foundation-comms.defaultdatasource._constructor_.md) | | Constructs a new instance of the <code>DefaultDatasource</code> class |
20
+ | [(constructor)(connect, auth, config)](./foundation-comms.defaultdatasource._constructor_.md) | | Constructs a new instance of the <code>DefaultDatasource</code> class |
21
21
 
22
22
  ## Properties
23
23
 
24
24
  | Property | Modifiers | Type | Description |
25
25
  | --- | --- | --- | --- |
26
+ | [\_stream](./foundation-comms.defaultdatasource._stream.md) | <code>protected</code> | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;[FilteredDataServerResult](./foundation-comms.filtereddataserverresult.md) \| [RequestServerResult](./foundation-comms.requestserverresult.md)<!-- -->&gt; | |
26
27
  | [auth](./foundation-comms.defaultdatasource.auth.md) | <code>protected</code> | [Auth](./foundation-comms.auth.md) | |
27
- | [availableIndexes](./foundation-comms.defaultdatasource.availableindexes.md) | | [IndexDetail](./foundation-comms.indexdetail.md)<!-- -->\[\] | |
28
+ | [availableIndexes](./foundation-comms.defaultdatasource.availableindexes.md) | <code>protected</code> | [IndexDetail](./foundation-comms.indexdetail.md)<!-- -->\[\] | |
28
29
  | [config](./foundation-comms.defaultdatasource.config.md) | <code>protected</code> | [DatasourceConfig](./foundation-comms.datasourceconfig.md) | |
29
30
  | [connect](./foundation-comms.defaultdatasource.connect.md) | <code>protected</code> | [Connect](./foundation-comms.connect.md) | |
30
- | [fetchMetadataRequired](./foundation-comms.defaultdatasource.fetchmetadatarequired.md) | | boolean | |
31
31
  | [fieldMetadata](./foundation-comms.defaultdatasource.fieldmetadata.md) | | [FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\] | |
32
- | [initialized](./foundation-comms.defaultdatasource.initialized.md) | <code>readonly</code> | boolean | Indicates whether the datasource has been initialized. |
32
+ | [initialized](./foundation-comms.defaultdatasource.initialized.md) | | boolean | |
33
33
  | [options](./foundation-comms.defaultdatasource.options.md) | <code>protected</code> | [DatasourceOptions](./foundation-comms.datasourceoptions.md) | |
34
- | [originalFieldDef](./foundation-comms.defaultdatasource.originalfielddef.md) | | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
34
+ | [originalFieldDef](./foundation-comms.defaultdatasource.originalfielddef.md) | <code>protected</code> | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
35
35
  | [params](./foundation-comms.defaultdatasource.params.md) | <code>readonly</code> | any | |
36
36
  | [readOnly](./foundation-comms.defaultdatasource.readonly.md) | | boolean | |
37
- | [requestFields](./foundation-comms.defaultdatasource.requestfields.md) | | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
38
- | [resources](./foundation-comms.defaultdatasource.resources.md) | <code>protected</code> | [GenesisResources](./foundation-comms.genesisresources.md) | |
37
+ | [requestFields](./foundation-comms.defaultdatasource.requestfields.md) | <code>protected</code> | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
39
38
  | [resourceType](./foundation-comms.defaultdatasource.resourcetype.md) | | [ResourceType](./foundation-comms.resourcetype.md) | |
40
- | [status](./foundation-comms.defaultdatasource.status.md) | | [DatasourceStatus](./foundation-comms.datasourcestatus.md) | |
41
- | [stream](./foundation-comms.defaultdatasource.stream.md) | | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;[FilteredDataServerResult](./foundation-comms.filtereddataserverresult.md) \| [RequestServerResult](./foundation-comms.requestserverresult.md)<!-- -->&gt; | |
39
+ | [stream](./foundation-comms.defaultdatasource.stream.md) | <code>readonly</code> | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;[FilteredDataServerResult](./foundation-comms.filtereddataserverresult.md) \| [RequestServerResult](./foundation-comms.requestserverresult.md)<!-- -->&gt; | |
42
40
 
43
41
  ## Methods
44
42
 
@@ -46,7 +44,6 @@ export declare class DefaultDatasource implements Datasource
46
44
  | --- | --- | --- |
47
45
  | [deinit()](./foundation-comms.defaultdatasource.deinit.md) | | |
48
46
  | [destroy()](./foundation-comms.defaultdatasource.destroy.md) | | Destroy the datasource. |
49
- | [fetchAndApplyMetadata(resourceName)](./foundation-comms.defaultdatasource.fetchandapplymetadata.md) | <code>protected</code> | |
50
47
  | [init(options, fetchMeta)](./foundation-comms.defaultdatasource.init.md) | | |
51
48
  | [snapshot()](./foundation-comms.defaultdatasource.snapshot.md) | | |
52
49
  | [snapshotFiltered(rowId)](./foundation-comms.defaultdatasource.snapshotfiltered.md) | | |
@@ -4,9 +4,8 @@
4
4
 
5
5
  ## DefaultDatasource.originalFieldDef property
6
6
 
7
-
8
7
  **Signature:**
9
8
 
10
9
  ```typescript
11
- originalFieldDef: MetadataDetail[];
10
+ protected originalFieldDef: MetadataDetail[];
12
11
  ```
@@ -4,9 +4,8 @@
4
4
 
5
5
  ## DefaultDatasource.requestFields property
6
6
 
7
-
8
7
  **Signature:**
9
8
 
10
9
  ```typescript
11
- requestFields: MetadataDetail[];
10
+ protected requestFields: MetadataDetail[];
12
11
  ```
@@ -7,5 +7,5 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
10
+ get stream(): SocketObservable<FilteredDataServerResult | RequestServerResult>;
11
11
  ```
@@ -4,11 +4,6 @@
4
4
 
5
5
  ## DefaultDatasource.validResourceName() method
6
6
 
7
- > Warning: This API is now obsolete.
8
- >
9
- > - Please use [GenesisResources.isValidResource](./foundation-comms.genesisresources.isvalidresource.md) instead.
10
- >
11
-
12
7
  **Signature:**
13
8
 
14
9
  ```typescript
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## defaultDatasourceConfig variable
6
6
 
7
- Default DatasourceConfig DI implementation.
7
+ The default configuration for the Datasource service.
8
8
 
9
9
  **Signature:**
10
10
 
@@ -7,7 +7,7 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- getAvailableResources(params?: any): Promise<ResourcesMessage>;
10
+ getAvailableResources(params?: any): Promise<Message>;
11
11
  ```
12
12
 
13
13
  ## Parameters
@@ -18,5 +18,5 @@ getAvailableResources(params?: any): Promise<ResourcesMessage>;
18
18
 
19
19
  **Returns:**
20
20
 
21
- Promise&lt;[ResourcesMessage](./foundation-comms.resourcesmessage.md)<!-- -->&gt;
21
+ Promise&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
22
22
 
@@ -10,7 +10,7 @@ Constructs a new instance of the `DefaultSocket` class
10
10
 
11
11
  ```typescript
12
12
  constructor(messageBuilder: MessageBuilder, session: Session, serializer: JSONSerializer, uuid: UUID, status: SocketStatus,
13
- user: User, config: ConnectConfig);
13
+ user: User);
14
14
  ```
15
15
 
16
16
  ## Parameters
@@ -23,5 +23,4 @@ constructor(messageBuilder: MessageBuilder, session: Session, serializer: JSONSe
23
23
  | uuid | UUID | |
24
24
  | status | [SocketStatus](./foundation-comms.socketstatus.md) | |
25
25
  | user | User | |
26
- | config | [ConnectConfig](./foundation-comms.connectconfig.md) | |
27
26
 
@@ -7,14 +7,14 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- connect(host?: string, connectOptions?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
10
+ connect(host: string, connectOptions?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
11
11
  ```
12
12
 
13
13
  ## Parameters
14
14
 
15
15
  | Parameter | Type | Description |
16
16
  | --- | --- | --- |
17
- | host | string | _(Optional)_ |
17
+ | host | string | |
18
18
  | connectOptions | [SocketConnectOptions](./foundation-comms.socketconnectoptions.md) | _(Optional)_ |
19
19
  | reconnectOptions | [SocketReconnectOptions](./foundation-comms.socketreconnectoptions.md) | _(Optional)_ |
20
20
 
@@ -17,15 +17,13 @@ export declare class DefaultSocket implements Socket
17
17
 
18
18
  | Constructor | Modifiers | Description |
19
19
  | --- | --- | --- |
20
- | [(constructor)(messageBuilder, session, serializer, uuid, status, user, config)](./foundation-comms.defaultsocket._constructor_.md) | | Constructs a new instance of the <code>DefaultSocket</code> class |
20
+ | [(constructor)(messageBuilder, session, serializer, uuid, status, user)](./foundation-comms.defaultsocket._constructor_.md) | | Constructs a new instance of the <code>DefaultSocket</code> class |
21
21
 
22
22
  ## Properties
23
23
 
24
24
  | Property | Modifiers | Type | Description |
25
25
  | --- | --- | --- | --- |
26
- | [config](./foundation-comms.defaultsocket.config.md) | <code>protected</code> | [ConnectConfig](./foundation-comms.connectconfig.md) | |
27
26
  | [hasValidSession](./foundation-comms.defaultsocket.hasvalidsession.md) | | boolean | |
28
- | [host](./foundation-comms.defaultsocket.host.md) | <code>readonly</code> | string | |
29
27
  | [isConfigured](./foundation-comms.defaultsocket.isconfigured.md) | <code>readonly</code> | boolean | |
30
28
  | [isConnected](./foundation-comms.defaultsocket.isconnected.md) | <code>readonly</code> | boolean | |
31
29
  | [isConnectedSubject](./foundation-comms.defaultsocket.isconnectedsubject.md) | <code>readonly</code> | import("rxjs").BehaviorSubject&lt;boolean&gt; | |
@@ -28,6 +28,4 @@ export declare enum EventMessageType
28
28
  | JSON\_SCHEMA\_REQUEST | <code>&quot;JSON_SCHEMA_REQUEST&quot;</code> | |
29
29
  | META\_REQUEST | <code>&quot;META_REQUEST&quot;</code> | |
30
30
  | RESOURCES\_REQUEST | <code>&quot;RESOURCES_REQUEST&quot;</code> | |
31
- | RESOURCES\_REQUEST\_ACK | <code>&quot;RESOURCES_REQUEST_ACK&quot;</code> | |
32
- | RESOURCES\_REQUEST\_NACK | <code>&quot;RESOURCES_REQUEST_NACK&quot;</code> | |
33
31
 
@@ -17,7 +17,6 @@
17
17
  | [DefaultCredentialManager](./foundation-comms.defaultcredentialmanager.md) | The default implementation for the CredentialManager interface. |
18
18
  | [DefaultDatasource](./foundation-comms.defaultdatasource.md) | The default implementation for the Datasource interface. |
19
19
  | [DefaultFoundationAnalytics](./foundation-comms.defaultfoundationanalytics.md) | The default implementation for the FoundationAnalytics interface. |
20
- | [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) | Default GenesisResources implementation. |
21
20
  | [DefaultHttp](./foundation-comms.defaulthttp.md) | The default implementation of the Http interface. |
22
21
  | [DefaultHttpConnect](./foundation-comms.defaulthttpconnect.md) | The default implementation for the Connect interface (HTTP-only). |
23
22
  | [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) | Default MessageBuilder implementation. |
@@ -26,7 +25,6 @@
26
25
  | [DefaultSession](./foundation-comms.defaultsession.md) | The default implementation for the Session interface. |
27
26
  | [DefaultSocket](./foundation-comms.defaultsocket.md) | Default Socket implementation. |
28
27
  | [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) | Default SocketStatus implementation. |
29
- | [GenesisResourcesMock](./foundation-comms.genesisresourcesmock.md) | |
30
28
  | [SocketMessageHandler](./foundation-comms.socketmessagehandler.md) | The Socket message handler definition. |
31
29
  | [SocketObservable](./foundation-comms.socketobservable.md) | Observable that wraps a WebSocketSubject and provides an Observable interface for sending and receiving messages. |
32
30
  | [SocketSubject](./foundation-comms.socketsubject.md) | Subject that wraps a WebSocketSubject and provides a Subject interface for sending and receiving messages. |
@@ -52,8 +50,6 @@
52
50
  | [dataServerResultFilter(result, rowId)](./foundation-comms.dataserverresultfilter.md) | Data server result filter. |
53
51
  | [getConnect()](./foundation-comms.getconnect.md) | Get Connect from the DI container. |
54
52
  | [getDatasource()](./foundation-comms.getdatasource.md) | Get Datasource from the DI container. |
55
- | [getGenesisResources()](./foundation-comms.getgenesisresources.md) | Gets GenesisResources from the DI container. |
56
- | [getGenesisResourcesChannel()](./foundation-comms.getgenesisresourceschannel.md) | Gets GenesisResourcesChannel from the DI container. |
57
53
  | [getKVStorage()](./foundation-comms.getkvstorage.md) | Gets KVStorage from the DI container. |
58
54
  | [getNetworkMonitor()](./foundation-comms.getnetworkmonitor.md) | Gets NetworkMonitor from the DI container. |
59
55
  | [getSocket()](./foundation-comms.getsocket.md) | Gets Socket from the DI container. |
@@ -74,15 +70,11 @@
74
70
  | [CredentialManagerConfig](./foundation-comms.credentialmanagerconfig.md) | The configuration for the CredentialManager |
75
71
  | [CredentialManagerCookieConfig](./foundation-comms.credentialmanagercookieconfig.md) | The configuration options for the CredentialManager cookie |
76
72
  | [Datasource](./foundation-comms.datasource.md) | Datasource interface. |
77
- | [DatasourceConfig](./foundation-comms.datasourceconfig.md) | DatasourceConfig DI interface. |
78
- | [DatasourceMetadata](./foundation-comms.datasourcemetadata.md) | DatasourceMetadata interface. |
73
+ | [DatasourceConfig](./foundation-comms.datasourceconfig.md) | The configuration object for a Datasource |
79
74
  | [DatasourceOptions](./foundation-comms.datasourceoptions.md) | Options that can be passed when initializing a datasource. |
80
75
  | [DataUpdate](./foundation-comms.dataupdate.md) | Data Update definition with details of what data to add, drop, and/or modify. |
81
76
  | [Dataview](./foundation-comms.dataview.md) | Dataview object |
82
77
  | [FoundationAnalytics](./foundation-comms.foundationanalytics.md) | Represents an analytics tracking system. |
83
- | [GenesisResources](./foundation-comms.genesisresources.md) | GenesisResources DI interface. |
84
- | [GenesisResourcesChannel](./foundation-comms.genesisresourceschannel.md) | GenesisResourcesChannel DI interface. |
85
- | [GenesisResourcesConfig](./foundation-comms.genesisresourcesconfig.md) | GenesisResourcesConfig DI interface. |
86
78
  | [Http](./foundation-comms.http.md) | An interface representing an HTTP client that can make GET and POST requests and return a promise with the response data. |
87
79
  | [HttpRequestInit](./foundation-comms.httprequestinit.md) | The options object used when making an HTTP request. |
88
80
  | [JsonSchemaCache](./foundation-comms.jsonschemacache.md) | A JSON schema cache definition |
@@ -113,17 +105,13 @@
113
105
  | --- | --- |
114
106
  | [CommitEventType](./foundation-comms.commiteventtype.md) | |
115
107
  | [credentialSeparator](./foundation-comms.credentialseparator.md) | The default separator used for splitting credential parts. |
116
- | [DatasourceEventHandler](./foundation-comms.datasourceeventhandler.md) | Datasource event handler mixin for target classes that use or are interested in datasource status changes. |
117
- | [DatasourceStatusChanged](./foundation-comms.datasourcestatuschanged.md) | DatasourceStatusChanged. |
118
108
  | [defaultConnectConfig](./foundation-comms.defaultconnectconfig.md) | The default configuration for connecting to a WS service. |
119
109
  | [defaultCredentialManagerConfig](./foundation-comms.defaultcredentialmanagerconfig.md) | The default configuration for the CredentialManager service. |
120
110
  | [defaultCredentialRequestOptions](./foundation-comms.defaultcredentialrequestoptions.md) | The default request options for the CredentialManager service. |
121
- | [defaultDatasourceConfig](./foundation-comms.defaultdatasourceconfig.md) | Default DatasourceConfig DI implementation. |
122
- | [defaultGenesisResourcesConfig](./foundation-comms.defaultgenesisresourcesconfig.md) | Default GenesisResourcesConfig implementation. |
111
+ | [defaultDatasourceConfig](./foundation-comms.defaultdatasourceconfig.md) | The default configuration for the Datasource service. |
123
112
  | [defaultNetworkMonitorConfig](./foundation-comms.defaultnetworkmonitorconfig.md) | Default NetworkMonitorConfig DI implementation. |
124
113
  | [exponentialScheduler](./foundation-comms.exponentialscheduler.md) | Expontential Interval scheduler for reconnect |
125
114
  | [extractFieldDefinitions](./foundation-comms.extractfielddefinitions.md) | Extracts the field definitions from the metadata. |
126
- | [GenesisResourcesChannelId](./foundation-comms.genesisresourceschannelid.md) | |
127
115
  | [isWebSocketExpression](./foundation-comms.iswebsocketexpression.md) | Regular Expression to test valid WebSocket (wss and ws) hosts |
128
116
  | [linearScheduler](./foundation-comms.linearscheduler.md) | Linear Interval scheduler for reconnect |
129
117
  | [logger](./foundation-comms.logger.md) | Logger for the foundation-comms package |
@@ -152,12 +140,9 @@
152
140
  | [CommitParams](./foundation-comms.commitparams.md) | Parameters for a COMMIT message |
153
141
  | [ConnectionStatus](./foundation-comms.connectionstatus.md) | The connection status of the Genesis client. |
154
142
  | [CredentialData\_2](./foundation-comms.credentialdata_2.md) | Represents user credentials. |
155
- | [DatasourceStatus](./foundation-comms.datasourcestatus.md) | DatasourceStatus. |
156
- | [DatasourceStatusChangedEvent](./foundation-comms.datasourcestatuschangedevent.md) | DatasourceStatusChangedEvent. |
157
143
  | [FieldMetadata](./foundation-comms.fieldmetadata.md) | Field Metadata definition. |
158
144
  | [FilteredDataServerResult](./foundation-comms.filtereddataserverresult.md) | Fitlered result after initial DATASERVER data fetch. |
159
145
  | [GenesisConnectEvents](./foundation-comms.genesisconnectevents.md) | Genesis connect events that can be monitored to invoke resource checking. |
160
- | [GenesisResourcesEvents](./foundation-comms.genesisresourcesevents.md) | |
161
146
  | [GetCredentialOptions](./foundation-comms.getcredentialoptions.md) | Represents options for retrieving credentials. |
162
147
  | [IndexDetail](./foundation-comms.indexdetail.md) | Index Detail definition. |
163
148
  | [JwtAuthInfo](./foundation-comms.jwtauthinfo.md) | Represents JWT authentication information. |
@@ -180,8 +165,6 @@
180
165
  | [RequestParams](./foundation-comms.requestparams.md) | Parameters for a REQUEST message |
181
166
  | [RequestServerResult](./foundation-comms.requestserverresult.md) | Raw result from a REQUEST\_SERVER data fetch. |
182
167
  | [ResourceHealth](./foundation-comms.resourcehealth.md) | ResourceHealth. |
183
- | [ResourceItem](./foundation-comms.resourceitem.md) | |
184
- | [ResourcesMessage](./foundation-comms.resourcesmessage.md) | |
185
168
  | [RowData](./foundation-comms.rowdata.md) | Row Data definition. |
186
169
  | [SchemaResponse](./foundation-comms.schemaresponse.md) | Schema Response definition. |
187
170
  | [ServerRow](./foundation-comms.serverrow.md) | Server Row definition. |
@@ -13,12 +13,6 @@ export interface Socket extends Omit<SocketStatus, 'serialize' | 'onClose' | 're
13
13
  ```
14
14
  **Extends:** Omit&lt;[SocketStatus](./foundation-comms.socketstatus.md)<!-- -->, 'serialize' \| 'onClose' \| 'reconnectionLimitReached' \| 'closedCode' \| 'closedReason' \| 'closedClean'&gt;
15
15
 
16
- ## Properties
17
-
18
- | Property | Modifiers | Type | Description |
19
- | --- | --- | --- | --- |
20
- | [host](./foundation-comms.socket.host.md) | | string | |
21
-
22
16
  ## Methods
23
17
 
24
18
  | Method | Description |