@genesislcap/foundation-comms 14.379.0 → 14.380.1-TAMTECH-262.2

package/dist/foundation-comms.d.ts

@@ -392,9 +392,10 @@ export declare interface Connect {
      * Sends a request to the server to get available resources.
      * @public
      * @param params - An object containing optional parameters to include in the request.
+     * @param useCache - Whether to use the cached resources if available. Default: true.
      * @returns A promise that resolves to a Message containing the server's response with available resources.
      */
-    getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
+    getAvailableResources(params?: RequestParams, useCache?: boolean): Promise<ResourcesMessage>;
     /**
      * Sends a request to the server to retrieve data or perform an action.
      * @public
@@ -592,7 +593,7 @@ export declare class ConnectMock implements Connect {
     disconnect(): void;
     getMetadata(resourceName: string): Promise<Metadata>;
     request(resourceName: string, params?: RequestParams): Promise<Message>;
-    getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
+    getAvailableResources(params?: RequestParams, useCache?: boolean): Promise<ResourcesMessage>;
     snapshot(resourceName: string, params?: any): Promise<Message>;
     stream(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message>;
     streamState(resourceName: string, onMessage: Function, onError: Function, params?: any, initialState?: any[]): Observable<any[]>;
@@ -1852,7 +1853,7 @@ export declare class DefaultConnect implements Connect {
     getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
     getJSONSchema(resourceName: string, useCache?: boolean): Promise<SchemaResponse>;
     request(resourceName: string, params?: RequestParams): Promise<Message>;
-    getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
+    getAvailableResources(params?: RequestParams, useCache?: boolean): Promise<ResourcesMessage>;
     commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
 }
 
@@ -2211,7 +2212,7 @@ export declare class DefaultHttpConnect implements Connect {
     getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
     getJSONSchema(resourceName: string): Promise<SchemaResponse>;
     request(resourceName: string, params?: RequestParams): Promise<Message>;
-    getAvailableResources(params?: any): Promise<ResourcesMessage>;
+    getAvailableResources(params?: any, useCache?: boolean): Promise<ResourcesMessage>;
     commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
     private maybeTurbo;
     private updateIntervals;
@@ -2220,6 +2221,12 @@ export declare class DefaultHttpConnect implements Connect {
     private static getUrl;
 }
 
+/**
+ * The default configuration for connecting to an HTTP service.
+ * @public
+ */
+export declare const defaultHttpConnectConfig: HttpConnectConfig;
+
 /**
  * The default implementation for the KVStorage interface.
  * @alpha
@@ -2340,12 +2347,16 @@ export declare class DefaultMessageBuilder implements MessageBuilder {
 export declare class DefaultMetaCache implements MetaCache {
     cachedMetadata: Map<string, Metadata>;
     cachedJsonSchema: Map<string, SchemaResponse>;
+    cachedResources: ResourcesMessage | null;
     getMetadataFor(resourceName: string): Metadata;
     getJsonSchemaFor(resourceName: string): SchemaResponse;
+    getResources(): ResourcesMessage;
     hasMetadataFor(resourceName: string): boolean;
     hasJsonSchemaFor(resourceName: string): boolean;
+    hasResources(): boolean;
     setMetadataFor(resourceName: string, metadata: Metadata): void;
     setJsonSchemaFor(resourceName: string, schemaResponse: SchemaResponse): void;
+    setResources(resources: ResourcesMessage): void;
 }
 
 /**
@@ -3200,7 +3211,7 @@ export declare const HttpConnect: InterfaceSymbol<Connect>;
  * Configuration options for the Connect (HTTP) instance.
  * @public
  */
-declare interface HttpConnectConfig {
+export declare interface HttpConnectConfig {
     /**
      * Configuration options for http polling.
      */
@@ -3211,7 +3222,7 @@ declare interface HttpConnectConfig {
  * Configuration options for the Connect (HTTP) instance.
  * @internal
  */
-declare const HttpConnectConfig: InterfaceSymbol<HttpConnectConfig>;
+export declare const HttpConnectConfig: InterfaceSymbol<HttpConnectConfig>;
 
 /**
  * An error thrown when an HTTP request fails with a non-2xx status code.
@@ -3226,7 +3237,7 @@ export declare interface HttpError extends Error {
  * Configuration options for http connection.
  * @public
  */
-declare interface HttpPollingConfig {
+export declare interface HttpPollingConfig {
     /**
      * The frequency of polling.
      */
@@ -3887,10 +3898,10 @@ export declare enum MessageType {
 }
 
 /**
- * Union type of MetadataCache and JsonSchemaCache
+ * Union type of MetadataCache, JsonSchemaCache and ResourcesCache
  * @public
  */
-export declare type MetaCache = MetadataCache & JsonSchemaCache;
+export declare type MetaCache = MetadataCache & JsonSchemaCache & ResourcesCache;
 
 /**
  * The DI token for the MetaCache interface.
@@ -4172,7 +4183,7 @@ export declare type PingMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' |
  * Configuration options for http polling.
  * @public
  */
-declare interface PollingConfiguration {
+export declare interface PollingConfiguration {
     /**
      * The temporary polling frequency.
      */
@@ -4309,6 +4320,17 @@ export declare type ResourceItem = {
     RESOURCE_TYPE: string;
 };
 
+/**
+ * A resources cache definition
+ * @public
+ */
+export declare interface ResourcesCache {
+    cachedResources: ResourcesMessage | null;
+    getResources(): ResourcesMessage;
+    hasResources(): boolean;
+    setResources(resources: ResourcesMessage): void;
+}
+
 /**
  * @public
  */

package/docs/api/foundation-comms.connect.getavailableresources.md

@@ -9,7 +9,7 @@ Sends a request to the server to get available resources.
 **Signature:**
 
 ```typescript
-getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
+getAvailableResources(params?: RequestParams, useCache?: boolean): Promise<ResourcesMessage>;
 ```
 
 ## Parameters
@@ -45,6 +45,22 @@ params
 _(Optional)_ An object containing optional parameters to include in the request.
 
 
+</td></tr>
+<tr><td>
+
+useCache
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether to use the cached resources if available. Default: true.
+
+
 </td></tr>
 </tbody></table>
 

package/docs/api/foundation-comms.connect.md

@@ -195,7 +195,7 @@ Disconnects from the server.
 </td></tr>
 <tr><td>
 
-[getAvailableResources(params)](./foundation-comms.connect.getavailableresources.md)
+[getAvailableResources(params, useCache)](./foundation-comms.connect.getavailableresources.md)
 
 
 </td><td>

package/docs/api/foundation-comms.defaultconnect.getavailableresources.md

@@ -7,7 +7,7 @@
 **Signature:**
 
 ```typescript
-getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
+getAvailableResources(params?: RequestParams, useCache?: boolean): Promise<ResourcesMessage>;
 ```
 
 ## Parameters
@@ -43,6 +43,22 @@ params
 _(Optional)_
 
 
+</td></tr>
+<tr><td>
+
+useCache
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
 </td></tr>
 </tbody></table>
 

package/docs/api/foundation-comms.defaultconnect.md

@@ -250,7 +250,7 @@ Description
 </td></tr>
 <tr><td>
 
-[getAvailableResources(params)](./foundation-comms.defaultconnect.getavailableresources.md)
+[getAvailableResources(params, useCache)](./foundation-comms.defaultconnect.getavailableresources.md)
 
 
 </td><td>

package/docs/api/foundation-comms.defaulthttpconnect._constructor_.md

@@ -107,7 +107,7 @@ config
 
 </td><td>
 
-HttpConnectConfig
+[HttpConnectConfig](./foundation-comms.httpconnectconfig.md)
 
 
 </td><td>

package/docs/api/foundation-comms.defaulthttpconnect.getavailableresources.md

@@ -7,7 +7,7 @@
 **Signature:**
 
 ```typescript
-getAvailableResources(params?: any): Promise<ResourcesMessage>;
+getAvailableResources(params?: any, useCache?: boolean): Promise<ResourcesMessage>;
 ```
 
 ## Parameters
@@ -43,6 +43,22 @@ any
 _(Optional)_
 
 
+</td></tr>
+<tr><td>
+
+useCache
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
 </td></tr>
 </tbody></table>
 

package/docs/api/foundation-comms.defaulthttpconnect.md

@@ -242,7 +242,7 @@ Description
 </td></tr>
 <tr><td>
 
-[getAvailableResources(params)](./foundation-comms.defaulthttpconnect.getavailableresources.md)
+[getAvailableResources(params, useCache)](./foundation-comms.defaulthttpconnect.getavailableresources.md)
 
 
 </td><td>

package/docs/api/foundation-comms.defaulthttpconnectconfig.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [defaultHttpConnectConfig](./foundation-comms.defaulthttpconnectconfig.md)
+
+## defaultHttpConnectConfig variable
+
+The default configuration for connecting to an HTTP service.
+
+**Signature:**
+
+```typescript
+defaultHttpConnectConfig: HttpConnectConfig
+```

package/docs/api/foundation-comms.defaultmetacache.cachedresources.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultMetaCache](./foundation-comms.defaultmetacache.md) &gt; [cachedResources](./foundation-comms.defaultmetacache.cachedresources.md)
+
+## DefaultMetaCache.cachedResources property
+
+**Signature:**
+
+```typescript
+cachedResources: ResourcesMessage | null;
+```

package/docs/api/foundation-comms.defaultmetacache.getresources.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultMetaCache](./foundation-comms.defaultmetacache.md) &gt; [getResources](./foundation-comms.defaultmetacache.getresources.md)
+
+## DefaultMetaCache.getResources() method
+
+**Signature:**
+
+```typescript
+getResources(): ResourcesMessage;
+```
+**Returns:**
+
+[ResourcesMessage](./foundation-comms.resourcesmessage.md)
+

package/docs/api/foundation-comms.defaultmetacache.hasresources.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultMetaCache](./foundation-comms.defaultmetacache.md) &gt; [hasResources](./foundation-comms.defaultmetacache.hasresources.md)
+
+## DefaultMetaCache.hasResources() method
+
+**Signature:**
+
+```typescript
+hasResources(): boolean;
+```
+**Returns:**
+
+boolean
+

package/docs/api/foundation-comms.defaultmetacache.md

@@ -69,6 +69,23 @@ Map&lt;string, [Metadata](./foundation-comms.metadata.md)<!-- -->&gt;
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[cachedResources](./foundation-comms.defaultmetacache.cachedresources.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ResourcesMessage](./foundation-comms.resourcesmessage.md) \| null
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>
 
@@ -113,6 +130,18 @@ Description
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[getResources()](./foundation-comms.defaultmetacache.getresources.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 
@@ -137,6 +166,18 @@ Description
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[hasResources()](./foundation-comms.defaultmetacache.hasresources.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 
@@ -161,6 +202,18 @@ Description
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[setResources(resources)](./foundation-comms.defaultmetacache.setresources.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>
 

package/docs/api/foundation-comms.defaultmetacache.setresources.md

@@ -0,0 +1,50 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultMetaCache](./foundation-comms.defaultmetacache.md) &gt; [setResources](./foundation-comms.defaultmetacache.setresources.md)
+
+## DefaultMetaCache.setResources() method
+
+**Signature:**
+
+```typescript
+setResources(resources: ResourcesMessage): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+resources
+
+
+</td><td>
+
+[ResourcesMessage](./foundation-comms.resourcesmessage.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.httpconnectconfig.md

@@ -0,0 +1,58 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [HttpConnectConfig](./foundation-comms.httpconnectconfig.md)
+
+## HttpConnectConfig interface
+
+Configuration options for the Connect (HTTP) instance.
+
+**Signature:**
+
+```typescript
+export interface HttpConnectConfig 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[polling](./foundation-comms.httpconnectconfig.polling.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[HttpPollingConfig](./foundation-comms.httppollingconfig.md)
+
+
+</td><td>
+
+Configuration options for http polling.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-comms.httpconnectconfig.polling.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [HttpConnectConfig](./foundation-comms.httpconnectconfig.md) &gt; [polling](./foundation-comms.httpconnectconfig.polling.md)
+
+## HttpConnectConfig.polling property
+
+Configuration options for http polling.
+
+**Signature:**
+
+```typescript
+polling: HttpPollingConfig;
+```

package/docs/api/foundation-comms.httppollingconfig.md

@@ -0,0 +1,96 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [HttpPollingConfig](./foundation-comms.httppollingconfig.md)
+
+## HttpPollingConfig interface
+
+Configuration options for http connection.
+
+**Signature:**
+
+```typescript
+export interface HttpPollingConfig 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[POLLING\_FREQUENCY?](./foundation-comms.httppollingconfig.polling_frequency.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The frequency of polling.
+
+
+</td></tr>
+<tr><td>
+
+[POLLING\_INTERVAL\_MAP?](./foundation-comms.httppollingconfig.polling_interval_map.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ \[resource: string\]: number; }
+
+
+</td><td>
+
+_(Optional)_ The interval map of polling.
+
+
+</td></tr>
+<tr><td>
+
+[POLLING\_MAP?](./foundation-comms.httppollingconfig.polling_map.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ \[key: string\]: [PollingConfiguration](./foundation-comms.pollingconfiguration.md)<!-- -->; }
+
+
+</td><td>
+
+_(Optional)_ The map of polling configuration.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-comms.httppollingconfig.polling_frequency.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [HttpPollingConfig](./foundation-comms.httppollingconfig.md) &gt; [POLLING\_FREQUENCY](./foundation-comms.httppollingconfig.polling_frequency.md)
+
+## HttpPollingConfig.POLLING\_FREQUENCY property
+
+The frequency of polling.
+
+**Signature:**
+
+```typescript
+POLLING_FREQUENCY?: number;
+```

package/docs/api/foundation-comms.httppollingconfig.polling_interval_map.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [HttpPollingConfig](./foundation-comms.httppollingconfig.md) &gt; [POLLING\_INTERVAL\_MAP](./foundation-comms.httppollingconfig.polling_interval_map.md)
+
+## HttpPollingConfig.POLLING\_INTERVAL\_MAP property
+
+The interval map of polling.
+
+**Signature:**
+
+```typescript
+POLLING_INTERVAL_MAP?: {
+        [resource: string]: number;
+    };
+```

package/docs/api/foundation-comms.httppollingconfig.polling_map.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [HttpPollingConfig](./foundation-comms.httppollingconfig.md) &gt; [POLLING\_MAP](./foundation-comms.httppollingconfig.polling_map.md)
+
+## HttpPollingConfig.POLLING\_MAP property
+
+The map of polling configuration.
+
+**Signature:**
+
+```typescript
+POLLING_MAP?: {
+        [key: string]: PollingConfiguration;
+    };
+```