dump-tools

Author: tripolskypetr

src/functions/dump/getAgent.ts

@@ -0,0 +1,21 @@
+import { AgentName } from "../../interfaces/Agent.interface";
+import swarm from "../../lib";
+import { GLOBAL_CONFIG } from "../../config/params";
+
+const METHOD_NAME = "function.dump.getAgent";
+
+/**
+ * Retrieves an agent schema by its name from the swarm's agent schema service.
+ * Logs the operation if logging is enabled in the global configuration.
+ *
+ * @function getAgent
+ * @param {AgentName} agentName - The name of the agent to retrieve.
+ * @returns The agent schema associated with the provided agent name.
+ */
+export function getAgent(agentName: AgentName) {
+  GLOBAL_CONFIG.CC_LOGGER_ENABLE_LOG &&
+    swarm.loggerService.log(METHOD_NAME, {
+      agentName,
+    });
+  return swarm.agentSchemaService.get(agentName);
+}

src/functions/dump/getCompletion.ts

@@ -0,0 +1,21 @@
+import swarm from "../../lib";
+import { GLOBAL_CONFIG } from "../../config/params";
+import { CompletionName } from "../../interfaces/Completion.interface";
+
+const METHOD_NAME = "function.dump.getCompletion";
+
+/**
+ * Retrieves a completion schema by its name from the swarm's completion schema service.
+ * Logs the operation if logging is enabled in the global configuration.
+ *
+ * @function getCompletion
+ * @param {CompletionName} completionName - The name of the completion to retrieve.
+ * @returns The completion schema associated with the provided completion name.
+ */
+export function getCompletion(completionName: CompletionName) {
+  GLOBAL_CONFIG.CC_LOGGER_ENABLE_LOG &&
+    swarm.loggerService.log(METHOD_NAME, {
+      completionName,
+    });
+  return swarm.completionSchemaService.get(completionName);
+}

src/functions/dump/getCompute.ts

@@ -0,0 +1,21 @@
+import swarm from "../../lib";
+import { GLOBAL_CONFIG } from "../../config/params";
+import { ComputeName } from "../../interfaces/Compute.interface";
+
+const METHOD_NAME = "function.dump.getCompute";
+
+/**
+ * Retrieves a compute schema by its name from the swarm's compute schema service.
+ * Logs the operation if logging is enabled in the global configuration.
+ *
+ * @function getCompute
+ * @param {ComputeName} computeName - The name of the compute to retrieve.
+ * @returns The compute schema associated with the provided compute name.
+ */
+export function getCompute(computeName: ComputeName) {
+  GLOBAL_CONFIG.CC_LOGGER_ENABLE_LOG &&
+    swarm.loggerService.log(METHOD_NAME, {
+      computeName,
+    });
+  return swarm.computeSchemaService.get(computeName);
+}

src/functions/dump/getEmbeding.ts

@@ -0,0 +1,21 @@
+import swarm from "../../lib";
+import { GLOBAL_CONFIG } from "../../config/params";
+import { EmbeddingName } from "../../interfaces/Embedding.interface";
+
+const METHOD_NAME = "function.dump.getEmbeding";
+
+/**
+ * Retrieves an embedding schema by its name from the swarm's embedding schema service.
+ * Logs the operation if logging is enabled in the global configuration.
+ *
+ * @function getEmbedding
+ * @param {EmbeddingName} embeddingName - The name of the embedding to retrieve.
+ * @returns The embedding schema associated with the provided embedding name.
+ */
+export function getEmbeding(embeddingName: EmbeddingName) {
+  GLOBAL_CONFIG.CC_LOGGER_ENABLE_LOG &&
+    swarm.loggerService.log(METHOD_NAME, {
+      embeddingName,
+    });
+  return swarm.embeddingSchemaService.get(embeddingName);
+}

src/functions/dump/getMCP.ts

@@ -0,0 +1,21 @@
+import swarm from "../../lib";
+import { GLOBAL_CONFIG } from "../../config/params";
+import { MCPName } from "../../interfaces/MCP.interface";
+
+const METHOD_NAME = "function.dump.getMCP";
+
+/**
+ * Retrieves an MCP (Model Context Protocol) schema by its name from the swarm's MCP schema service.
+ * Logs the operation if logging is enabled in the global configuration.
+ *
+ * @function getMCP
+ * @param {MCPName} mcpName - The name of the MCP to retrieve.
+ * @returns The MCP schema associated with the provided MCP name.
+ */
+export function getMCP(mcpName: MCPName) {
+  GLOBAL_CONFIG.CC_LOGGER_ENABLE_LOG &&
+    swarm.loggerService.log(METHOD_NAME, {
+      mcpName,
+    });
+  return swarm.mcpSchemaService.get(mcpName);
+}

src/functions/dump/getPipeline.ts

@@ -0,0 +1,21 @@
+import swarm from "../../lib";
+import { GLOBAL_CONFIG } from "../../config/params";
+import { PipelineName } from "../../model/Pipeline.model";
+
+const METHOD_NAME = "function.dump.getPipeline";
+
+/**
+ * Retrieves a pipeline schema by its name from the swarm's pipeline schema service.
+ * Logs the operation if logging is enabled in the global configuration.
+ *
+ * @function getPipeline
+ * @param {PipelineName} pipelineName - The name of the pipeline to retrieve.
+ * @returns The pipeline schema associated with the provided pipeline name.
+ */
+export function getPipeline(pipelineName: PipelineName) {
+  GLOBAL_CONFIG.CC_LOGGER_ENABLE_LOG &&
+    swarm.loggerService.log(METHOD_NAME, {
+      pipelineName,
+    });
+  return swarm.pipelineSchemaService.get(pipelineName);
+}

src/functions/dump/getPolicy.ts

@@ -0,0 +1,21 @@
+import swarm from "../../lib";
+import { GLOBAL_CONFIG } from "../../config/params";
+import { PolicyName } from "../../interfaces/Policy.interface";
+
+const METHOD_NAME = "function.dump.getPolicy";
+
+/**
+ * Retrieves a policy schema by its name from the swarm's policy schema service.
+ * Logs the operation if logging is enabled in the global configuration.
+ *
+ * @function getPolicy
+ * @param {PolicyName} policyName - The name of the policy to retrieve.
+ * @returns The policy schema associated with the provided policy name.
+ */
+export function getPolicy(policyName: PolicyName) {
+  GLOBAL_CONFIG.CC_LOGGER_ENABLE_LOG &&
+    swarm.loggerService.log(METHOD_NAME, {
+      policyName,
+    });
+  return swarm.policySchemaService.get(policyName);
+}

src/functions/dump/getState.ts

@@ -0,0 +1,21 @@
+import swarm from "../../lib";
+import { GLOBAL_CONFIG } from "../../config/params";
+import { StateName } from "../../interfaces/State.interface";
+
+const METHOD_NAME = "function.dump.getState";
+
+/**
+ * Retrieves a state schema by its name from the swarm's state schema service.
+ * Logs the operation if logging is enabled in the global configuration.
+ *
+ * @function getState
+ * @param {StateName} stateName - The name of the state to retrieve.
+ * @returns The state schema associated with the provided state name.
+ */
+export function getState(stateName: StateName) {
+  GLOBAL_CONFIG.CC_LOGGER_ENABLE_LOG &&
+    swarm.loggerService.log(METHOD_NAME, {
+      stateName,
+    });
+  return swarm.stateSchemaService.get(stateName);
+}

src/functions/dump/getStorage.ts

@@ -0,0 +1,21 @@
+import swarm from "../../lib";
+import { GLOBAL_CONFIG } from "../../config/params";
+import { StorageName } from "../../interfaces/Storage.interface";
+
+const METHOD_NAME = "function.dump.getStorage";
+
+/**
+ * Retrieves a storage schema by its name from the swarm's storage schema service.
+ * Logs the operation if logging is enabled in the global configuration.
+ *
+ * @function getStorage
+ * @param {StorageName} storageName - The name of the storage to retrieve.
+ * @returns The storage schema associated with the provided storage name.
+ */
+export function getStorage(storageName: StorageName) {
+  GLOBAL_CONFIG.CC_LOGGER_ENABLE_LOG &&
+    swarm.loggerService.log(METHOD_NAME, {
+      storageName,
+    });
+  return swarm.storageSchemaService.get(storageName);
+}

src/functions/dump/getSwarm.ts

@@ -0,0 +1,21 @@
+import swarm from "../../lib";
+import { GLOBAL_CONFIG } from "../../config/params";
+import { SwarmName } from "../../interfaces/Swarm.interface";
+
+const METHOD_NAME = "function.dump.getSwarm";
+
+/**
+ * Retrieves a swarm schema by its name from the swarm's swarm schema service.
+ * Logs the operation if logging is enabled in the global configuration.
+ *
+ * @function getSwarm
+ * @param {SwarmName} swarmName - The name of the swarm to retrieve.
+ * @returns The swarm schema associated with the provided swarm name.
+ */
+export function getSwarm(swarmName: SwarmName) {
+  GLOBAL_CONFIG.CC_LOGGER_ENABLE_LOG &&
+    swarm.loggerService.log(METHOD_NAME, {
+      swarmName,
+    });
+  return swarm.swarmSchemaService.get(swarmName);
+}