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

package/docs/api/foundation-comms.md

@@ -896,6 +896,17 @@ GenesisResourcesConfig DI interface.
 An interface representing an HTTP client that can make GET and POST requests and return a promise with the response data.
 
 
+</td></tr>
+<tr><td>
+
+[HttpConnectConfig](./foundation-comms.httpconnectconfig.md)
+
+
+</td><td>
+
+Configuration options for the Connect (HTTP) instance.
+
+
 </td></tr>
 <tr><td>
 
@@ -907,6 +918,17 @@ An interface representing an HTTP client that can make GET and POST requests and
 An error thrown when an HTTP request fails with a non-2xx status code.
 
 
+</td></tr>
+<tr><td>
+
+[HttpPollingConfig](./foundation-comms.httppollingconfig.md)
+
+
+</td><td>
+
+Configuration options for http connection.
+
+
 </td></tr>
 <tr><td>
 
@@ -1050,6 +1072,28 @@ MonitoredResourceMetadata.
 NetworkMonitorConfig DI interface.
 
 
+</td></tr>
+<tr><td>
+
+[PollingConfiguration](./foundation-comms.pollingconfiguration.md)
+
+
+</td><td>
+
+Configuration options for http polling.
+
+
+</td></tr>
+<tr><td>
+
+[ResourcesCache](./foundation-comms.resourcescache.md)
+
+
+</td><td>
+
+A resources cache definition
+
+
 </td></tr>
 <tr><td>
 
@@ -1275,6 +1319,17 @@ Default DatasourceConfig DI implementation.
 Default GenesisResourcesConfig implementation.
 
 
+</td></tr>
+<tr><td>
+
+[defaultHttpConnectConfig](./foundation-comms.defaulthttpconnectconfig.md)
+
+
+</td><td>
+
+The default configuration for connecting to an HTTP service.
+
+
 </td></tr>
 <tr><td>
 
@@ -1747,7 +1802,7 @@ Error definition for a message result
 
 </td><td>
 
-Union type of MetadataCache and JsonSchemaCache
+Union type of MetadataCache, JsonSchemaCache and ResourcesCache
 
 
 </td></tr>

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

@@ -4,12 +4,12 @@
 
 ## MetaCache type
 
-Union type of MetadataCache and JsonSchemaCache
+Union type of MetadataCache, JsonSchemaCache and ResourcesCache
 
 **Signature:**
 
 ```typescript
-export type MetaCache = MetadataCache & JsonSchemaCache;
+export type MetaCache = MetadataCache & JsonSchemaCache & ResourcesCache;
 ```
-**References:** [MetadataCache](./foundation-comms.metadatacache.md)<!-- -->, [JsonSchemaCache](./foundation-comms.jsonschemacache.md)
+**References:** [MetadataCache](./foundation-comms.metadatacache.md)<!-- -->, [JsonSchemaCache](./foundation-comms.jsonschemacache.md)<!-- -->, [ResourcesCache](./foundation-comms.resourcescache.md)
 

package/docs/api/foundation-comms.pollingconfiguration.amount_of_polls.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [PollingConfiguration](./foundation-comms.pollingconfiguration.md) &gt; [AMOUNT\_OF\_POLLS](./foundation-comms.pollingconfiguration.amount_of_polls.md)
+
+## PollingConfiguration.AMOUNT\_OF\_POLLS property
+
+The expected amount of HTTP polling attempts to be performed.
+
+**Signature:**
+
+```typescript
+AMOUNT_OF_POLLS: number;
+```
+
+## Remarks
+
+TEMP\_FREQUENCY \* AMOUNT\_OF\_POLLS = the total polling time/duration
+

package/docs/api/foundation-comms.pollingconfiguration.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; [PollingConfiguration](./foundation-comms.pollingconfiguration.md)
+
+## PollingConfiguration interface
+
+Configuration options for http polling.
+
+**Signature:**
+
+```typescript
+export interface PollingConfiguration 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[AMOUNT\_OF\_POLLS](./foundation-comms.pollingconfiguration.amount_of_polls.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The expected amount of HTTP polling attempts to be performed.
+
+
+</td></tr>
+<tr><td>
+
+[QUERIES](./foundation-comms.pollingconfiguration.queries.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+The queries to be polled.
+
+
+</td></tr>
+<tr><td>
+
+[TEMP\_FREQUENCY](./foundation-comms.pollingconfiguration.temp_frequency.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The temporary polling frequency.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-comms.pollingconfiguration.queries.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; [PollingConfiguration](./foundation-comms.pollingconfiguration.md) &gt; [QUERIES](./foundation-comms.pollingconfiguration.queries.md)
+
+## PollingConfiguration.QUERIES property
+
+The queries to be polled.
+
+**Signature:**
+
+```typescript
+QUERIES: string[];
+```

package/docs/api/foundation-comms.pollingconfiguration.temp_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; [PollingConfiguration](./foundation-comms.pollingconfiguration.md) &gt; [TEMP\_FREQUENCY](./foundation-comms.pollingconfiguration.temp_frequency.md)
+
+## PollingConfiguration.TEMP\_FREQUENCY property
+
+The temporary polling frequency.
+
+**Signature:**
+
+```typescript
+TEMP_FREQUENCY: number;
+```

package/docs/api/foundation-comms.resourcescache.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; [ResourcesCache](./foundation-comms.resourcescache.md) &gt; [cachedResources](./foundation-comms.resourcescache.cachedresources.md)
+
+## ResourcesCache.cachedResources property
+
+**Signature:**
+
+```typescript
+cachedResources: ResourcesMessage | null;
+```

package/docs/api/foundation-comms.resourcescache.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; [ResourcesCache](./foundation-comms.resourcescache.md) &gt; [getResources](./foundation-comms.resourcescache.getresources.md)
+
+## ResourcesCache.getResources() method
+
+**Signature:**
+
+```typescript
+getResources(): ResourcesMessage;
+```
+**Returns:**
+
+[ResourcesMessage](./foundation-comms.resourcesmessage.md)
+

package/docs/api/foundation-comms.resourcescache.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; [ResourcesCache](./foundation-comms.resourcescache.md) &gt; [hasResources](./foundation-comms.resourcescache.hasresources.md)
+
+## ResourcesCache.hasResources() method
+
+**Signature:**
+
+```typescript
+hasResources(): boolean;
+```
+**Returns:**
+
+boolean
+

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

@@ -0,0 +1,98 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [ResourcesCache](./foundation-comms.resourcescache.md)
+
+## ResourcesCache interface
+
+A resources cache definition
+
+**Signature:**
+
+```typescript
+export interface ResourcesCache 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[cachedResources](./foundation-comms.resourcescache.cachedresources.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ResourcesMessage](./foundation-comms.resourcesmessage.md) \| null
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getResources()](./foundation-comms.resourcescache.getresources.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[hasResources()](./foundation-comms.resourcescache.hasresources.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[setResources(resources)](./foundation-comms.resourcescache.setresources.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-comms.resourcescache.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; [ResourcesCache](./foundation-comms.resourcescache.md) &gt; [setResources](./foundation-comms.resourcescache.setresources.md)
+
+## ResourcesCache.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-report.md.api.md

@@ -182,7 +182,7 @@ export interface Connect {
     connect(host?: string): Promise<boolean>;
     dataLogoff(sourceRef: string): Promise<Message>;
     disconnect(): void;
-    getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
+    getAvailableResources(params?: RequestParams, useCache?: boolean): Promise<ResourcesMessage>;
     getJSONSchema(resourceName: string): Promise<SchemaResponse>;
     getMetadata(resourceName: string, useCache?: boolean): Promise<Metadata>;
     getMoreColumns(sourceRef: string): Promise<Message>;
@@ -312,7 +312,7 @@ export class ConnectMock implements Connect {
     // (undocumented)
     disconnect(): void;
     // (undocumented)
-    getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
+    getAvailableResources(params?: RequestParams, useCache?: boolean): Promise<ResourcesMessage>;
     // (undocumented)
     getJSONSchema(resourceName: string): Promise<any>;
     // (undocumented)
@@ -1079,7 +1079,7 @@ export class DefaultConnect implements Connect {
     // (undocumented)
     disconnect(): void;
     // (undocumented)
-    getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
+    getAvailableResources(params?: RequestParams, useCache?: boolean): Promise<ResourcesMessage>;
     // (undocumented)
     getJSONSchema(resourceName: string, useCache?: boolean): Promise<SchemaResponse>;
     // (undocumented)
@@ -1420,7 +1420,6 @@ export class DefaultHttp implements Http {
 
 // @public
 export class DefaultHttpConnect implements Connect {
-    // Warning: (ae-forgotten-export) The symbol "HttpConnectConfig" needs to be exported by the entry point index.d.ts
     constructor(http: Http, messageBuilder: MessageBuilder, session: Session, metaCache: MetaCache, serializer: JSONSerializer, config: HttpConnectConfig);
     // (undocumented)
     commitEvent(eventName: string, params?: CommitParams): Promise<Message>;
@@ -1431,7 +1430,7 @@ export class DefaultHttpConnect implements Connect {
     // (undocumented)
     disconnect(): void;
     // (undocumented)
-    getAvailableResources(params?: any): Promise<ResourcesMessage>;
+    getAvailableResources(params?: any, useCache?: boolean): Promise<ResourcesMessage>;
     // (undocumented)
     getJSONSchema(resourceName: string): Promise<SchemaResponse>;
     // (undocumented)
@@ -1471,6 +1470,9 @@ export class DefaultHttpConnect implements Connect {
     streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: any): SocketObservable<Message<any>>;
 }
 
+// @public
+export const defaultHttpConnectConfig: HttpConnectConfig;
+
 // @alpha
 export class DefaultKVStorage implements KVStorage {
     constructor(connect: Connect, user: User_2, kvStorageConfig?: KVStorageConfig);
@@ -1533,17 +1535,25 @@ export class DefaultMetaCache implements MetaCache {
     // (undocumented)
     cachedMetadata: Map<string, Metadata>;
     // (undocumented)
+    cachedResources: ResourcesMessage | null;
+    // (undocumented)
     getJsonSchemaFor(resourceName: string): SchemaResponse;
     // (undocumented)
     getMetadataFor(resourceName: string): Metadata;
     // (undocumented)
+    getResources(): ResourcesMessage;
+    // (undocumented)
     hasJsonSchemaFor(resourceName: string): boolean;
     // (undocumented)
     hasMetadataFor(resourceName: string): boolean;
     // (undocumented)
+    hasResources(): boolean;
+    // (undocumented)
     setJsonSchemaFor(resourceName: string, schemaResponse: SchemaResponse): void;
     // (undocumented)
     setMetadataFor(resourceName: string, metadata: Metadata): void;
+    // (undocumented)
+    setResources(resources: ResourcesMessage): void;
 }
 
 // @public
@@ -1991,6 +2001,16 @@ export const Http: InterfaceSymbol<Http>;
 // @internal
 export const HttpConnect: InterfaceSymbol<Connect>;
 
+// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "HttpConnectConfig" because one of its declarations is marked as @internal
+//
+// @public
+export interface HttpConnectConfig {
+    polling: HttpPollingConfig;
+}
+
+// @internal
+export const HttpConnectConfig: InterfaceSymbol<HttpConnectConfig>;
+
 // @public
 export interface HttpError extends Error {
     // (undocumented)
@@ -1999,6 +2019,17 @@ export interface HttpError extends Error {
     status: number;
 }
 
+// @public
+export interface HttpPollingConfig {
+    POLLING_FREQUENCY?: number;
+    POLLING_INTERVAL_MAP?: {
+        [resource: string]: number;
+    };
+    POLLING_MAP?: {
+        [key: string]: PollingConfiguration;
+    };
+}
+
 // @public
 export interface HttpRequestInit extends RequestInit {
     serializer?: JSONSerializer;
@@ -2308,7 +2339,7 @@ export enum MessageType {
 // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "MetaCache" because one of its declarations is marked as @internal
 //
 // @public
-export type MetaCache = MetadataCache & JsonSchemaCache;
+export type MetaCache = MetadataCache & JsonSchemaCache & ResourcesCache;
 
 // @internal
 export const MetaCache: InterfaceSymbol<MetaCache>;
@@ -2443,6 +2474,13 @@ export type PingMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS
     [key: string]: any;
 };
 
+// @public
+export interface PollingConfiguration {
+    AMOUNT_OF_POLLS: number;
+    QUERIES: string[];
+    TEMP_FREQUENCY: number;
+}
+
 // @public (undocumented)
 export type PongMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'USER_NAME'> & {
     IS_AUTHENTICATED?: boolean;
@@ -2528,6 +2566,18 @@ export type ResourceItem = {
     RESOURCE_TYPE: string;
 };
 
+// @public
+export interface ResourcesCache {
+    // (undocumented)
+    cachedResources: ResourcesMessage | null;
+    // (undocumented)
+    getResources(): ResourcesMessage;
+    // (undocumented)
+    hasResources(): boolean;
+    // (undocumented)
+    setResources(resources: ResourcesMessage): void;
+}
+
 // @public (undocumented)
 export type ResourcesMessage = {
     MESSAGE_TYPE: EventMessageType.RESOURCES_REQUEST_ACK | EventMessageType.RESOURCES_REQUEST_NACK | MessageType.MSG_NACK;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-comms",
   "description": "Genesis Foundation UI Comms",
-  "version": "14.379.0",
+  "version": "14.380.1-TAMTECH-262.2",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -75,24 +75,24 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.379.0",
-    "@genesislcap/genx": "14.379.0",
-    "@genesislcap/rollup-builder": "14.379.0",
-    "@genesislcap/ts-builder": "14.379.0",
-    "@genesislcap/uvu-playwright-builder": "14.379.0",
-    "@genesislcap/vite-builder": "14.379.0",
-    "@genesislcap/webpack-builder": "14.379.0",
+    "@genesislcap/foundation-testing": "14.380.1-TAMTECH-262.2",
+    "@genesislcap/genx": "14.380.1-TAMTECH-262.2",
+    "@genesislcap/rollup-builder": "14.380.1-TAMTECH-262.2",
+    "@genesislcap/ts-builder": "14.380.1-TAMTECH-262.2",
+    "@genesislcap/uvu-playwright-builder": "14.380.1-TAMTECH-262.2",
+    "@genesislcap/vite-builder": "14.380.1-TAMTECH-262.2",
+    "@genesislcap/webpack-builder": "14.380.1-TAMTECH-262.2",
     "@types/js-cookie": "^3.0.2",
     "@types/json-schema": "^7.0.11",
     "@types/webappsec-credential-management": "^0.6.2",
     "sinon": "^17.0.1"
   },
   "dependencies": {
-    "@genesislcap/foundation-broadcast-channel": "14.379.0",
-    "@genesislcap/foundation-logger": "14.379.0",
-    "@genesislcap/foundation-user": "14.379.0",
-    "@genesislcap/foundation-utils": "14.379.0",
-    "@genesislcap/web-core": "14.379.0",
+    "@genesislcap/foundation-broadcast-channel": "14.380.1-TAMTECH-262.2",
+    "@genesislcap/foundation-logger": "14.380.1-TAMTECH-262.2",
+    "@genesislcap/foundation-user": "14.380.1-TAMTECH-262.2",
+    "@genesislcap/foundation-utils": "14.380.1-TAMTECH-262.2",
+    "@genesislcap/web-core": "14.380.1-TAMTECH-262.2",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.49.6",
     "analytics": "0.8.16",
@@ -111,5 +111,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "867ea5e99e79ce360603b05eb9a47ecd1e092640"
+  "gitHead": "e7f7521f3249ec06552fe8e87253b3d63de1c10a"
 }