@genesislcap/foundation-comms 14.187.1 → 14.188.0

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 +11 -6
  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 +11 -0
  6. package/dist/dts/connect/message.d.ts.map +1 -1
  7. package/dist/dts/connect/socket.d.ts +6 -2
  8. package/dist/dts/connect/socket.d.ts.map +1 -1
  9. package/dist/dts/datasource/datasource.config.d.ts +44 -0
  10. package/dist/dts/datasource/datasource.config.d.ts.map +1 -0
  11. package/dist/dts/datasource/datasource.d.ts +49 -19
  12. package/dist/dts/datasource/datasource.d.ts.map +1 -1
  13. package/dist/dts/datasource/datasource.mixins.d.ts +367 -0
  14. package/dist/dts/datasource/datasource.mixins.d.ts.map +1 -0
  15. package/dist/dts/datasource/datasource.types.d.ts +14 -22
  16. package/dist/dts/datasource/datasource.types.d.ts.map +1 -1
  17. package/dist/dts/datasource/entityDatasource.d.ts +5 -8
  18. package/dist/dts/datasource/entityDatasource.d.ts.map +1 -1
  19. package/dist/dts/datasource/index.d.ts +2 -0
  20. package/dist/dts/datasource/index.d.ts.map +1 -1
  21. package/dist/dts/index.d.ts +1 -0
  22. package/dist/dts/index.d.ts.map +1 -1
  23. package/dist/dts/resources/genesis/config.d.ts +81 -0
  24. package/dist/dts/resources/genesis/config.d.ts.map +1 -0
  25. package/dist/dts/resources/genesis/genesis.d.ts +69 -0
  26. package/dist/dts/resources/genesis/genesis.d.ts.map +1 -0
  27. package/dist/dts/resources/genesis/index.d.ts +4 -0
  28. package/dist/dts/resources/genesis/index.d.ts.map +1 -0
  29. package/dist/dts/resources/genesis/types.d.ts +19 -0
  30. package/dist/dts/resources/genesis/types.d.ts.map +1 -0
  31. package/dist/dts/resources/index.d.ts +2 -0
  32. package/dist/dts/resources/index.d.ts.map +1 -0
  33. package/dist/dts/testing/mocks/auth/auth.d.ts +3 -0
  34. package/dist/dts/testing/mocks/auth/auth.d.ts.map +1 -1
  35. package/dist/dts/testing/mocks/connect/connect.d.ts +3 -2
  36. package/dist/dts/testing/mocks/connect/connect.d.ts.map +1 -1
  37. package/dist/dts/testing/mocks/connect/socket.d.ts +1 -0
  38. package/dist/dts/testing/mocks/connect/socket.d.ts.map +1 -1
  39. package/dist/dts/testing/mocks/datasource/datasource.d.ts +22 -4
  40. package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
  41. package/dist/dts/testing/mocks/index.d.ts +1 -0
  42. package/dist/dts/testing/mocks/index.d.ts.map +1 -1
  43. package/dist/dts/testing/mocks/resources/genesis/genesis.d.ts +16 -0
  44. package/dist/dts/testing/mocks/resources/genesis/genesis.d.ts.map +1 -0
  45. package/dist/dts/testing/mocks/resources/genesis/index.d.ts +2 -0
  46. package/dist/dts/testing/mocks/resources/genesis/index.d.ts.map +1 -0
  47. package/dist/dts/testing/mocks/resources/index.d.ts +2 -0
  48. package/dist/dts/testing/mocks/resources/index.d.ts.map +1 -0
  49. package/dist/esm/connect/connect.js +12 -15
  50. package/dist/esm/connect/http.connect.js +5 -3
  51. package/dist/esm/connect/message.js +2 -0
  52. package/dist/esm/connect/socket.js +19 -6
  53. package/dist/esm/datasource/datasource.config.js +41 -0
  54. package/dist/esm/datasource/datasource.js +133 -58
  55. package/dist/esm/datasource/datasource.mixins.js +86 -0
  56. package/dist/esm/datasource/datasource.types.js +2 -18
  57. package/dist/esm/datasource/entityDatasource.js +6 -0
  58. package/dist/esm/datasource/index.js +2 -0
  59. package/dist/esm/index.js +1 -0
  60. package/dist/esm/resources/genesis/config.js +51 -0
  61. package/dist/esm/resources/genesis/genesis.js +114 -0
  62. package/dist/esm/resources/genesis/index.js +3 -0
  63. package/dist/esm/resources/genesis/types.js +4 -0
  64. package/dist/esm/resources/index.js +1 -0
  65. package/dist/esm/testing/mocks/auth/auth.js +10 -0
  66. package/dist/esm/testing/mocks/connect/connect.js +9 -2
  67. package/dist/esm/testing/mocks/connect/socket.js +2 -0
  68. package/dist/esm/testing/mocks/datasource/datasource.js +59 -0
  69. package/dist/esm/testing/mocks/index.js +1 -0
  70. package/dist/esm/testing/mocks/resources/genesis/genesis.js +25 -0
  71. package/dist/esm/testing/mocks/resources/genesis/index.js +1 -0
  72. package/dist/esm/testing/mocks/resources/index.js +1 -0
  73. package/dist/foundation-comms.api.json +11047 -6292
  74. package/dist/foundation-comms.d.ts +696 -37
  75. package/docs/api/foundation-comms.connect.connect.md +2 -2
  76. package/docs/api/foundation-comms.connect.getavailableresources.md +2 -2
  77. package/docs/api/foundation-comms.connect.host.md +11 -0
  78. package/docs/api/foundation-comms.connect.md +1 -0
  79. package/docs/api/foundation-comms.datasource.init.md +2 -2
  80. package/docs/api/foundation-comms.datasource.md +3 -2
  81. package/docs/api/{foundation-comms.datasource.fieldmetadata.md → foundation-comms.datasource.status.md} +3 -4
  82. package/docs/api/foundation-comms.datasourceconfig.eventemitter.md +18 -0
  83. package/docs/api/foundation-comms.datasourceconfig.md +2 -1
  84. package/docs/api/foundation-comms.datasourceeventhandler.md +353 -0
  85. package/docs/api/foundation-comms.datasourcemetadata.availableindexes.md +11 -0
  86. package/docs/api/foundation-comms.datasourcemetadata.fetchmetadatarequired.md +11 -0
  87. package/docs/api/foundation-comms.datasourcemetadata.fieldmetadata.md +11 -0
  88. package/docs/api/foundation-comms.datasourcemetadata.md +24 -0
  89. package/docs/api/foundation-comms.datasourcemetadata.originalfielddef.md +11 -0
  90. package/docs/api/foundation-comms.datasourcemetadata.requestfields.md +11 -0
  91. package/docs/api/foundation-comms.datasourcestatus.md +21 -0
  92. package/docs/api/foundation-comms.datasourcestatuschanged.md +13 -0
  93. package/docs/api/foundation-comms.datasourcestatuschangedevent.md +15 -0
  94. package/docs/api/foundation-comms.defaultconnect.connect.md +2 -2
  95. package/docs/api/foundation-comms.defaultconnect.getavailableresources.md +2 -2
  96. package/docs/api/foundation-comms.defaultconnect.host.md +11 -0
  97. package/docs/api/foundation-comms.defaultconnect.md +1 -0
  98. package/docs/api/foundation-comms.defaultdatasource._constructor_.md +3 -2
  99. package/docs/api/foundation-comms.defaultdatasource.availableindexes.md +2 -1
  100. package/docs/api/foundation-comms.defaultdatasource.fetchandapplymetadata.md +22 -0
  101. package/docs/api/{foundation-comms.defaultdatasource._stream.md → foundation-comms.defaultdatasource.fetchmetadatarequired.md} +4 -3
  102. package/docs/api/foundation-comms.defaultdatasource.fieldmetadata.md +1 -0
  103. package/docs/api/foundation-comms.defaultdatasource.initialized.md +3 -1
  104. package/docs/api/foundation-comms.defaultdatasource.md +10 -7
  105. package/docs/api/foundation-comms.defaultdatasource.originalfielddef.md +2 -1
  106. package/docs/api/foundation-comms.defaultdatasource.requestfields.md +2 -1
  107. package/docs/api/foundation-comms.defaultdatasource.resources.md +11 -0
  108. package/docs/api/foundation-comms.defaultdatasource.status.md +12 -0
  109. package/docs/api/foundation-comms.defaultdatasource.stream.md +1 -1
  110. package/docs/api/foundation-comms.defaultdatasource.validresourcename.md +5 -0
  111. package/docs/api/foundation-comms.defaultdatasourceconfig.md +1 -1
  112. package/docs/api/foundation-comms.defaultgenesisresources._constructor_.md +21 -0
  113. package/docs/api/foundation-comms.defaultgenesisresources.config.md +11 -0
  114. package/docs/api/foundation-comms.defaultgenesisresources.connect.md +11 -0
  115. package/docs/api/foundation-comms.defaultgenesisresources.destroy.md +17 -0
  116. package/docs/api/foundation-comms.defaultgenesisresources.getresources.md +15 -0
  117. package/docs/api/foundation-comms.defaultgenesisresources.getresourcetypefor.md +24 -0
  118. package/docs/api/foundation-comms.defaultgenesisresources.isvalidresource.md +24 -0
  119. package/docs/api/foundation-comms.defaultgenesisresources.md +40 -0
  120. package/docs/api/foundation-comms.defaultgenesisresources.postloadedmessage.md +15 -0
  121. package/docs/api/foundation-comms.defaultgenesisresources.resources.md +11 -0
  122. package/docs/api/foundation-comms.defaultgenesisresources.resourcespromise.md +11 -0
  123. package/docs/api/foundation-comms.defaultgenesisresourcesconfig.md +13 -0
  124. package/docs/api/foundation-comms.defaulthttpconnect.getavailableresources.md +2 -2
  125. package/docs/api/foundation-comms.defaultsocket._constructor_.md +2 -1
  126. package/docs/api/foundation-comms.defaultsocket.config.md +11 -0
  127. package/docs/api/foundation-comms.defaultsocket.connect.md +2 -2
  128. package/docs/api/foundation-comms.defaultsocket.host.md +11 -0
  129. package/docs/api/foundation-comms.defaultsocket.md +3 -1
  130. package/docs/api/foundation-comms.eventmessagetype.md +2 -0
  131. package/docs/api/foundation-comms.genesisresources.destroy.md +13 -0
  132. package/docs/api/foundation-comms.genesisresources.getresourcetypefor.md +13 -0
  133. package/docs/api/foundation-comms.genesisresources.isvalidresource.md +13 -0
  134. package/docs/api/foundation-comms.genesisresources.md +26 -0
  135. package/docs/api/foundation-comms.genesisresourceschannel.md +33 -0
  136. package/docs/api/foundation-comms.genesisresourceschannelid.md +12 -0
  137. package/docs/api/foundation-comms.genesisresourcesconfig.md +21 -0
  138. package/docs/api/foundation-comms.genesisresourcesconfig.throwwhenunavailable.md +13 -0
  139. package/docs/api/foundation-comms.genesisresourcesconfig.throwwhenunknown.md +13 -0
  140. package/docs/api/foundation-comms.genesisresourcesevents.md +17 -0
  141. package/docs/api/foundation-comms.genesisresourcesmock.destroy.md +15 -0
  142. package/docs/api/foundation-comms.genesisresourcesmock.getresourcetypefor.md +24 -0
  143. package/docs/api/foundation-comms.genesisresourcesmock.isvalidresource.md +24 -0
  144. package/docs/api/foundation-comms.genesisresourcesmock.md +30 -0
  145. package/docs/api/foundation-comms.genesisresourcesmock.nextisvalidresourceresponse.md +11 -0
  146. package/docs/api/foundation-comms.genesisresourcesmock.nextresourcetypeforresponse.md +11 -0
  147. package/docs/api/foundation-comms.genesisresourcesmock.resources.md +11 -0
  148. package/docs/api/foundation-comms.getgenesisresources.md +30 -0
  149. package/docs/api/foundation-comms.getgenesisresourceschannel.md +39 -0
  150. package/docs/api/foundation-comms.md +19 -2
  151. package/docs/api/foundation-comms.resourceitem.md +15 -0
  152. package/docs/api/foundation-comms.resourcesmessage.md +18 -0
  153. package/docs/api/foundation-comms.socket.host.md +11 -0
  154. package/docs/api/foundation-comms.socket.md +6 -0
  155. package/docs/api-report.md +550 -25
  156. package/package.json +13 -12
@@ -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 | |
17
+ | host | string | _(Optional)_ |
18
18
 
19
19
  **Returns:**
20
20
 
@@ -7,7 +7,7 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- getAvailableResources(params?: any): Promise<Message>;
10
+ getAvailableResources(params?: any): Promise<ResourcesMessage>;
11
11
  ```
12
12
 
13
13
  ## Parameters
@@ -18,5 +18,5 @@ getAvailableResources(params?: any): Promise<Message>;
18
18
 
19
19
  **Returns:**
20
20
 
21
- Promise&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
21
+ Promise&lt;[ResourcesMessage](./foundation-comms.resourcesmessage.md)<!-- -->&gt;
22
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-comms](./foundation-comms.md) &gt; [DefaultConnect](./foundation-comms.defaultconnect.md) &gt; [host](./foundation-comms.defaultconnect.host.md)
4
+
5
+ ## DefaultConnect.host property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ get host(): string;
11
+ ```
@@ -23,6 +23,7 @@ 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 | |
26
27
  | [isConnected](./foundation-comms.defaultconnect.isconnected.md) | <code>readonly</code> | boolean | |
27
28
  | [isConnected$](./foundation-comms.defaultconnect.isconnected_.md) | <code>readonly</code> | Observable&lt;boolean&gt; | |
28
29
  | [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, config?: DatasourceConfig);
12
+ constructor(connect: Connect, auth: Auth, resources: GenesisResources, config: DatasourceConfig);
13
13
  ```
14
14
 
15
15
  ## Parameters
@@ -18,5 +18,6 @@ constructor(connect: Connect, auth: Auth, config?: DatasourceConfig);
18
18
  | --- | --- | --- |
19
19
  | connect | [Connect](./foundation-comms.connect.md) | |
20
20
  | auth | [Auth](./foundation-comms.auth.md) | |
21
- | config | [DatasourceConfig](./foundation-comms.datasourceconfig.md) | _(Optional)_ |
21
+ | resources | [GenesisResources](./foundation-comms.genesisresources.md) | |
22
+ | config | [DatasourceConfig](./foundation-comms.datasourceconfig.md) | |
22
23
 
@@ -4,8 +4,9 @@
4
4
 
5
5
  ## DefaultDatasource.availableIndexes property
6
6
 
7
+
7
8
  **Signature:**
8
9
 
9
10
  ```typescript
10
- protected availableIndexes: IndexDetail[];
11
+ availableIndexes: IndexDetail[];
11
12
  ```
@@ -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-comms](./foundation-comms.md) &gt; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [fetchAndApplyMetadata](./foundation-comms.defaultdatasource.fetchandapplymetadata.md)
4
+
5
+ ## DefaultDatasource.fetchAndApplyMetadata() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected fetchAndApplyMetadata(resourceName: string): Promise<void>;
11
+ ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | resourceName | string | |
18
+
19
+ **Returns:**
20
+
21
+ Promise&lt;void&gt;
22
+
@@ -1,11 +1,12 @@
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; [\_stream](./foundation-comms.defaultdatasource._stream.md)
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
4
6
 
5
- ## DefaultDatasource.\_stream property
6
7
 
7
8
  **Signature:**
8
9
 
9
10
  ```typescript
10
- protected _stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
11
+ fetchMetadataRequired: boolean;
11
12
  ```
@@ -4,6 +4,7 @@
4
4
 
5
5
  ## DefaultDatasource.fieldMetadata property
6
6
 
7
+
7
8
  **Signature:**
8
9
 
9
10
  ```typescript
@@ -4,8 +4,10 @@
4
4
 
5
5
  ## DefaultDatasource.initialized property
6
6
 
7
+ Indicates whether the datasource has been initialized.
8
+
7
9
  **Signature:**
8
10
 
9
11
  ```typescript
10
- initialized: boolean;
12
+ get initialized(): boolean;
11
13
  ```
@@ -17,26 +17,28 @@ export declare class DefaultDatasource implements Datasource
17
17
 
18
18
  | Constructor | Modifiers | Description |
19
19
  | --- | --- | --- |
20
- | [(constructor)(connect, auth, config)](./foundation-comms.defaultdatasource._constructor_.md) | | Constructs a new instance of the <code>DefaultDatasource</code> class |
20
+ | [(constructor)(connect, auth, resources, 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; | |
27
26
  | [auth](./foundation-comms.defaultdatasource.auth.md) | <code>protected</code> | [Auth](./foundation-comms.auth.md) | |
28
- | [availableIndexes](./foundation-comms.defaultdatasource.availableindexes.md) | <code>protected</code> | [IndexDetail](./foundation-comms.indexdetail.md)<!-- -->\[\] | |
27
+ | [availableIndexes](./foundation-comms.defaultdatasource.availableindexes.md) | | [IndexDetail](./foundation-comms.indexdetail.md)<!-- -->\[\] | |
29
28
  | [config](./foundation-comms.defaultdatasource.config.md) | <code>protected</code> | [DatasourceConfig](./foundation-comms.datasourceconfig.md) | |
30
29
  | [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) | | boolean | |
32
+ | [initialized](./foundation-comms.defaultdatasource.initialized.md) | <code>readonly</code> | boolean | Indicates whether the datasource has been initialized. |
33
33
  | [options](./foundation-comms.defaultdatasource.options.md) | <code>protected</code> | [DatasourceOptions](./foundation-comms.datasourceoptions.md) | |
34
- | [originalFieldDef](./foundation-comms.defaultdatasource.originalfielddef.md) | <code>protected</code> | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
34
+ | [originalFieldDef](./foundation-comms.defaultdatasource.originalfielddef.md) | | [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) | <code>protected</code> | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
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) | |
38
39
  | [resourceType](./foundation-comms.defaultdatasource.resourcetype.md) | | [ResourceType](./foundation-comms.resourcetype.md) | |
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; | |
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; | |
40
42
 
41
43
  ## Methods
42
44
 
@@ -44,6 +46,7 @@ export declare class DefaultDatasource implements Datasource
44
46
  | --- | --- | --- |
45
47
  | [deinit()](./foundation-comms.defaultdatasource.deinit.md) | | |
46
48
  | [destroy()](./foundation-comms.defaultdatasource.destroy.md) | | Destroy the datasource. |
49
+ | [fetchAndApplyMetadata(resourceName)](./foundation-comms.defaultdatasource.fetchandapplymetadata.md) | <code>protected</code> | |
47
50
  | [init(options, fetchMeta)](./foundation-comms.defaultdatasource.init.md) | | |
48
51
  | [snapshot()](./foundation-comms.defaultdatasource.snapshot.md) | | |
49
52
  | [snapshotFiltered(rowId)](./foundation-comms.defaultdatasource.snapshotfiltered.md) | | |
@@ -4,8 +4,9 @@
4
4
 
5
5
  ## DefaultDatasource.originalFieldDef property
6
6
 
7
+
7
8
  **Signature:**
8
9
 
9
10
  ```typescript
10
- protected originalFieldDef: MetadataDetail[];
11
+ originalFieldDef: MetadataDetail[];
11
12
  ```
@@ -4,8 +4,9 @@
4
4
 
5
5
  ## DefaultDatasource.requestFields property
6
6
 
7
+
7
8
  **Signature:**
8
9
 
9
10
  ```typescript
10
- protected requestFields: MetadataDetail[];
11
+ requestFields: MetadataDetail[];
11
12
  ```
@@ -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-comms](./foundation-comms.md) &gt; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [resources](./foundation-comms.defaultdatasource.resources.md)
4
+
5
+ ## DefaultDatasource.resources property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected resources: GenesisResources;
11
+ ```
@@ -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-comms](./foundation-comms.md) &gt; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [status](./foundation-comms.defaultdatasource.status.md)
4
+
5
+ ## DefaultDatasource.status property
6
+
7
+
8
+ **Signature:**
9
+
10
+ ```typescript
11
+ status: DatasourceStatus;
12
+ ```
@@ -7,5 +7,5 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- get stream(): SocketObservable<FilteredDataServerResult | RequestServerResult>;
10
+ stream: SocketObservable<FilteredDataServerResult | RequestServerResult>;
11
11
  ```
@@ -4,6 +4,11 @@
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
+
7
12
  **Signature:**
8
13
 
9
14
  ```typescript
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## defaultDatasourceConfig variable
6
6
 
7
- The default configuration for the Datasource service.
7
+ Default DatasourceConfig DI implementation.
8
8
 
9
9
  **Signature:**
10
10
 
@@ -0,0 +1,21 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [(constructor)](./foundation-comms.defaultgenesisresources._constructor_.md)
4
+
5
+ ## DefaultGenesisResources.(constructor)
6
+
7
+ Constructs a new instance of the `DefaultGenesisResources` class
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ constructor(connect: Connect, config: GenesisResourcesConfig);
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | connect | [Connect](./foundation-comms.connect.md) | |
20
+ | config | [GenesisResourcesConfig](./foundation-comms.genesisresourcesconfig.md) | |
21
+
@@ -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-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [config](./foundation-comms.defaultgenesisresources.config.md)
4
+
5
+ ## DefaultGenesisResources.config property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected config: GenesisResourcesConfig;
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-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [connect](./foundation-comms.defaultgenesisresources.connect.md)
4
+
5
+ ## DefaultGenesisResources.connect property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected connect: Connect;
11
+ ```
@@ -0,0 +1,17 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [destroy](./foundation-comms.defaultgenesisresources.destroy.md)
4
+
5
+ ## DefaultGenesisResources.destroy() method
6
+
7
+ Destroy and garbage collect
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ destroy(): void;
13
+ ```
14
+ **Returns:**
15
+
16
+ void
17
+
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [getResources](./foundation-comms.defaultgenesisresources.getresources.md)
4
+
5
+ ## DefaultGenesisResources.getResources() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected getResources(): Promise<void>;
11
+ ```
12
+ **Returns:**
13
+
14
+ Promise&lt;void&gt;
15
+
@@ -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-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [getResourceTypeFor](./foundation-comms.defaultgenesisresources.getresourcetypefor.md)
4
+
5
+ ## DefaultGenesisResources.getResourceTypeFor() method
6
+
7
+ Gets the type of resource
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ getResourceTypeFor(resourceName: string): Promise<ResourceType>;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | resourceName | string | The name of the resource to get the type for. |
20
+
21
+ **Returns:**
22
+
23
+ Promise&lt;[ResourceType](./foundation-comms.resourcetype.md)<!-- -->&gt;
24
+
@@ -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-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [isValidResource](./foundation-comms.defaultgenesisresources.isvalidresource.md)
4
+
5
+ ## DefaultGenesisResources.isValidResource() method
6
+
7
+ Checks if the resource exists
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ isValidResource(resourceName: string): Promise<boolean>;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | resourceName | string | The name of the resource to check. |
20
+
21
+ **Returns:**
22
+
23
+ Promise&lt;boolean&gt;
24
+
@@ -0,0 +1,40 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md)
4
+
5
+ ## DefaultGenesisResources class
6
+
7
+ Default GenesisResources implementation.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export declare class DefaultGenesisResources implements GenesisResources
13
+ ```
14
+ **Implements:** [GenesisResources](./foundation-comms.genesisresources.md)
15
+
16
+ ## Constructors
17
+
18
+ | Constructor | Modifiers | Description |
19
+ | --- | --- | --- |
20
+ | [(constructor)(connect, config)](./foundation-comms.defaultgenesisresources._constructor_.md) | | Constructs a new instance of the <code>DefaultGenesisResources</code> class |
21
+
22
+ ## Properties
23
+
24
+ | Property | Modifiers | Type | Description |
25
+ | --- | --- | --- | --- |
26
+ | [config](./foundation-comms.defaultgenesisresources.config.md) | <code>protected</code> | [GenesisResourcesConfig](./foundation-comms.genesisresourcesconfig.md) | |
27
+ | [connect](./foundation-comms.defaultgenesisresources.connect.md) | <code>protected</code> | [Connect](./foundation-comms.connect.md) | |
28
+ | [resources](./foundation-comms.defaultgenesisresources.resources.md) | <code>protected</code> | [ResourceItem](./foundation-comms.resourceitem.md)<!-- -->\[\] | |
29
+ | [resourcesPromise](./foundation-comms.defaultgenesisresources.resourcespromise.md) | <code>protected</code> | Promise&lt;[ResourcesMessage](./foundation-comms.resourcesmessage.md)<!-- -->&gt; | |
30
+
31
+ ## Methods
32
+
33
+ | Method | Modifiers | Description |
34
+ | --- | --- | --- |
35
+ | [destroy()](./foundation-comms.defaultgenesisresources.destroy.md) | | Destroy and garbage collect |
36
+ | [getResources()](./foundation-comms.defaultgenesisresources.getresources.md) | <code>protected</code> | |
37
+ | [getResourceTypeFor(resourceName)](./foundation-comms.defaultgenesisresources.getresourcetypefor.md) | | Gets the type of resource |
38
+ | [isValidResource(resourceName)](./foundation-comms.defaultgenesisresources.isvalidresource.md) | | Checks if the resource exists |
39
+ | [postLoadedMessage()](./foundation-comms.defaultgenesisresources.postloadedmessage.md) | <code>protected</code> | |
40
+
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [postLoadedMessage](./foundation-comms.defaultgenesisresources.postloadedmessage.md)
4
+
5
+ ## DefaultGenesisResources.postLoadedMessage() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected postLoadedMessage(): void;
11
+ ```
12
+ **Returns:**
13
+
14
+ void
15
+
@@ -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-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [resources](./foundation-comms.defaultgenesisresources.resources.md)
4
+
5
+ ## DefaultGenesisResources.resources property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected resources: ResourceItem[];
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-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [resourcesPromise](./foundation-comms.defaultgenesisresources.resourcespromise.md)
4
+
5
+ ## DefaultGenesisResources.resourcesPromise property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected resourcesPromise: Promise<ResourcesMessage>;
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-comms](./foundation-comms.md) &gt; [defaultGenesisResourcesConfig](./foundation-comms.defaultgenesisresourcesconfig.md)
4
+
5
+ ## defaultGenesisResourcesConfig variable
6
+
7
+ Default GenesisResourcesConfig implementation.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ defaultGenesisResourcesConfig: GenesisResourcesConfig
13
+ ```
@@ -7,7 +7,7 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- getAvailableResources(params?: any): Promise<Message>;
10
+ getAvailableResources(params?: any): Promise<ResourcesMessage>;
11
11
  ```
12
12
 
13
13
  ## Parameters
@@ -18,5 +18,5 @@ getAvailableResources(params?: any): Promise<Message>;
18
18
 
19
19
  **Returns:**
20
20
 
21
- Promise&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
21
+ Promise&lt;[ResourcesMessage](./foundation-comms.resourcesmessage.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);
13
+ user: User, config: ConnectConfig);
14
14
  ```
15
15
 
16
16
  ## Parameters
@@ -23,4 +23,5 @@ 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) | |
26
27
 
@@ -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-comms](./foundation-comms.md) &gt; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [config](./foundation-comms.defaultsocket.config.md)
4
+
5
+ ## DefaultSocket.config property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ protected config: ConnectConfig;
11
+ ```
@@ -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 | |
17
+ | host | string | _(Optional)_ |
18
18
  | connectOptions | [SocketConnectOptions](./foundation-comms.socketconnectoptions.md) | _(Optional)_ |
19
19
  | reconnectOptions | [SocketReconnectOptions](./foundation-comms.socketreconnectoptions.md) | _(Optional)_ |
20
20
 
@@ -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-comms](./foundation-comms.md) &gt; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [host](./foundation-comms.defaultsocket.host.md)
4
+
5
+ ## DefaultSocket.host property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ get host(): string;
11
+ ```
@@ -17,13 +17,15 @@ export declare class DefaultSocket implements Socket
17
17
 
18
18
  | Constructor | Modifiers | Description |
19
19
  | --- | --- | --- |
20
- | [(constructor)(messageBuilder, session, serializer, uuid, status, user)](./foundation-comms.defaultsocket._constructor_.md) | | Constructs a new instance of the <code>DefaultSocket</code> class |
20
+ | [(constructor)(messageBuilder, session, serializer, uuid, status, user, config)](./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) | |
26
27
  | [hasValidSession](./foundation-comms.defaultsocket.hasvalidsession.md) | | boolean | |
28
+ | [host](./foundation-comms.defaultsocket.host.md) | <code>readonly</code> | string | |
27
29
  | [isConfigured](./foundation-comms.defaultsocket.isconfigured.md) | <code>readonly</code> | boolean | |
28
30
  | [isConnected](./foundation-comms.defaultsocket.isconnected.md) | <code>readonly</code> | boolean | |
29
31
  | [isConnectedSubject](./foundation-comms.defaultsocket.isconnectedsubject.md) | <code>readonly</code> | import("rxjs").BehaviorSubject&lt;boolean&gt; | |
@@ -28,4 +28,6 @@ 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> | |
31
33
 
@@ -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-comms](./foundation-comms.md) &gt; [GenesisResources](./foundation-comms.genesisresources.md) &gt; [destroy](./foundation-comms.genesisresources.destroy.md)
4
+
5
+ ## GenesisResources.destroy property
6
+
7
+ Destroy and garbage collect
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ destroy: () => void;
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-comms](./foundation-comms.md) &gt; [GenesisResources](./foundation-comms.genesisresources.md) &gt; [getResourceTypeFor](./foundation-comms.genesisresources.getresourcetypefor.md)
4
+
5
+ ## GenesisResources.getResourceTypeFor property
6
+
7
+ Gets the type of resource
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ getResourceTypeFor: (resourceName: string) => Promise<ResourceType>;
13
+ ```