mftsccs-node 0.0.56 → 0.0.58

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

@@ -0,0 +1,146 @@
+/**
+ * @fileoverview Defines the SearchQuery class for constructing search queries with filtering and pagination.
+ * @module DataStructures/SearchQuery
+ */
+import { FilterSearch } from "./FilterSearch";
+/**
+ * Represents a search query configuration with support for filtering, linking, and pagination.
+ * This class provides a comprehensive structure for building complex search operations
+ * with multiple criteria and logical operators.
+ *
+ * @class SearchQuery
+ *
+ * @example
+ * ```typescript
+ * const query = new SearchQuery();
+ * query.type = "Article";
+ * query.composition = 123;
+ * query.textSearch = "TypeScript tutorial";
+ * query.page = 1;
+ * query.inpage = 25;
+ * query.logic = "and";
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Search with filters
+ * const query = new SearchQuery();
+ * query.type = "Product";
+ * query.doFilter = true;
+ * query.filterSearches = [
+ *   { type: "price", search: "100", logicoperator: ">", index: 0, composition: true, name: "price", operateon: "value" },
+ *   { type: "category", search: "Electronics", logicoperator: "=", index: 1, composition: true, name: "category", operateon: "value" }
+ * ];
+ * ```
+ */
+export declare class SearchQuery {
+    /**
+     * The composition ID to search within.
+     * Specifies which composition context the search should be performed in.
+     *
+     * @type {number}
+     * @default 0
+     */
+    composition: number;
+    /**
+     * The type of entity to search for.
+     * Determines the data structure or entity type being queried.
+     *
+     * @type {string}
+     * @default ""
+     */
+    type: string;
+    /**
+     * The linker identifier for relationship-based searches.
+     * Used to specify connection types when traversing relationships.
+     *
+     * @type {string}
+     * @default ""
+     */
+    linker: string;
+    /**
+     * The number of results to display per page (page size).
+     * Controls pagination by limiting the number of results returned.
+     *
+     * @type {number}
+     * @default 10
+     */
+    inpage: number;
+    /**
+     * The page number to retrieve (1-indexed).
+     * Used with inpage for paginating through search results.
+     *
+     * @type {number}
+     * @default 1
+     */
+    page: number;
+    /**
+     * Array of linker identifiers for multiple relationship types.
+     * Allows searching across multiple connection types simultaneously.
+     *
+     * @type {string[]}
+     * @default []
+     */
+    listLinkers: string[];
+    /**
+     * Array of complete linker specifications for complex relationship queries.
+     * Contains fully qualified linker definitions for advanced searches.
+     *
+     * @type {string[]}
+     * @default []
+     */
+    fullLinkers: string[];
+    /**
+     * The text search term or query string.
+     * Primary search criteria for text-based filtering.
+     *
+     * @type {string}
+     * @default ""
+     */
+    textSearch: string;
+    /**
+     * The logical operator to combine multiple search criteria.
+     * Determines how multiple conditions are combined (e.g., "or", "and").
+     *
+     * @type {string}
+     * @default "or"
+     */
+    logic: string;
+    /**
+     * Flag indicating whether to reverse the search direction.
+     * When true, traverses relationships in the opposite direction.
+     *
+     * @type {boolean}
+     * @default false
+     */
+    reverse: boolean;
+    /**
+     * Flag indicating whether to apply filters to the search.
+     * When true, the filterSearches array is applied to narrow results.
+     *
+     * @type {boolean}
+     * @default false
+     */
+    doFilter: boolean;
+    /**
+     * Array of FilterSearch objects defining specific filter criteria.
+     * Each filter specifies conditions that must be met for results to be included.
+     *
+     * @type {FilterSearch[]}
+     * @default []
+     */
+    filterSearches: FilterSearch[];
+    /**
+     * Array of field selectors to include in the query results.
+     * Specifies which properties should be returned in the response.
+     *
+     * @type {string[]}
+     * @default []
+     *
+     * @example
+     * ```typescript
+     * query.selectors = ["id", "name", "createdAt"];
+     * ```
+     */
+    selectors: string[];
+}

package/dist/types/DataStructures/Security/TokenStorage.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @fileoverview Defines the TokenStorage class for managing authentication tokens.
+ * @module DataStructures/Security/TokenStorage
+ */
+/**
+ * Centralized storage for authentication tokens.
+ * This class provides a singleton-like static storage mechanism for managing
+ * Bearer access tokens across the application. The token is stored as a static
+ * property, making it accessible throughout the application without instantiation.
+ *
+ * @class TokenStorage
+ *
+ * @example
+ * ```typescript
+ * // Set the access token after authentication
+ * TokenStorage.BearerAccessToken = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...";
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Retrieve the access token for API requests
+ * const token = TokenStorage.BearerAccessToken;
+ * const headers = {
+ *   'Authorization': `Bearer ${token}`
+ * };
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Clear the token on logout
+ * TokenStorage.BearerAccessToken = "";
+ * ```
+ */
+export declare class TokenStorage {
+    /**
+     * The Bearer access token used for authentication.
+     * This static property stores the JWT or other authentication token
+     * used for authorizing API requests. The token typically has the format
+     * "Bearer <token>" when included in HTTP headers.
+     *
+     * @static
+     * @type {string}
+     * @default ""
+     *
+     * @remarks
+     * As a static property, this token is shared across all instances and modules.
+     * Exercise caution when handling this token to prevent security vulnerabilities.
+     * Consider clearing this value on logout or session expiration.
+     */
+    static BearerAccessToken: string;
+}

package/dist/types/DataStructures/Session/SessionData.d.ts

@@ -0,0 +1,131 @@
+/**
+ * @fileoverview Defines the SessionData class for storing session information.
+ * @module DataStructures/Session/SessionData
+ */
+/**
+ * Represents session information for a user's connection.
+ * This class stores comprehensive details about a user's session, including
+ * network information, server configuration, and user identification data.
+ * It captures both client and server-side information for session tracking and security purposes.
+ *
+ * @class SessionData
+ *
+ * @example
+ * ```typescript
+ * const session = new SessionData();
+ * session.id = "abc123def456";
+ * session.userId = "12345";
+ * session.email = "user@example.com";
+ * session.remote_address = "192.168.1.100";
+ * session.http_user_agent = "Mozilla/5.0...";
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Populate session data from request
+ * const session = new SessionData();
+ * session.remote_address = request.connection.remoteAddress;
+ * session.server_port = process.env.PORT;
+ * session.server_name = request.hostname;
+ * ```
+ */
+export declare class SessionData {
+    /**
+     * The unique session identifier.
+     * Used to track and identify individual sessions across requests.
+     *
+     * @type {string}
+     * @default "0"
+     */
+    id: string;
+    /**
+     * The remote IP address of the client.
+     * Identifies the network address from which the client is connecting.
+     *
+     * @type {string}
+     * @default ""
+     *
+     * @example "192.168.1.100" or "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
+     */
+    remote_address: string;
+    /**
+     * The port number on which the server is listening.
+     * Indicates which server port is handling the connection.
+     *
+     * @type {string}
+     * @default ""
+     *
+     * @example "8080" or "443"
+     */
+    server_port: string;
+    /**
+     * The server's IP address.
+     * Identifies the network address of the server handling the request.
+     *
+     * @type {string}
+     * @default ""
+     */
+    server_address: string;
+    /**
+     * The server's hostname or domain name.
+     * The fully qualified domain name or hostname of the server.
+     *
+     * @type {string}
+     * @default ""
+     *
+     * @example "api.example.com" or "localhost"
+     */
+    server_name: string;
+    /**
+     * Information about the server software.
+     * Identifies the server software and version handling the request.
+     *
+     * @type {string}
+     * @default ""
+     *
+     * @example "Apache/2.4.41" or "nginx/1.18.0"
+     */
+    server_software: string;
+    /**
+     * The HTTP User-Agent header from the client.
+     * Contains information about the client's browser or application making the request.
+     *
+     * @type {string}
+     * @default ""
+     *
+     * @example "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36..."
+     */
+    http_user_agent: string;
+    /**
+     * The self-referential identifier or URL.
+     * May contain a reference to the current script or endpoint.
+     *
+     * @type {string}
+     * @default ""
+     */
+    self: string;
+    /**
+     * The client's port number.
+     * Indicates which port on the client side is being used for the connection.
+     *
+     * @type {string}
+     * @default ""
+     */
+    port: string;
+    /**
+     * The user's unique identifier.
+     * Links the session to a specific user account.
+     *
+     * @type {string}
+     * @default ""
+     */
+    userId: string;
+    /**
+     * The user's email address.
+     * Stores the authenticated user's email for session tracking.
+     *
+     * @type {string}
+     * @default ""
+     */
+    email: string;
+}

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

@@ -0,0 +1,37 @@
+/**
+ * @fileoverview SettingData module for managing persisted setting data in CCS-JS.
+ * This module defines the structure for storing user preferences and configuration.
+ * @module DataStructures/SettingData
+ */
+/**
+ * Represents persisted setting data for the application.
+ * Can be stored in local storage or IndexedDB for user preferences.
+ *
+ * @class SettingData
+ * @example
+ * ```typescript
+ * // Create settings with online sync enabled
+ * const settings = new SettingData(true);
+ *
+ * // Store settings
+ * localStorage.setItem('settings', JSON.stringify(settings));
+ * ```
+ */
+export declare class SettingData {
+    /** Unique identifier for the settings record */
+    id: number;
+    /** Controls whether online synchronization is enabled */
+    isOnlineSync: boolean;
+    /**
+     * Creates a new SettingData instance.
+     *
+     * @param {boolean} isOnlineSync - Whether to enable online synchronization
+     *
+     * @example
+     * ```typescript
+     * const settings = new SettingData(true);
+     * console.log(settings.isOnlineSync); // true
+     * ```
+     */
+    constructor(isOnlineSync: boolean);
+}

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

@@ -0,0 +1,31 @@
+/**
+ * @fileoverview Settings module for managing global application settings in CCS-JS.
+ * This module provides centralized configuration flags for application behavior.
+ * @module DataStructures/Settings
+ */
+/**
+ * Global application settings for CCS-JS.
+ * Controls application-wide behavior such as update status and synchronization mode.
+ *
+ * @class Settings
+ * @example
+ * ```typescript
+ * // Enable online sync
+ * Settings.isOnlineSync = true;
+ *
+ * // Check if system is updated
+ * if (Settings.isUpdated) {
+ *   console.log("System is up to date");
+ * }
+ * ```
+ *
+ * @remarks
+ * All properties are static flags used across the application.
+ * These settings affect how data is synchronized and persisted.
+ */
+export declare class Settings {
+    /** Flag indicating if the system has been updated to the latest version */
+    static isUpdated: boolean;
+    /** Flag controlling whether changes are synchronized online immediately */
+    static isOnlineSync: boolean;
+}

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

@@ -0,0 +1,54 @@
+/**
+ * @fileoverview Defines the SigninModel interface for user authentication data.
+ * @module DataStructures/SigninModel
+ */
+/**
+ * Represents the data required for user authentication/signin.
+ * This interface defines the structure for collecting user credentials
+ * during the login process.
+ *
+ * @interface SigninModel
+ *
+ * @example
+ * ```typescript
+ * const signinData: SigninModel = {
+ *   email: "user@example.com",
+ *   password: "MySecurePassword123"
+ * };
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Usage in an authentication function
+ * async function authenticateUser(credentials: SigninModel) {
+ *   const user = await validateCredentials(credentials.email, credentials.password);
+ *   if (user) {
+ *     return generateAuthToken(user);
+ *   }
+ *   throw new Error("Invalid credentials");
+ * }
+ * ```
+ */
+export interface SigninModel {
+    /**
+     * The user's email address.
+     * Used to identify the user account attempting to sign in.
+     *
+     * @type {string}
+     *
+     * @example "user@example.com"
+     */
+    email: string;
+    /**
+     * The user's password for authentication.
+     * Will be verified against the stored hashed password.
+     *
+     * @type {string}
+     *
+     * @remarks
+     * The password is transmitted securely and verified against
+     * the hashed version stored in the database. Never store or
+     * log passwords in plain text.
+     */
+    password: string;
+}

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

@@ -0,0 +1,54 @@
+/**
+ * @fileoverview Defines the SignupModel interface for user registration data.
+ * @module DataStructures/SignupModel
+ */
+/**
+ * Represents the data required for user registration/signup.
+ * This interface defines the structure for collecting user credentials
+ * during the account creation process.
+ *
+ * @interface SignupModel
+ *
+ * @example
+ * ```typescript
+ * const signupData: SignupModel = {
+ *   email: "newuser@example.com",
+ *   password: "SecureP@ssw0rd123"
+ * };
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Usage in a signup function
+ * async function registerUser(userData: SignupModel) {
+ *   // Validate and create user account
+ *   const result = await createAccount(userData.email, userData.password);
+ *   return result;
+ * }
+ * ```
+ */
+export interface SignupModel {
+    /**
+     * The user's email address.
+     * Used as the primary identifier for the user account.
+     * Should be unique and in valid email format.
+     *
+     * @type {string}
+     *
+     * @example "user@example.com"
+     */
+    email: string;
+    /**
+     * The user's password for account authentication.
+     * Should meet security requirements (e.g., minimum length, complexity).
+     * Will be hashed before storage for security purposes.
+     *
+     * @type {string}
+     *
+     * @remarks
+     * Passwords should be validated for strength before being accepted.
+     * Common requirements include minimum length, uppercase, lowercase,
+     * numbers, and special characters.
+     */
+    password: string;
+}