mftsccs-node 0.2.7 → 0.2.8

package/dist/types/Constants/ApiConstants.d.ts

@@ -1,23 +1,249 @@
+/**
+ * API Constants Module for Concept Connection System (CCS-JS)
+ *
+ * This module defines all API endpoint URLs and configuration for interacting with the FreeSchema backend.
+ * It provides centralized URL management and allows dynamic base URL configuration for different environments.
+ *
+ * @module Constants/ApiConstants
+ * @see https://documentation.freeschema.com for API reference
+ */
+/**
+ * Default configuration object for the API base URL.
+ * Points to the development environment of FreeSchema.
+ *
+ * @example
+ * ```typescript
+ * console.log(config.BASE_URL); // "https://devboom.freeschema.com"
+ * ```
+ */
 export declare const config: {
     BASE_URL: string;
 };
+/**
+ * The current base URL for all API requests.
+ * This value is dynamically retrieved and can be changed using `changeBaseUrl()`.
+ *
+ * @see {@link getBaseUrl}
+ * @see {@link changeBaseUrl}
+ */
 export declare const BASE_URL: string;
+/**
+ * API endpoint URL for retrieving a single concept by ID.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(`${GetConceptUrl}?id=123`);
+ * ```
+ *
+ * @see https://documentation.freeschema.com for API documentation
+ */
 export declare const GetConceptUrl: string;
+/**
+ * API endpoint URL for retrieving multiple concepts in bulk.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(GetConceptBulkUrl, {
+ *   method: 'POST',
+ *   body: JSON.stringify({ ids: [1, 2, 3] })
+ * });
+ * ```
+ */
 export declare const GetConceptBulkUrl: string;
+/**
+ * API endpoint URL for retrieving all concepts belonging to a specific user.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(`${GetAllConceptsOfUserUrl}?userId=456`);
+ * ```
+ */
 export declare const GetAllConceptsOfUserUrl: string;
+/**
+ * API endpoint URL for retrieving all connections belonging to a specific user.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(`${GetAllConnectionsOfUserUrl}?userId=456`);
+ * ```
+ */
 export declare const GetAllConnectionsOfUserUrl: string;
+/**
+ * API endpoint URL for retrieving all connections within a composition.
+ * A composition is a grouping of related concepts and their connections.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(`${GetAllConnectionsOfCompositionUrl}?compositionId=789`);
+ * ```
+ */
 export declare const GetAllConnectionsOfCompositionUrl: string;
+/**
+ * API endpoint URL for retrieving connections of multiple compositions in bulk.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(GetAllConnectionsOfCompositionBulkUrl, {
+ *   method: 'POST',
+ *   body: JSON.stringify({ compositionIds: [1, 2, 3] })
+ * });
+ * ```
+ */
 export declare const GetAllConnectionsOfCompositionBulkUrl: string;
+/**
+ * API endpoint URL for retrieving a concept by its character value.
+ * Character value is the string representation/label of a concept.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(`${GetConceptByCharacterValueUrl}?value=hello`);
+ * ```
+ */
 export declare const GetConceptByCharacterValueUrl: string;
+/**
+ * API endpoint URL for retrieving a concept by both its character value and type.
+ * This provides more specific filtering when multiple concepts share the same character value.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(`${GetConceptByCharacterAndTypeUrl}?value=hello&typeId=5`);
+ * ```
+ */
 export declare const GetConceptByCharacterAndTypeUrl: string;
+/**
+ * API endpoint URL for retrieving character data by character string.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(`${GetCharacterByCharacterUrl}?character=A`);
+ * ```
+ */
 export declare const GetCharacterByCharacterUrl: string;
+/**
+ * API endpoint URL for retrieving all concepts of a specific type.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(`${GetAllConceptsByTypeUrl}?typeId=10`);
+ * ```
+ */
 export declare const GetAllConceptsByTypeUrl: string;
+/**
+ * API endpoint URL for retrieving all connections associated with a specific concept.
+ * This includes both incoming and outgoing connections.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(`${GetAllConnectionsOfConceptUrl}?conceptId=123`);
+ * ```
+ */
 export declare const GetAllConnectionsOfConceptUrl: string;
+/**
+ * API endpoint URL for retrieving AI-ranked data.
+ * Can be overridden via the AI_URL environment variable.
+ *
+ * @remarks
+ * The default query parameter `inpage=500` limits the number of results returned.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(GetAllAiData);
+ * ```
+ */
 export declare const GetAllAiData: string;
+/**
+ * API endpoint URL for retrieving reserved IDs from the system.
+ * Reserved IDs are pre-allocated concept IDs used for system-level concepts.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(GetReservedIdUrl);
+ * ```
+ *
+ * @see https://documentation.freeschema.com for information about reserved IDs
+ */
 export declare const GetReservedIdUrl: string;
+/**
+ * API endpoint URL for creating text data in the system.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(CreateTheTextDataUrl, {
+ *   method: 'POST',
+ *   body: JSON.stringify({ text: 'Hello World' })
+ * });
+ * ```
+ */
 export declare const CreateTheTextDataUrl: string;
+/**
+ * API endpoint URL for creating character data in the system.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(CreateTheCharacterDataUrl, {
+ *   method: 'POST',
+ *   body: JSON.stringify({ character: 'A' })
+ * });
+ * ```
+ */
 export declare const CreateTheCharacterDataUrl: string;
+/**
+ * API endpoint URL for creating a new concept in the system.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(CreateTheConceptUrl, {
+ *   method: 'POST',
+ *   body: JSON.stringify({
+ *     characterValue: 'example',
+ *     typeId: 5,
+ *     userId: 123
+ *   })
+ * });
+ * ```
+ */
 export declare const CreateTheConceptUrl: string;
+/**
+ * API endpoint URL for creating a new connection between concepts.
+ *
+ * @example
+ * ```typescript
+ * const response = await fetch(CreateTheConnectionUrl, {
+ *   method: 'POST',
+ *   body: JSON.stringify({
+ *     ofTheConceptId: 1,
+ *     toTheConceptId: 2,
+ *     typeId: 3
+ *   })
+ * });
+ * ```
+ */
 export declare const CreateTheConnectionUrl: string;
+/**
+ * Changes the base URL for all API endpoints.
+ * This is useful for switching between development, staging, and production environments.
+ *
+ * @param url - The new base URL to use for API requests
+ *
+ * @example
+ * ```typescript
+ * changeBaseUrl('https://production.freeschema.com');
+ * ```
+ *
+ * @remarks
+ * This function modifies the global BaseUrl object, affecting all subsequent API calls.
+ * Make sure to call this before making any API requests if you need a custom URL.
+ */
 export declare function changeBaseUrl(url: string): void;
+/**
+ * Retrieves the current base URL being used for API requests.
+ *
+ * @returns The current base URL string
+ *
+ * @example
+ * ```typescript
+ * const currentUrl = getBaseUrl();
+ * console.log(currentUrl); // "https://devboom.freeschema.com"
+ * ```
+ */
 export declare function getBaseUrl(): string;

package/dist/types/Constants/FormatConstants.d.ts

@@ -1,7 +1,88 @@
+/**
+ * Format Constants Module for Concept Connection System (CCS-JS)
+ *
+ * This module defines constants for different data format types used throughout the system.
+ * These format types determine how data structures (concepts, connections, etc.) are serialized
+ * and presented when retrieved from the API or displayed in the application.
+ *
+ * @module Constants/FormatConstants
+ * @see https://documentation.freeschema.com for format specifications
+ */
+/**
+ * Standard normal format for data representation.
+ * This format includes essential data fields without additional metadata.
+ *
+ * @example
+ * ```typescript
+ * import { NORMAL } from './FormatConstants';
+ * const format = NORMAL; // 1
+ * ```
+ */
 export declare const NORMAL = 1;
+/**
+ * Data with ID format.
+ * This format includes the data along with its unique identifier.
+ *
+ * @example
+ * ```typescript
+ * import { DATAID } from './FormatConstants';
+ * const format = DATAID; // 2
+ * ```
+ */
 export declare const DATAID = 2;
+/**
+ * Just data format without any metadata.
+ * This format returns only the core data fields, excluding IDs and timestamps.
+ *
+ * @example
+ * ```typescript
+ * import { JUSTDATA } from './FormatConstants';
+ * const format = JUSTDATA; // 3
+ * ```
+ */
 export declare const JUSTDATA = 3;
+/**
+ * Data with ID and date format.
+ * This format includes the data, its ID, and associated timestamp information.
+ *
+ * @example
+ * ```typescript
+ * import { DATAIDDATE } from './FormatConstants';
+ * const format = DATAIDDATE; // 4
+ * ```
+ */
 export declare const DATAIDDATE = 4;
+/**
+ * Raw data format.
+ * This format returns data in its raw form as stored in the database without any processing.
+ *
+ * @example
+ * ```typescript
+ * import { RAW } from './FormatConstants';
+ * const format = RAW; // 5
+ * ```
+ */
 export declare const RAW = 5;
+/**
+ * All IDs format.
+ * This format includes all related IDs (concept IDs, type IDs, user IDs, etc.).
+ *
+ * @example
+ * ```typescript
+ * import { ALLID } from './FormatConstants';
+ * const format = ALLID; // 6
+ * ```
+ */
 export declare const ALLID = 6;
+/**
+ * List normal format.
+ * This format is used for representing lists or arrays of data in standard format.
+ *
+ * @example
+ * ```typescript
+ * import { LISTNORMAL } from './FormatConstants';
+ * const format = LISTNORMAL; // 7
+ * ```
+ */
 export declare const LISTNORMAL = 7;
+export declare const DATAV2 = 8;

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

@@ -1,52 +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;
 }