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

package/dist/foundation-comms.api.json

@@ -1593,7 +1593,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-comms!Connect#getAvailableResources:member(1)",
-              "docComment": "/**\n * Sends a request to the server to get available resources.\n *\n * @param params - An object containing optional parameters to include in the request.\n *\n * @returns A promise that resolves to a Message containing the server's response with available resources.\n *\n * @public\n */\n",
+              "docComment": "/**\n * Sends a request to the server to get available resources.\n *\n * @param params - An object containing optional parameters to include in the request.\n *\n * @param useCache - Whether to use the cached resources if available. Default: true.\n *\n * @returns A promise that resolves to a Message containing the server's response with available resources.\n *\n * @public\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -1604,6 +1604,14 @@
                   "text": "RequestParams",
                   "canonicalReference": "@genesislcap/foundation-comms!RequestParams:type"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", useCache?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -1633,8 +1641,8 @@
               ],
               "isOptional": false,
               "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 7
+                "startIndex": 5,
+                "endIndex": 9
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -1646,6 +1654,14 @@
                     "endIndex": 2
                   },
                   "isOptional": true
+                },
+                {
+                  "parameterName": "useCache",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
                 }
               ],
               "name": "getAvailableResources"
@@ -11880,6 +11896,14 @@
                   "text": "RequestParams",
                   "canonicalReference": "@genesislcap/foundation-comms!RequestParams:type"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", useCache?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -11909,8 +11933,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 7
+                "startIndex": 5,
+                "endIndex": 9
               },
               "releaseTag": "Public",
               "isProtected": false,
@@ -11923,6 +11947,14 @@
                     "endIndex": 2
                   },
                   "isOptional": true
+                },
+                {
+                  "parameterName": "useCache",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
                 }
               ],
               "isOptional": false,
@@ -17888,7 +17920,7 @@
                 {
                   "kind": "Reference",
                   "text": "HttpConnectConfig",
-                  "canonicalReference": "@genesislcap/foundation-comms!~HttpConnectConfig:interface"
+                  "canonicalReference": "@genesislcap/foundation-comms!HttpConnectConfig:interface"
                 },
                 {
                   "kind": "Content",
@@ -18187,6 +18219,14 @@
                   "kind": "Content",
                   "text": "any"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", useCache?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -18216,8 +18256,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 3,
-                "endIndex": 7
+                "startIndex": 5,
+                "endIndex": 9
               },
               "releaseTag": "Public",
               "isProtected": false,
@@ -18230,6 +18270,14 @@
                     "endIndex": 2
                   },
                   "isOptional": true
+                },
+                {
+                  "parameterName": "useCache",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
                 }
               ],
               "isOptional": false,
@@ -19365,6 +19413,30 @@
             }
           ]
         },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-comms!defaultHttpConnectConfig:var",
+          "docComment": "/**\n * The default configuration for connecting to an HTTP service.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "defaultHttpConnectConfig: "
+            },
+            {
+              "kind": "Reference",
+              "text": "HttpConnectConfig",
+              "canonicalReference": "@genesislcap/foundation-comms!HttpConnectConfig:interface"
+            }
+          ],
+          "fileUrlPath": "src/connect/http.connect.types.ts",
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "defaultHttpConnectConfig",
+          "variableTypeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "Class",
           "canonicalReference": "@genesislcap/foundation-comms!DefaultKVStorage:class",
@@ -20903,6 +20975,41 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultMetaCache#cachedResources:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "cachedResources: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ResourcesMessage",
+                  "canonicalReference": "@genesislcap/foundation-comms!ResourcesMessage:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | null"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "cachedResources",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-comms!DefaultMetaCache#getJsonSchemaFor:member(1)",
@@ -21001,6 +21108,38 @@
               "isAbstract": false,
               "name": "getMetadataFor"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultMetaCache#getResources:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getResources(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ResourcesMessage",
+                  "canonicalReference": "@genesislcap/foundation-comms!ResourcesMessage:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getResources"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-comms!DefaultMetaCache#hasJsonSchemaFor:member(1)",
@@ -21097,6 +21236,37 @@
               "isAbstract": false,
               "name": "hasMetadataFor"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultMetaCache#hasResources:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "hasResources(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "hasResources"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-comms!DefaultMetaCache#setJsonSchemaFor:member(1)",
@@ -21226,6 +21396,55 @@
               "isOptional": false,
               "isAbstract": false,
               "name": "setMetadataFor"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultMetaCache#setResources:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setResources(resources: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ResourcesMessage",
+                  "canonicalReference": "@genesislcap/foundation-comms!ResourcesMessage:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "resources",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "setResources"
             }
           ],
           "implementsTokenRanges": [
@@ -26550,6 +26769,52 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@genesislcap/foundation-comms!HttpConnectConfig:interface",
+          "docComment": "/**\n * Configuration options for the Connect (HTTP) instance.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface HttpConnectConfig "
+            }
+          ],
+          "fileUrlPath": "src/connect/http.connect.types.ts",
+          "releaseTag": "Public",
+          "name": "HttpConnectConfig",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-comms!HttpConnectConfig#polling:member",
+              "docComment": "/**\n * Configuration options for http polling.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "polling: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HttpPollingConfig",
+                  "canonicalReference": "@genesislcap/foundation-comms!HttpPollingConfig:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "polling",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-comms!HttpError:interface",
@@ -26638,15 +26903,123 @@
         },
         {
           "kind": "Interface",
-          "canonicalReference": "@genesislcap/foundation-comms!HttpRequestInit:interface",
-          "docComment": "/**\n * The options object used when making an HTTP request.\n *\n * @public\n */\n",
+          "canonicalReference": "@genesislcap/foundation-comms!HttpPollingConfig:interface",
+          "docComment": "/**\n * Configuration options for http connection.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export interface HttpRequestInit extends "
-            },
+              "text": "export interface HttpPollingConfig "
+            }
+          ],
+          "fileUrlPath": "src/connect/http.connect.types.ts",
+          "releaseTag": "Public",
+          "name": "HttpPollingConfig",
+          "preserveMemberOrder": false,
+          "members": [
             {
-              "kind": "Reference",
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-comms!HttpPollingConfig#POLLING_FREQUENCY:member",
+              "docComment": "/**\n * The frequency of polling.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "POLLING_FREQUENCY?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "POLLING_FREQUENCY",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-comms!HttpPollingConfig#POLLING_INTERVAL_MAP:member",
+              "docComment": "/**\n * The interval map of polling.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "POLLING_INTERVAL_MAP?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        [resource: string]: number;\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "POLLING_INTERVAL_MAP",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-comms!HttpPollingConfig#POLLING_MAP:member",
+              "docComment": "/**\n * The map of polling configuration.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "POLLING_MAP?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        [key: string]: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PollingConfiguration",
+                  "canonicalReference": "@genesislcap/foundation-comms!PollingConfiguration:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";\n    }"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "POLLING_MAP",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 4
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@genesislcap/foundation-comms!HttpRequestInit:interface",
+          "docComment": "/**\n * The options object used when making an HTTP request.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface HttpRequestInit extends "
+            },
+            {
+              "kind": "Reference",
               "text": "RequestInit",
               "canonicalReference": "!RequestInit:interface"
             },
@@ -30339,7 +30712,7 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-comms!MetaCache:type",
-          "docComment": "/**\n * Union type of MetadataCache and JsonSchemaCache\n *\n * @public\n */\n",
+          "docComment": "/**\n * Union type of MetadataCache, JsonSchemaCache and ResourcesCache\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -30359,6 +30732,15 @@
               "text": "JsonSchemaCache",
               "canonicalReference": "@genesislcap/foundation-comms!JsonSchemaCache:interface"
             },
+            {
+              "kind": "Content",
+              "text": " & "
+            },
+            {
+              "kind": "Reference",
+              "text": "ResourcesCache",
+              "canonicalReference": "@genesislcap/foundation-comms!ResourcesCache:interface"
+            },
             {
               "kind": "Content",
               "text": ";"
@@ -30369,7 +30751,7 @@
           "name": "MetaCache",
           "typeTokenRange": {
             "startIndex": 1,
-            "endIndex": 4
+            "endIndex": 6
           }
         },
         {
@@ -31910,6 +32292,105 @@
             "endIndex": 5
           }
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@genesislcap/foundation-comms!PollingConfiguration:interface",
+          "docComment": "/**\n * Configuration options for http polling.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface PollingConfiguration "
+            }
+          ],
+          "fileUrlPath": "src/connect/http.connect.types.ts",
+          "releaseTag": "Public",
+          "name": "PollingConfiguration",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-comms!PollingConfiguration#AMOUNT_OF_POLLS:member",
+              "docComment": "/**\n * The expected amount of HTTP polling attempts to be performed.\n *\n * @remarks\n *\n * TEMP_FREQUENCY * AMOUNT_OF_POLLS = the total polling time/duration\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "AMOUNT_OF_POLLS: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "AMOUNT_OF_POLLS",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-comms!PollingConfiguration#QUERIES:member",
+              "docComment": "/**\n * The queries to be polled.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "QUERIES: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "QUERIES",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-comms!PollingConfiguration#TEMP_FREQUENCY:member",
+              "docComment": "/**\n * The temporary polling frequency.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "TEMP_FREQUENCY: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "TEMP_FREQUENCY",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-comms!PongMessage:type",
@@ -32261,6 +32742,159 @@
             "endIndex": 2
           }
         },
+        {
+          "kind": "Interface",
+          "canonicalReference": "@genesislcap/foundation-comms!ResourcesCache:interface",
+          "docComment": "/**\n * A resources cache definition\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export interface ResourcesCache "
+            }
+          ],
+          "fileUrlPath": "src/metadata/metadata.ts",
+          "releaseTag": "Public",
+          "name": "ResourcesCache",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-comms!ResourcesCache#cachedResources:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "cachedResources: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ResourcesMessage",
+                  "canonicalReference": "@genesislcap/foundation-comms!ResourcesMessage:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | null"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "cachedResources",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-comms!ResourcesCache#getResources:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getResources(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ResourcesMessage",
+                  "canonicalReference": "@genesislcap/foundation-comms!ResourcesMessage:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [],
+              "name": "getResources"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-comms!ResourcesCache#hasResources:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "hasResources(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [],
+              "name": "hasResources"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-comms!ResourcesCache#setResources:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setResources(resources: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "ResourcesMessage",
+                  "canonicalReference": "@genesislcap/foundation-comms!ResourcesMessage:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "resources",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "setResources"
+            }
+          ],
+          "extendsTokenRanges": []
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-comms!ResourcesMessage:type",