mftsccs-node 0.0.56 → 0.0.58

package/dist/types/DataStructures/BaseUrl.d.ts

@@ -0,0 +1,262 @@
+/**
+ * @fileoverview BaseUrl module for managing API endpoints and service URLs in CCS-JS.
+ * This module provides centralized configuration for all backend API endpoints,
+ * MQTT connections, and external services.
+ * @module DataStructures/BaseUrl
+ */
+/**
+ * Centralized configuration for all backend API endpoints and service URLs.
+ * Provides methods to generate fully qualified URLs for various API operations.
+ *
+ * @class BaseUrl
+ * @example
+ * ```typescript
+ * // Get concept API URL
+ * const url = BaseUrl.GetConceptUrl();
+ * fetch(url, { ... });
+ *
+ * // Change base URL for different environment
+ * BaseUrl.BASE_URL = "https://api.production.com/";
+ * ```
+ *
+ * @remarks
+ * All URL methods return fully qualified URLs by combining BASE_URL with the endpoint path.
+ * Static properties can be modified to point to different environments or services.
+ */
+export declare class BaseUrl {
+    /** Base URL for the main CCS backend API server */
+    static BASE_URL: string;
+    /** URL for AI service endpoints */
+    static AI_URL: string;
+    /** MQTT broker URL for real-time messaging */
+    static MQTT_URL: string;
+    /** Node.js service URL for additional backend operations */
+    static NODE_URL: string;
+    /** Active MQTT connection instance */
+    static MQTT_CONNECTION: any;
+    /**
+     * Returns the URL for retrieving a single concept by ID.
+     * @returns {string} The concept retrieval API endpoint
+     */
+    static GetConceptUrl(): string;
+    /**
+     * Returns the URL for retrieving a single connection by ID.
+     * @returns {string} The connection retrieval API endpoint
+     */
+    static GetConnectionUrl(): string;
+    /**
+     * Returns the URL for retrieving multiple concepts in bulk.
+     * @returns {string} The bulk concept retrieval API endpoint
+     */
+    static GetConceptBulkUrl(): string;
+    /**
+     * Returns the URL for retrieving multiple connections in bulk.
+     * @returns {string} The bulk connection retrieval API endpoint
+     */
+    static GetConnectionBulkUrl(): string;
+    /**
+     * Returns the URL for retrieving all concepts belonging to a user.
+     * @returns {string} The user concepts retrieval API endpoint
+     */
+    static GetAllConceptsOfUserUrl(): string;
+    /**
+     * Returns the URL for retrieving all connections belonging to a user.
+     * @returns {string} The user connections retrieval API endpoint
+     */
+    static GetAllConnectionsOfUserUrl(): string;
+    /**
+     * Returns the URL for retrieving all connections of a composition.
+     * @returns {string} The composition connections retrieval API endpoint
+     */
+    static GetAllConnectionsOfCompositionUrl(): string;
+    /**
+     * Returns the URL for retrieving composition connections in bulk.
+     * @returns {string} The bulk composition connections retrieval API endpoint
+     */
+    static GetAllConnectionsOfCompositionBulkUrl(): string;
+    /**
+     * Returns the URL for retrieving a concept by its character value.
+     * @returns {string} The character value search API endpoint
+     */
+    static GetConceptByCharacterValueUrl(): string;
+    /**
+     * Returns the URL for retrieving a concept by both character value and type.
+     * @returns {string} The character and type search API endpoint
+     */
+    static GetConceptByCharacterAndTypeUrl(): string;
+    /**
+     * Returns the URL for retrieving a concept by character value and category.
+     * @returns {string} The character and category search API endpoint
+     */
+    static GetConceptByCharacterAndCategoryUrl(): string;
+    /**
+     * Returns the URL for direct retrieval by character and category.
+     * @returns {string} The direct character and category search API endpoint
+     */
+    static GetConceptByCharacterAndCategoryDirectUrl(): string;
+    /**
+     * Returns the URL for retrieving character information by character value.
+     * @returns {string} The character search API endpoint
+     */
+    static GetCharacterByCharacterUrl(): string;
+    /**
+     * Returns the URL for retrieving all concepts of a specific type.
+     * @returns {string} The type-based concept search API endpoint
+     */
+    static GetAllConceptsByTypeUrl(): string;
+    /**
+     * Returns the URL for retrieving all outgoing connections from a concept.
+     * @returns {string} The concept outgoing connections API endpoint
+     */
+    static GetAllConnectionsOfConceptUrl(): string;
+    /**
+     * Returns the URL for retrieving all incoming connections to a concept.
+     * @returns {string} The concept incoming connections API endpoint
+     */
+    static GetAllConnectionsToConceptUrl(): string;
+    /**
+     * Returns the URL for retrieving AI-preloaded concept data.
+     * @returns {string} The AI preloaded concepts API endpoint
+     */
+    static GetAllAiData(): string;
+    /**
+     * Returns the URL for prefetching user connections with pagination.
+     * @returns {string} The prefetch connections API endpoint with inpage parameter
+     */
+    static GetAllPrefetchConnectionsUrl(): string;
+    /**
+     * Returns the URL for retrieving all linker connections from a concept.
+     * @returns {string} The concept linkers API endpoint
+     */
+    static GetAllLinkerConnectionOfConceptUrl(): string;
+    /**
+     * Returns the URL for retrieving all linker connections to a concept.
+     * @returns {string} The reverse concept linkers API endpoint
+     */
+    static GetAllLinkerConnectionToConceptUrl(): string;
+    /**
+     * Returns the URL for deleting a concept.
+     * @returns {string} The concept deletion API endpoint
+     */
+    static DeleteConceptUrl(): string;
+    /**
+     * Returns the URL for recursive search of concepts and connections.
+     * @returns {string} The recursive search API endpoint
+     */
+    static RecursiveSearchUrl(): string;
+    /**
+     * Returns the URL for searching multiple links in CCS format.
+     * @returns {string} The multiple link search API endpoint
+     */
+    static SearchLinkMultipleAllApiUrl(): string;
+    /**
+     * Returns the URL for creating names in the backend.
+     * @returns {string} The name creation API endpoint
+     */
+    static MakeTheNameInBackendUrl(): string;
+    /**
+     * Returns the URL for user login authentication.
+     * @returns {string} The login API endpoint
+     */
+    static LoginUrl(): string;
+    /**
+     * Returns the URL for user signup/registration.
+     * @returns {string} The signup API endpoint
+     */
+    static SignupUrl(): string;
+    /**
+     * Returns the URL for getting composition connections between two concepts.
+     * @returns {string} The composition connection API endpoint
+     */
+    static GetCompositionConnectionBetweenTwoConceptsUrl(): string;
+    /**
+     * Returns the URL for searching compositions.
+     * @returns {string} The composition search API endpoint
+     */
+    static SearchCompositionsUrl(): string;
+    /**
+     * Returns the URL for searching multiple links.
+     * @returns {string} The multiple link search API endpoint
+     */
+    static SearchLinkMultipleAll(): string;
+    /**
+     * Returns the URL for creating remote session IDs.
+     * @returns {string} The session ID creation API endpoint
+     */
+    static CreateSessionId(): string;
+    /**
+     * Returns the URL for recording remote session visits.
+     * @returns {string} The session visit recording API endpoint
+     */
+    static CreateSessionVisitUrl(): string;
+    /**
+     * Returns the URL for viewing internal CCS data in bulk.
+     * @returns {string} The internal data viewing API endpoint
+     */
+    static ViewInternalDataUrl(): string;
+    /**
+     * Returns the URL for searching internal authenticated CCS compositions.
+     * @returns {string} The authenticated internal search API endpoint
+     */
+    static SearchInternalWithAuthenticatedCcsUrl(): string;
+    /**
+     * Returns the URL for retrieving reserved concept IDs.
+     * @returns {string} The reserved IDs API endpoint
+     */
+    static GetReservedIdUrl(): string;
+    /**
+     * Returns the URL for retrieving reserved connection IDs.
+     * @returns {string} The reserved connection IDs API endpoint
+     */
+    static GetReservedConnectionIdUrl(): string;
+    /**
+     * Returns the URL for creating text data.
+     * @returns {string} The text data creation API endpoint
+     */
+    static CreateTheTextDataUrl(): string;
+    /**
+     * Returns the URL for creating character data.
+     * @returns {string} The character data creation API endpoint
+     */
+    static CreateTheCharacterDataUrl(): string;
+    /**
+     * Returns the URL for creating concepts.
+     * @returns {string} The concept creation API endpoint
+     */
+    static CreateTheConceptUrl(): string;
+    /**
+     * Returns the URL for creating connections.
+     * @returns {string} The connection creation API endpoint
+     */
+    static CreateTheConnectionUrl(): string;
+    /**
+     * Returns the URL for creating connections using the new endpoint.
+     * @returns {string} The new connection creation API endpoint
+     */
+    static CreateTheConnectionNewUrl(): string;
+    /**
+     * Returns the URL for creating type concepts.
+     * @returns {string} The type concept creation API endpoint
+     */
+    static MakeTheTypeConceptUrl(): string;
+    /**
+     * Returns the URL for deleting a single connection.
+     * @returns {string} The connection deletion API endpoint
+     */
+    static DeleteTheConnectionUrl(): string;
+    /**
+     * Returns the URL for deleting multiple connections in bulk.
+     * @returns {string} The bulk connection deletion API endpoint
+     */
+    static DeleteTheConnectionBulkUrl(): string;
+    /**
+     * Returns the URL for executing FreeSchema queries.
+     * @returns {string} The FreeSchema query API endpoint
+     */
+    static FreeschemaQueryUrl(): string;
+    /**
+     * Returns the URL for retrieving type concepts by character in bulk.
+     * @returns {string} The bulk type concept retrieval API endpoint
+     */
+    static GetConceptConnectionByType(): string;
+}

package/dist/types/DataStructures/BinaryCharacterTree.d.ts

@@ -0,0 +1,227 @@
+/**
+ * @fileoverview BinaryCharacterTree module providing self-balancing AVL tree for concept storage by character value.
+ * This module implements an AVL tree structure for efficient concept retrieval using string-based keys
+ * with support for variant nodes (multiple concepts with the same character value).
+ * @module DataStructures/BinaryCharacterTree
+ */
+import { Concept } from "../DataStructures/Concept";
+import { Node } from "./Node";
+/**
+ * Self-balancing AVL binary tree for storing and retrieving concepts by their character value.
+ * Supports multiple concepts with the same character value through variant nodes.
+ * Provides O(log n) time complexity for insertions, deletions, and lookups.
+ *
+ * @class BinaryCharacterTree
+ * @example
+ * ```typescript
+ * // Add a concept to the tree
+ * BinaryCharacterTree.addConceptToTree(myConcept);
+ *
+ * // Retrieve a concept by character value
+ * const node = BinaryCharacterTree.getNodeFromTree("Apple");
+ * if (node) {
+ *   console.log("Found:", node.value.id);
+ * }
+ *
+ * // Get concept by character and type
+ * const specificNode = await BinaryCharacterTree.getCharacterAndTypeFromTree("Apple", 5);
+ * ```
+ *
+ * @remarks
+ * This class uses static methods and maintains a single root node for the entire tree.
+ * When multiple concepts share the same character value, they are stored as variants.
+ */
+export declare class BinaryCharacterTree {
+    /** Root node of the character-based binary tree, null if tree is empty */
+    static characterRoot: Node | null;
+    /**
+     * Waits for the character data loading flag to be set before proceeding.
+     * Used for synchronization when loading initial data.
+     *
+     * @returns {Promise<string>} Resolves with "done" when data is loaded, rejects with "not" after 25 seconds
+     *
+     * @example
+     * ```typescript
+     * try {
+     *   await BinaryCharacterTree.waitForDataToLoad();
+     *   console.log("Character data loaded");
+     * } catch (error) {
+     *   console.log("Character data load timeout");
+     * }
+     * ```
+     *
+     * @remarks
+     * Uses IdentifierFlags.isCharacterLoaded to determine when data is ready.
+     * Times out after 25 seconds to prevent infinite waiting.
+     */
+    static waitForDataToLoad(): Promise<unknown>;
+    /**
+     * Recursively checks if the character data loaded flag is set.
+     * Internal helper method for waitForDataToLoad.
+     *
+     * @param {any} resolve - Promise resolve function
+     *
+     * @remarks
+     * Checks IdentifierFlags.isCharacterLoaded every 1000ms until it's true.
+     * This is an internal method used by waitForDataToLoad.
+     */
+    static checkFlag(resolve: any): any;
+    /**
+     * Adds a node to the character-based binary tree, maintaining AVL balance.
+     * Supports adding variant nodes for concepts with the same character value.
+     *
+     * @param {Node} node - The node to add to the tree
+     * @returns {Promise<Node>} The new root node after insertion and balancing
+     *
+     * @example
+     * ```typescript
+     * const node = new Node("Apple", myConcept, null, null);
+     * await BinaryCharacterTree.addNodeToTree(node);
+     * ```
+     *
+     * @remarks
+     * If the tree is empty, the node becomes the root.
+     * If a node with the same character value exists, the new concept is added as a variant.
+     */
+    static addNodeToTree(node: Node): Promise<Node | null>;
+    /**
+     * Removes a specific concept from a character node by character value and concept ID.
+     *
+     * @param {string} character - The character value to search for
+     * @param {number} id - The concept ID to remove
+     *
+     * @example
+     * ```typescript
+     * await BinaryCharacterTree.removeNodeByCharacter("Apple", 123);
+     * ```
+     *
+     * @remarks
+     * If multiple concepts share the same character value, only the one with matching ID is removed.
+     * Does nothing if the tree is empty.
+     */
+    static removeNodeByCharacter(character: string, id: number): Promise<void>;
+    /**
+     * Counts the total number of nodes in the character tree.
+     *
+     * @returns {number} The total count of nodes in the tree
+     *
+     * @example
+     * ```typescript
+     * const nodeCount = BinaryCharacterTree.countNumberOfNodes();
+     * console.log(`Tree contains ${nodeCount} character nodes`);
+     * ```
+     *
+     * @remarks
+     * Recursively traverses the entire tree to count nodes.
+     * Returns 0 if the tree is empty.
+     */
+    static countNumberOfNodes(): number;
+    /**
+     * Convenience method to add a concept to the character tree.
+     *
+     * @param {Concept} concept - The concept to add to the tree
+     *
+     * @example
+     * ```typescript
+     * BinaryCharacterTree.addConceptToTree(myConcept);
+     * ```
+     *
+     * @remarks
+     * Only adds concepts with non-empty character values.
+     * Creates a node with the concept's character value as the key.
+     */
+    static addConceptToTree(concept: Concept): void;
+    /**
+     * Retrieves a node from the tree by its character value.
+     *
+     * @param {string} value - The character value to search for
+     * @returns {Node | null} The node if found, null otherwise
+     *
+     * @example
+     * ```typescript
+     * const node = BinaryCharacterTree.getNodeFromTree("Apple");
+     * if (node) {
+     *   const concept = node.value as Concept;
+     *   console.log(concept.id);
+     * }
+     * ```
+     *
+     * @remarks
+     * Uses binary search for O(log n) time complexity.
+     * Returns the main node; access variants through node.variants property.
+     */
+    static getNodeFromTree(value: string): Node | null;
+    /**
+     * Retrieves a node from the tree by its character value (updated version).
+     * Currently identical to getNodeFromTree.
+     *
+     * @param {string} value - The character value to search for
+     * @returns {Node | null} The node if found, null otherwise
+     *
+     * @example
+     * ```typescript
+     * const node = BinaryCharacterTree.getNodeFromTreeUpdated("Apple");
+     * ```
+     *
+     * @remarks
+     * This method may be deprecated or merged with getNodeFromTree in future versions.
+     */
+    static getNodeFromTreeUpdated(value: string): Node | null;
+    /**
+     * Retrieves a node matching both character value and type ID.
+     * Searches through variants to find the specific type match.
+     *
+     * @param {string} value - The character value to search for
+     * @param {number} typeId - The type ID to filter by
+     * @returns {Promise<Node | null>} The node matching both criteria, null if not found
+     *
+     * @example
+     * ```typescript
+     * const node = await BinaryCharacterTree.getCharacterAndTypeFromTree("Apple", 5);
+     * if (node) {
+     *   console.log("Found Apple of type 5");
+     * }
+     * ```
+     *
+     * @remarks
+     * First finds the character node, then searches through variants for matching type.
+     * Returns null if no match is found.
+     */
+    static getCharacterAndTypeFromTree(value: string, typeId: number): Promise<Node | null>;
+    /**
+     * Retrieves a node matching both character value and category ID.
+     * Searches through variants to find the specific category match.
+     *
+     * @param {string} value - The character value to search for
+     * @param {number} categoryId - The category ID to filter by
+     * @returns {Promise<Node | null>} The node matching both criteria, null if not found
+     *
+     * @example
+     * ```typescript
+     * const node = await BinaryCharacterTree.getCharacterAndCategoryFromTree("Apple", 3);
+     * if (node) {
+     *   console.log("Found Apple in category 3");
+     * }
+     * ```
+     *
+     * @remarks
+     * First finds the character node, then searches through variants for matching category.
+     * Returns null if no match is found.
+     */
+    static getCharacterAndCategoryFromTree(value: string, categoryId: number): Promise<Node | null>;
+    /**
+     * Removes a concept from the character tree by its ID.
+     *
+     * @param {number} id - The concept ID to remove
+     *
+     * @example
+     * ```typescript
+     * BinaryCharacterTree.removeConceptCharacter(123);
+     * ```
+     *
+     * @remarks
+     * After removal, the tree is automatically rebalanced to maintain AVL properties.
+     * Does nothing if the tree is empty.
+     */
+    static removeConceptCharacter(id: number): void;
+}

package/dist/types/DataStructures/BinaryTree.d.ts

@@ -0,0 +1,151 @@
+/**
+ * @fileoverview BinaryTree module providing self-balancing AVL tree for concept storage by ID.
+ * This module implements an AVL (Adelson-Velsky and Landis) tree structure for efficient
+ * concept retrieval with O(log n) time complexity.
+ * @module DataStructures/BinaryTree
+ */
+import { Concept } from "../DataStructures/Concept";
+import { Node } from "./Node";
+/**
+ * Self-balancing AVL binary tree for storing and retrieving concepts by their numeric ID.
+ * Provides O(log n) time complexity for insertions, deletions, and lookups.
+ *
+ * @class BinaryTree
+ * @example
+ * ```typescript
+ * // Add a concept to the tree
+ * BinaryTree.addConceptToTree(myConcept);
+ *
+ * // Retrieve a concept by ID
+ * const node = await BinaryTree.getNodeFromTree(123);
+ * if (node) {
+ *   console.log("Found:", node.value.characterValue);
+ * }
+ *
+ * // Count all nodes
+ * const count = BinaryTree.countNumberOfNodes();
+ * ```
+ *
+ * @remarks
+ * This class uses static methods and maintains a single root node for the entire tree.
+ * The tree automatically balances itself using AVL rotations to maintain optimal search performance.
+ */
+export declare class BinaryTree {
+    /** Root node of the binary tree, null if tree is empty */
+    static root: Node | null;
+    /**
+     * Adds a node to the binary tree, maintaining AVL balance.
+     *
+     * @param {Node} node - The node to add to the tree
+     * @returns {Node} The new root node after insertion and balancing
+     *
+     * @example
+     * ```typescript
+     * const node = new Node(123, myConcept, null, null);
+     * BinaryTree.addNodeToTree(node);
+     * ```
+     *
+     * @remarks
+     * If the tree is empty, the node becomes the root.
+     * Otherwise, the node is inserted and the tree is automatically balanced.
+     */
+    static addNodeToTree(node: Node): Node | undefined;
+    /**
+     * Waits for the data loading flag to be set before proceeding.
+     * Used for synchronization when loading initial data.
+     *
+     * @returns {Promise<string>} Resolves with "done" when data is loaded, rejects with "not" after 25 seconds
+     *
+     * @example
+     * ```typescript
+     * try {
+     *   await BinaryTree.waitForDataToLoad();
+     *   console.log("Data loaded successfully");
+     * } catch (error) {
+     *   console.log("Data load timeout");
+     * }
+     * ```
+     *
+     * @remarks
+     * Uses IdentifierFlags.isDataLoaded to determine when data is ready.
+     * Times out after 25 seconds to prevent infinite waiting.
+     */
+    static waitForDataToLoad(): Promise<unknown>;
+    /**
+     * Recursively checks if the data loaded flag is set.
+     * Internal helper method for waitForDataToLoad.
+     *
+     * @param {any} resolve - Promise resolve function
+     *
+     * @remarks
+     * Checks IdentifierFlags.isDataLoaded every 1000ms until it's true.
+     * This is an internal method used by waitForDataToLoad.
+     */
+    static checkFlag(resolve: any): any;
+    /**
+     * Convenience method to add a concept to both the ID tree and character tree.
+     *
+     * @param {Concept} concept - The concept to add to the tree
+     *
+     * @example
+     * ```typescript
+     * BinaryTree.addConceptToTree(myConcept);
+     * ```
+     *
+     * @remarks
+     * Creates a node with the concept's ID as the key and adds it to this tree.
+     * Also creates a node with the concept's character value and adds it to BinaryCharacterTree.
+     */
+    static addConceptToTree(concept: Concept): void;
+    /**
+     * Retrieves a node from the tree by its ID.
+     *
+     * @param {number} id - The concept ID to search for
+     * @returns {Promise<Node | null>} The node if found, null otherwise
+     *
+     * @example
+     * ```typescript
+     * const node = await BinaryTree.getNodeFromTree(123);
+     * if (node) {
+     *   const concept = node.value as Concept;
+     *   console.log(concept.characterValue);
+     * }
+     * ```
+     *
+     * @remarks
+     * Uses binary search for O(log n) time complexity.
+     * Returns null if the tree is empty or the node is not found.
+     */
+    static getNodeFromTree(id: number): Promise<Node | null>;
+    /**
+     * Removes a node from the tree by its ID.
+     *
+     * @param {number} id - The concept ID to remove
+     *
+     * @example
+     * ```typescript
+     * await BinaryTree.removeNodeFromTree(123);
+     * ```
+     *
+     * @remarks
+     * After removal, the tree is automatically rebalanced to maintain AVL properties.
+     * Does nothing if the tree is empty.
+     */
+    static removeNodeFromTree(id: number): Promise<void>;
+    /**
+     * Counts the total number of nodes in the tree.
+     *
+     * @returns {number} The total count of nodes in the tree
+     *
+     * @example
+     * ```typescript
+     * const nodeCount = BinaryTree.countNumberOfNodes();
+     * console.log(`Tree contains ${nodeCount} concepts`);
+     * ```
+     *
+     * @remarks
+     * Recursively traverses the entire tree to count nodes.
+     * Returns 0 if the tree is empty.
+     */
+    static countNumberOfNodes(): number;
+}