@genesislcap/foundation-comms 14.219.2 → 14.220.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (37) hide show
  1. package/dist/dts/connect/connect.d.ts +10 -10
  2. package/dist/dts/connect/connect.d.ts.map +1 -1
  3. package/dist/dts/connect/message.d.ts +5 -3
  4. package/dist/dts/connect/message.d.ts.map +1 -1
  5. package/dist/dts/metadata/metadata.types.d.ts +1 -0
  6. package/dist/dts/metadata/metadata.types.d.ts.map +1 -1
  7. package/dist/dts/resources/genesis/genesis.d.ts +7 -1
  8. package/dist/dts/resources/genesis/genesis.d.ts.map +1 -1
  9. package/dist/dts/testing/mocks/resources/genesis/genesis.d.ts +1 -0
  10. package/dist/dts/testing/mocks/resources/genesis/genesis.d.ts.map +1 -1
  11. package/dist/esm/resources/genesis/genesis.js +15 -3
  12. package/dist/esm/testing/mocks/resources/genesis/genesis.js +5 -0
  13. package/dist/foundation-comms.api.json +172 -27
  14. package/dist/foundation-comms.d.ts +23 -13
  15. package/docs/api/foundation-comms.commitparams.md +1 -0
  16. package/docs/api/foundation-comms.connect.snapshot.md +2 -2
  17. package/docs/api/foundation-comms.connect.stream.md +2 -2
  18. package/docs/api/foundation-comms.connect.streamstate.md +2 -2
  19. package/docs/api/foundation-comms.defaultconnect.getavailableresources.md +2 -2
  20. package/docs/api/foundation-comms.defaultconnect.snapshot.md +2 -2
  21. package/docs/api/foundation-comms.defaultconnect.stream.md +2 -2
  22. package/docs/api/foundation-comms.defaultconnect.streamstate.md +2 -2
  23. package/docs/api/foundation-comms.defaultconnect.streamwithoutautoteardown.md +2 -2
  24. package/docs/api/{foundation-comms.defaultgenesisresources.getresources.md → foundation-comms.defaultgenesisresources.fetchresources.md} +3 -3
  25. package/docs/api/foundation-comms.defaultgenesisresources.getallresources.md +16 -0
  26. package/docs/api/foundation-comms.defaultgenesisresources.md +2 -1
  27. package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogonmessage.md +2 -2
  28. package/docs/api/foundation-comms.genesisresources.getallresources.md +13 -0
  29. package/docs/api/foundation-comms.genesisresources.md +1 -0
  30. package/docs/api/foundation-comms.genesisresourcesmock.getallresources.md +15 -0
  31. package/docs/api/foundation-comms.genesisresourcesmock.md +1 -0
  32. package/docs/api/foundation-comms.message.md +1 -1
  33. package/docs/api/foundation-comms.messagebuilder.createresourcesmessage.md +2 -2
  34. package/docs/api/foundation-comms.requestparams.md +1 -0
  35. package/docs/api/foundation-comms.serverrow.md +1 -0
  36. package/docs/api-report.md +23 -13
  37. package/package.json +13 -13
@@ -182,6 +182,7 @@ export declare type CommitParams = {
182
182
  HOSTNAME?: string;
183
183
  IGNORE_WARNINGS?: boolean;
184
184
  VALIDATE?: boolean;
185
+ [key: string]: any;
185
186
  };
186
187
 
187
188
  /**
@@ -252,7 +253,7 @@ export declare interface Connect {
252
253
  * @param params - Additional parameters to pass to the server.
253
254
  * @returns A promise that resolves with the snapshot data.
254
255
  */
255
- snapshot(resourceName: string, params?: any): Promise<Message>;
256
+ snapshot(resourceName: string, params?: DataserverParams): Promise<Message>;
256
257
  /**
257
258
  * Starts listening for updates on the specified resource.
258
259
  * @public
@@ -262,7 +263,7 @@ export declare interface Connect {
262
263
  * @param params - Additional parameters to pass to the server.
263
264
  * @returns An observable that emits messages received from the server.
264
265
  */
265
- stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
266
+ stream(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
266
267
  /**
267
268
  * Starts listening for updates on the specified resource.
268
269
  * @public
@@ -273,7 +274,7 @@ export declare interface Connect {
273
274
  * @param initialState - State of the list to start with, defaults to empty array.
274
275
  * @returns An observable that emits latest state of the list it subscribes to.
275
276
  */
276
- streamState(resourceName: string, onMessage: Function, onError: Function, params?: any, initialState?: any[]): Observable<any[]>;
277
+ streamState(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams, initialState?: any[]): Observable<any[]>;
277
278
  /**
278
279
  * Starts listening for updates on the specified resource without auto-teardown.
279
280
  * @deprecated - Use `stream` instead. Will be removed in v15.
@@ -284,7 +285,7 @@ export declare interface Connect {
284
285
  * @param params - Additional parameters to pass to the server.
285
286
  * @returns An observable that emits messages received from the server.
286
287
  */
287
- streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
288
+ streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
288
289
  /**
289
290
  * Requests additional rows of data for the specified source reference.
290
291
  * @public
@@ -1664,17 +1665,17 @@ export declare class DefaultConnect implements Connect {
1664
1665
  send<T>(message: Message<any>, needsHandling?: boolean): Promise<any>;
1665
1666
  connect(host?: string): Promise<boolean>;
1666
1667
  disconnect(): void;
1667
- snapshot(resourceName: string, params?: any): Promise<Message>;
1668
- stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
1669
- streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: any, initialState?: any[]): Observable<any[]>;
1670
- streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
1668
+ snapshot(resourceName: string, params?: DataserverParams): Promise<Message>;
1669
+ stream(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
1670
+ streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: DataserverParams, initialState?: any[]): Observable<any[]>;
1671
+ streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
1671
1672
  getMoreRows(sourceRef: string, viewNumber?: number): Promise<Message>;
1672
1673
  getMoreColumns(sourceRef: string): Promise<Message>;
1673
1674
  dataLogoff(streamSourceRef: string): Promise<Message>;
1674
1675
  getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
1675
1676
  getJSONSchema(resourceName: string, useCache?: boolean): Promise<SchemaResponse>;
1676
1677
  request(resourceName: string, params?: RequestParams): Promise<Message>;
1677
- getAvailableResources(params?: any): Promise<ResourcesMessage>;
1678
+ getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
1678
1679
  commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
1679
1680
  }
1680
1681
 
@@ -1896,9 +1897,11 @@ export declare class DefaultGenesisResources implements GenesisResources {
1896
1897
  isValidResource(resourceName: string): Promise<boolean>;
1897
1898
  /** {@inheritDoc GenesisResources.getResourceTypeFor} */
1898
1899
  getResourceTypeFor(resourceName: string): Promise<ResourceType>;
1900
+ /** {@inheritDoc GenesisResources.allResources} */
1901
+ getAllResources(): Promise<ResourceItem[]>;
1899
1902
  /** {@inheritDoc GenesisResources.destroy} */
1900
1903
  destroy(): void;
1901
- protected getResources(): Promise<void>;
1904
+ protected fetchResources(): Promise<void>;
1902
1905
  protected postLoadedMessage(): void;
1903
1906
  }
1904
1907
 
@@ -2078,7 +2081,7 @@ export declare class DefaultMessageBuilder implements MessageBuilder {
2078
2081
  constructor(session: Session, uuid: UUID);
2079
2082
  createLoginMessage(credentials: AuthInfo): Message<MessageDetails.Login>;
2080
2083
  createLogoutMessage(loginResult?: LoginResult): Message;
2081
- createDataLogonMessage(resourceName: string, params?: any): Message<MessageDetails.DataserverRequest>;
2084
+ createDataLogonMessage(resourceName: string, params?: DataserverParams): Message<MessageDetails.DataserverRequest>;
2082
2085
  createDataLogoffMessage<T = any>(sourceRef: string): Message<T>;
2083
2086
  createRequestMessage<T = any>(resourceName: string, params?: RequestParams): Message<T>;
2084
2087
  createResourcesMessage<T = any>(params?: RequestParams): Message<T>;
@@ -2658,6 +2661,10 @@ export declare interface GenesisResources {
2658
2661
  * @param resourceName - The name of the resource to get the type for.
2659
2662
  */
2660
2663
  getResourceTypeFor: (resourceName: string) => Promise<ResourceType>;
2664
+ /**
2665
+ * All available resources
2666
+ */
2667
+ getAllResources: () => Promise<ResourceItem[]>;
2661
2668
  /**
2662
2669
  * Destroy and garbage collect
2663
2670
  */
@@ -2749,6 +2756,7 @@ export declare class GenesisResourcesMock implements GenesisResources {
2749
2756
  isValidResource(resourceName: string): Promise<boolean>;
2750
2757
  /** {@inheritDoc GenesisResources.getResourceTypeFor} */
2751
2758
  getResourceTypeFor(resourceName: string): Promise<ResourceType>;
2759
+ getAllResources(): Promise<ResourceItem[]>;
2752
2760
  destroy(): void;
2753
2761
  }
2754
2762
 
@@ -3241,7 +3249,7 @@ export declare const MAX_RECONNECT_ATTEMPTS = 10;
3241
3249
  export declare type Message<T = void | any> = {
3242
3250
  REPLY?: any[];
3243
3251
  CODE?: MessageCode | string;
3244
- DETAILS?: T;
3252
+ DETAILS?: T | any;
3245
3253
  LOGGED_OUT?: boolean;
3246
3254
  ERROR?: MessageError[];
3247
3255
  MESSAGE_TYPE?: MessageType | EventMessageType | string;
@@ -3344,7 +3352,7 @@ export declare interface MessageBuilder {
3344
3352
  * @param params - The additional parameters.
3345
3353
  * @returns The request message.
3346
3354
  */
3347
- createResourcesMessage<T = any>(params?: any): Message<T>;
3355
+ createResourcesMessage<T = any>(params?: RequestParams): Message<T>;
3348
3356
  /**
3349
3357
  * Creates a metadata fetch message.
3350
3358
  *
@@ -3973,6 +3981,7 @@ export declare type RequestDetailsParam = {
3973
3981
  export declare type RequestParams = {
3974
3982
  DETAILS?: RequestDetailsParam | any;
3975
3983
  REQUEST?: any;
3984
+ [key: string]: any;
3976
3985
  };
3977
3986
 
3978
3987
  /**
@@ -4136,6 +4145,7 @@ export declare type ServerRow = {
4136
4145
  OPERATION: 'INSERT' | 'MODIFY' | 'DELETE';
4137
4146
  ROW_REF: string;
4138
4147
  };
4148
+ [key: string]: any;
4139
4149
  };
4140
4150
 
4141
4151
  /**
@@ -14,5 +14,6 @@ export type CommitParams = {
14
14
  HOSTNAME?: string;
15
15
  IGNORE_WARNINGS?: boolean;
16
16
  VALIDATE?: boolean;
17
+ [key: string]: any;
17
18
  };
18
19
  ```
@@ -9,7 +9,7 @@ Retrieves a snapshot of data for the specified resource.
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- snapshot(resourceName: string, params?: any): Promise<Message>;
12
+ snapshot(resourceName: string, params?: DataserverParams): Promise<Message>;
13
13
  ```
14
14
 
15
15
  ## Parameters
@@ -17,7 +17,7 @@ snapshot(resourceName: string, params?: any): Promise<Message>;
17
17
  | Parameter | Type | Description |
18
18
  | --- | --- | --- |
19
19
  | resourceName | string | The name of the resource to retrieve the snapshot for. |
20
- | params | any | _(Optional)_ Additional parameters to pass to the server. |
20
+ | params | [DataserverParams](./foundation-comms.dataserverparams.md) | _(Optional)_ Additional parameters to pass to the server. |
21
21
 
22
22
  **Returns:**
23
23
 
@@ -9,7 +9,7 @@ Starts listening for updates on the specified resource.
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
12
+ stream(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
13
13
  ```
14
14
 
15
15
  ## Parameters
@@ -19,7 +19,7 @@ stream(resourceName: string, onMessage: Function, onError: Function, params?: an
19
19
  | resourceName | string | The name of the resource to listen for updates on. |
20
20
  | onMessage | Function | A callback function to handle received messages. |
21
21
  | onError | Function | A callback function to handle errors. |
22
- | params | any | _(Optional)_ Additional parameters to pass to the server. |
22
+ | params | [DataserverParams](./foundation-comms.dataserverparams.md) | _(Optional)_ Additional parameters to pass to the server. |
23
23
 
24
24
  **Returns:**
25
25
 
@@ -9,7 +9,7 @@ Starts listening for updates on the specified resource.
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- streamState(resourceName: string, onMessage: Function, onError: Function, params?: any, initialState?: any[]): Observable<any[]>;
12
+ streamState(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams, initialState?: any[]): Observable<any[]>;
13
13
  ```
14
14
 
15
15
  ## Parameters
@@ -19,7 +19,7 @@ streamState(resourceName: string, onMessage: Function, onError: Function, params
19
19
  | resourceName | string | The name of the resource to listen for updates on. |
20
20
  | onMessage | Function | A callback function to handle received messages. |
21
21
  | onError | Function | A callback function to handle errors. |
22
- | params | any | _(Optional)_ Additional parameters to pass to the server. |
22
+ | params | [DataserverParams](./foundation-comms.dataserverparams.md) | _(Optional)_ Additional parameters to pass to the server. |
23
23
  | initialState | any\[\] | _(Optional)_ State of the list to start with, defaults to empty array. |
24
24
 
25
25
  **Returns:**
@@ -7,14 +7,14 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- getAvailableResources(params?: any): Promise<ResourcesMessage>;
10
+ getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
11
11
  ```
12
12
 
13
13
  ## Parameters
14
14
 
15
15
  | Parameter | Type | Description |
16
16
  | --- | --- | --- |
17
- | params | any | _(Optional)_ |
17
+ | params | [RequestParams](./foundation-comms.requestparams.md) | _(Optional)_ |
18
18
 
19
19
  **Returns:**
20
20
 
@@ -7,7 +7,7 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- snapshot(resourceName: string, params?: any): Promise<Message>;
10
+ snapshot(resourceName: string, params?: DataserverParams): Promise<Message>;
11
11
  ```
12
12
 
13
13
  ## Parameters
@@ -15,7 +15,7 @@ snapshot(resourceName: string, params?: any): Promise<Message>;
15
15
  | Parameter | Type | Description |
16
16
  | --- | --- | --- |
17
17
  | resourceName | string | |
18
- | params | any | _(Optional)_ |
18
+ | params | [DataserverParams](./foundation-comms.dataserverparams.md) | _(Optional)_ |
19
19
 
20
20
  **Returns:**
21
21
 
@@ -7,7 +7,7 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
10
+ stream(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
11
11
  ```
12
12
 
13
13
  ## Parameters
@@ -17,7 +17,7 @@ stream(resourceName: string, onMessage: Function, onError: Function, params?: an
17
17
  | resourceName | string | |
18
18
  | onMessage | Function | |
19
19
  | onError | Function | |
20
- | params | any | _(Optional)_ |
20
+ | params | [DataserverParams](./foundation-comms.dataserverparams.md) | _(Optional)_ |
21
21
 
22
22
  **Returns:**
23
23
 
@@ -7,7 +7,7 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: any, initialState?: any[]): Observable<any[]>;
10
+ streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: DataserverParams, initialState?: any[]): Observable<any[]>;
11
11
  ```
12
12
 
13
13
  ## Parameters
@@ -17,7 +17,7 @@ streamState(resourceName: string, onMessage?: Function, onError?: Function, para
17
17
  | resourceName | string | |
18
18
  | onMessage | Function | _(Optional)_ |
19
19
  | onError | Function | _(Optional)_ |
20
- | params | any | _(Optional)_ |
20
+ | params | [DataserverParams](./foundation-comms.dataserverparams.md) | _(Optional)_ |
21
21
  | initialState | any\[\] | _(Optional)_ |
22
22
 
23
23
  **Returns:**
@@ -7,7 +7,7 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
10
+ streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
11
11
  ```
12
12
 
13
13
  ## Parameters
@@ -17,7 +17,7 @@ streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Fu
17
17
  | resourceName | string | |
18
18
  | onMessage | Function | |
19
19
  | onError | Function | |
20
- | params | any | _(Optional)_ |
20
+ | params | [DataserverParams](./foundation-comms.dataserverparams.md) | _(Optional)_ |
21
21
 
22
22
  **Returns:**
23
23
 
@@ -1,13 +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; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [getResources](./foundation-comms.defaultgenesisresources.getresources.md)
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) &gt; [fetchResources](./foundation-comms.defaultgenesisresources.fetchresources.md)
4
4
 
5
- ## DefaultGenesisResources.getResources() method
5
+ ## DefaultGenesisResources.fetchResources() method
6
6
 
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- protected getResources(): Promise<void>;
10
+ protected fetchResources(): Promise<void>;
11
11
  ```
12
12
  **Returns:**
13
13
 
@@ -0,0 +1,16 @@
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; [getAllResources](./foundation-comms.defaultgenesisresources.getallresources.md)
4
+
5
+ ## DefaultGenesisResources.getAllResources() method
6
+
7
+
8
+ **Signature:**
9
+
10
+ ```typescript
11
+ getAllResources(): Promise<ResourceItem[]>;
12
+ ```
13
+ **Returns:**
14
+
15
+ Promise&lt;[ResourceItem](./foundation-comms.resourceitem.md)<!-- -->\[\]&gt;
16
+
@@ -33,7 +33,8 @@ export declare class DefaultGenesisResources implements GenesisResources
33
33
  | Method | Modifiers | Description |
34
34
  | --- | --- | --- |
35
35
  | [destroy()](./foundation-comms.defaultgenesisresources.destroy.md) | | Destroy and garbage collect |
36
- | [getResources()](./foundation-comms.defaultgenesisresources.getresources.md) | <code>protected</code> | |
36
+ | [fetchResources()](./foundation-comms.defaultgenesisresources.fetchresources.md) | <code>protected</code> | |
37
+ | [getAllResources()](./foundation-comms.defaultgenesisresources.getallresources.md) | | |
37
38
  | [getResourceTypeFor(resourceName)](./foundation-comms.defaultgenesisresources.getresourcetypefor.md) | | Gets the type of resource |
38
39
  | [isValidResource(resourceName)](./foundation-comms.defaultgenesisresources.isvalidresource.md) | | Checks if the resource exists |
39
40
  | [postLoadedMessage()](./foundation-comms.defaultgenesisresources.postloadedmessage.md) | <code>protected</code> | |
@@ -7,7 +7,7 @@
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- createDataLogonMessage(resourceName: string, params?: any): Message<MessageDetails.DataserverRequest>;
10
+ createDataLogonMessage(resourceName: string, params?: DataserverParams): Message<MessageDetails.DataserverRequest>;
11
11
  ```
12
12
 
13
13
  ## Parameters
@@ -15,7 +15,7 @@ createDataLogonMessage(resourceName: string, params?: any): Message<MessageDetai
15
15
  | Parameter | Type | Description |
16
16
  | --- | --- | --- |
17
17
  | resourceName | string | |
18
- | params | any | _(Optional)_ |
18
+ | params | [DataserverParams](./foundation-comms.dataserverparams.md) | _(Optional)_ |
19
19
 
20
20
  **Returns:**
21
21
 
@@ -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; [getAllResources](./foundation-comms.genesisresources.getallresources.md)
4
+
5
+ ## GenesisResources.getAllResources property
6
+
7
+ All available resources
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ getAllResources: () => Promise<ResourceItem[]>;
13
+ ```
@@ -21,6 +21,7 @@ A lazy shared Genesis Resources lookup system. N number of callers can request i
21
21
  | Property | Modifiers | Type | Description |
22
22
  | --- | --- | --- | --- |
23
23
  | [destroy](./foundation-comms.genesisresources.destroy.md) | | () =&gt; void | Destroy and garbage collect |
24
+ | [getAllResources](./foundation-comms.genesisresources.getallresources.md) | | () =&gt; Promise&lt;[ResourceItem](./foundation-comms.resourceitem.md)<!-- -->\[\]&gt; | All available resources |
24
25
  | [getResourceTypeFor](./foundation-comms.genesisresources.getresourcetypefor.md) | | (resourceName: string) =&gt; Promise&lt;[ResourceType](./foundation-comms.resourcetype.md)<!-- -->&gt; | Gets the type of resource |
25
26
  | [isValidResource](./foundation-comms.genesisresources.isvalidresource.md) | | (resourceName: string) =&gt; Promise&lt;boolean&gt; | Checks if the resource exists |
26
27
 
@@ -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; [GenesisResourcesMock](./foundation-comms.genesisresourcesmock.md) &gt; [getAllResources](./foundation-comms.genesisresourcesmock.getallresources.md)
4
+
5
+ ## GenesisResourcesMock.getAllResources() method
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ getAllResources(): Promise<ResourceItem[]>;
11
+ ```
12
+ **Returns:**
13
+
14
+ Promise&lt;[ResourceItem](./foundation-comms.resourceitem.md)<!-- -->\[\]&gt;
15
+
@@ -25,6 +25,7 @@ export declare class GenesisResourcesMock implements GenesisResources
25
25
  | Method | Modifiers | Description |
26
26
  | --- | --- | --- |
27
27
  | [destroy()](./foundation-comms.genesisresourcesmock.destroy.md) | | |
28
+ | [getAllResources()](./foundation-comms.genesisresourcesmock.getallresources.md) | | |
28
29
  | [getResourceTypeFor(resourceName)](./foundation-comms.genesisresourcesmock.getresourcetypefor.md) | | Gets the type of resource |
29
30
  | [isValidResource(resourceName)](./foundation-comms.genesisresourcesmock.isvalidresource.md) | | Checks if the resource exists |
30
31
 
@@ -12,7 +12,7 @@ Base Message type for all DETAIL variants
12
12
  export type Message<T = void | any> = {
13
13
  REPLY?: any[];
14
14
  CODE?: MessageCode | string;
15
- DETAILS?: T;
15
+ DETAILS?: T | any;
16
16
  LOGGED_OUT?: boolean;
17
17
  ERROR?: MessageError[];
18
18
  MESSAGE_TYPE?: MessageType | EventMessageType | string;
@@ -9,14 +9,14 @@ Creates a message for getting list of resources.
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- createResourcesMessage<T = any>(params?: any): Message<T>;
12
+ createResourcesMessage<T = any>(params?: RequestParams): Message<T>;
13
13
  ```
14
14
 
15
15
  ## Parameters
16
16
 
17
17
  | Parameter | Type | Description |
18
18
  | --- | --- | --- |
19
- | params | any | _(Optional)_ The additional parameters. |
19
+ | params | [RequestParams](./foundation-comms.requestparams.md) | _(Optional)_ The additional parameters. |
20
20
 
21
21
  **Returns:**
22
22
 
@@ -12,6 +12,7 @@ Parameters for a REQ\_ messages
12
12
  export type RequestParams = {
13
13
  DETAILS?: RequestDetailsParam | any;
14
14
  REQUEST?: any;
15
+ [key: string]: any;
15
16
  };
16
17
  ```
17
18
  **References:** [RequestDetailsParam](./foundation-comms.requestdetailsparam.md)
@@ -14,5 +14,6 @@ export type ServerRow = {
14
14
  OPERATION: 'INSERT' | 'MODIFY' | 'DELETE';
15
15
  ROW_REF: string;
16
16
  };
17
+ [key: string]: any;
17
18
  };
18
19
  ```
@@ -145,6 +145,7 @@ export type CommitParams = {
145
145
  HOSTNAME?: string;
146
146
  IGNORE_WARNINGS?: boolean;
147
147
  VALIDATE?: boolean;
148
+ [key: string]: any;
148
149
  };
149
150
 
150
151
  // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Connect" because one of its declarations is marked as @internal
@@ -174,11 +175,11 @@ export interface Connect {
174
175
  send<T>(message: Message<T | any>, needsHandling?: boolean): Promise<Message | any>;
175
176
  // @internal
176
177
  setValidSession(valid: boolean): void;
177
- snapshot(resourceName: string, params?: any): Promise<Message>;
178
- stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
179
- streamState(resourceName: string, onMessage: Function, onError: Function, params?: any, initialState?: any[]): Observable<any[]>;
178
+ snapshot(resourceName: string, params?: DataserverParams): Promise<Message>;
179
+ stream(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
180
+ streamState(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams, initialState?: any[]): Observable<any[]>;
180
181
  // @alpha @deprecated
181
- streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
182
+ streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
182
183
  }
183
184
 
184
185
  // @internal
@@ -941,7 +942,7 @@ export class DefaultConnect implements Connect {
941
942
  // (undocumented)
942
943
  disconnect(): void;
943
944
  // (undocumented)
944
- getAvailableResources(params?: any): Promise<ResourcesMessage>;
945
+ getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
945
946
  // (undocumented)
946
947
  getJSONSchema(resourceName: string, useCache?: boolean): Promise<SchemaResponse>;
947
948
  // (undocumented)
@@ -969,15 +970,15 @@ export class DefaultConnect implements Connect {
969
970
  // @deprecated (undocumented)
970
971
  setValidSession(valid: boolean): void;
971
972
  // (undocumented)
972
- snapshot(resourceName: string, params?: any): Promise<Message>;
973
+ snapshot(resourceName: string, params?: DataserverParams): Promise<Message>;
973
974
  // (undocumented)
974
975
  socket: Socket;
975
976
  // (undocumented)
976
- stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
977
+ stream(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
977
978
  // (undocumented)
978
- streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: any, initialState?: any[]): Observable<any[]>;
979
+ streamState(resourceName: string, onMessage?: Function, onError?: Function, params?: DataserverParams, initialState?: any[]): Observable<any[]>;
979
980
  // (undocumented)
980
- streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
981
+ streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
981
982
  }
982
983
 
983
984
  // @public
@@ -1232,7 +1233,11 @@ export class DefaultGenesisResources implements GenesisResources {
1232
1233
  // (undocumented)
1233
1234
  destroy(): void;
1234
1235
  // (undocumented)
1235
- protected getResources(): Promise<void>;
1236
+ protected fetchResources(): Promise<void>;
1237
+ // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "GenesisResources" has more than one declaration; you need to add a TSDoc member reference selector
1238
+ //
1239
+ // (undocumented)
1240
+ getAllResources(): Promise<ResourceItem[]>;
1236
1241
  // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "GenesisResources" has more than one declaration; you need to add a TSDoc member reference selector
1237
1242
  //
1238
1243
  // (undocumented)
@@ -1338,7 +1343,7 @@ export class DefaultMessageBuilder implements MessageBuilder {
1338
1343
  // (undocumented)
1339
1344
  createDataLogoffMessage<T = any>(sourceRef: string): Message<T>;
1340
1345
  // (undocumented)
1341
- createDataLogonMessage(resourceName: string, params?: any): Message<MessageDetails.DataserverRequest>;
1346
+ createDataLogonMessage(resourceName: string, params?: DataserverParams): Message<MessageDetails.DataserverRequest>;
1342
1347
  // (undocumented)
1343
1348
  createForgotPasswordMessage(username: string, returnUrl: string, requester?: string): Message<MessageDetails.ForgotPassword>;
1344
1349
  // (undocumented)
@@ -1722,6 +1727,7 @@ export type GenesisConnectEvents = 'stream' | 'commit';
1722
1727
  // @public
1723
1728
  export interface GenesisResources {
1724
1729
  destroy: () => void;
1730
+ getAllResources: () => Promise<ResourceItem[]>;
1725
1731
  getResourceTypeFor: (resourceName: string) => Promise<ResourceType>;
1726
1732
  isValidResource: (resourceName: string) => Promise<boolean>;
1727
1733
  }
@@ -1762,6 +1768,8 @@ export type GenesisResourcesEvents = {
1762
1768
  export class GenesisResourcesMock implements GenesisResources {
1763
1769
  // (undocumented)
1764
1770
  destroy(): void;
1771
+ // (undocumented)
1772
+ getAllResources(): Promise<ResourceItem[]>;
1765
1773
  // Warning: (ae-unresolved-inheritdoc-reference) The @inheritDoc reference could not be resolved: The reference is ambiguous because "GenesisResources" has more than one declaration; you need to add a TSDoc member reference selector
1766
1774
  //
1767
1775
  // (undocumented)
@@ -1963,7 +1971,7 @@ export const MAX_RECONNECT_ATTEMPTS = 10;
1963
1971
  export type Message<T = void | any> = {
1964
1972
  REPLY?: any[];
1965
1973
  CODE?: MessageCode | string;
1966
- DETAILS?: T;
1974
+ DETAILS?: T | any;
1967
1975
  LOGGED_OUT?: boolean;
1968
1976
  ERROR?: MessageError[];
1969
1977
  MESSAGE_TYPE?: MessageType | EventMessageType | string;
@@ -2002,7 +2010,7 @@ export interface MessageBuilder {
2002
2010
  createMoreRowsMessage(sourceRef: string, viewNumber?: number): Message<MessageDetails.MoreRows>;
2003
2011
  createRefreshTokenMessage(): Message<MessageDetails.RefreshToken>;
2004
2012
  createRequestMessage<T = any>(resourceName: string, params?: RequestParams): Message<T>;
2005
- createResourcesMessage<T = any>(params?: any): Message<T>;
2013
+ createResourcesMessage<T = any>(params?: RequestParams): Message<T>;
2006
2014
  }
2007
2015
 
2008
2016
  // @internal
@@ -2316,6 +2324,7 @@ export type RequestDetailsParam = {
2316
2324
  export type RequestParams = {
2317
2325
  DETAILS?: RequestDetailsParam | any;
2318
2326
  REQUEST?: any;
2327
+ [key: string]: any;
2319
2328
  };
2320
2329
 
2321
2330
  // @public
@@ -2424,6 +2433,7 @@ export type ServerRow = {
2424
2433
  OPERATION: 'INSERT' | 'MODIFY' | 'DELETE';
2425
2434
  ROW_REF: string;
2426
2435
  };
2436
+ [key: string]: any;
2427
2437
  };
2428
2438
 
2429
2439
  // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "Session" because one of its declarations is marked as @internal
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-comms",
3
3
  "description": "Genesis Foundation UI Comms",
4
- "version": "14.219.2",
4
+ "version": "14.220.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -75,23 +75,23 @@
75
75
  }
76
76
  },
77
77
  "devDependencies": {
78
- "@genesislcap/foundation-testing": "14.219.2",
79
- "@genesislcap/genx": "14.219.2",
80
- "@genesislcap/rollup-builder": "14.219.2",
81
- "@genesislcap/ts-builder": "14.219.2",
82
- "@genesislcap/uvu-playwright-builder": "14.219.2",
83
- "@genesislcap/vite-builder": "14.219.2",
84
- "@genesislcap/webpack-builder": "14.219.2",
78
+ "@genesislcap/foundation-testing": "14.220.0",
79
+ "@genesislcap/genx": "14.220.0",
80
+ "@genesislcap/rollup-builder": "14.220.0",
81
+ "@genesislcap/ts-builder": "14.220.0",
82
+ "@genesislcap/uvu-playwright-builder": "14.220.0",
83
+ "@genesislcap/vite-builder": "14.220.0",
84
+ "@genesislcap/webpack-builder": "14.220.0",
85
85
  "@types/js-cookie": "^3.0.2",
86
86
  "@types/json-schema": "^7.0.11",
87
87
  "@types/webappsec-credential-management": "^0.6.2",
88
88
  "rimraf": "^5.0.0"
89
89
  },
90
90
  "dependencies": {
91
- "@genesislcap/foundation-broadcast-channel": "14.219.2",
92
- "@genesislcap/foundation-logger": "14.219.2",
93
- "@genesislcap/foundation-user": "14.219.2",
94
- "@genesislcap/foundation-utils": "14.219.2",
91
+ "@genesislcap/foundation-broadcast-channel": "14.220.0",
92
+ "@genesislcap/foundation-logger": "14.220.0",
93
+ "@genesislcap/foundation-user": "14.220.0",
94
+ "@genesislcap/foundation-utils": "14.220.0",
95
95
  "@microsoft/fast-element": "^1.12.0",
96
96
  "@microsoft/fast-foundation": "2.49.6",
97
97
  "analytics": "^0.8.0",
@@ -111,5 +111,5 @@
111
111
  "publishConfig": {
112
112
  "access": "public"
113
113
  },
114
- "gitHead": "91bfe243c47884d0a7bd6df59ae1fea0736b79cb"
114
+ "gitHead": "18dcf3cbca18cf957d0bb082cb87c8b677ffe7b6"
115
115
  }