@cdevhub/ngx-chat 1.0.6

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@cdevhub/ngx-chat",
+  "version": "1.0.6",
+  "description": "A pure presentational Angular 21 library for building chat interfaces",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/avs2001/ngx-chat.git"
+  },
+  "bugs": {
+    "url": "https://github.com/avs2001/ngx-chat/issues"
+  },
+  "homepage": "https://github.com/avs2001/ngx-chat#readme",
+  "peerDependencies": {
+    "@angular/animations": "^21.0.0",
+    "@angular/cdk": "^21.0.0",
+    "@angular/common": "^21.0.0",
+    "@angular/core": "^21.0.0"
+  },
+  "dependencies": {
+    "ngx-scrollbar": "^15.0.0",
+    "tslib": "^2.3.0"
+  },
+  "optionalDependencies": {
+    "marked": "^15.0.0",
+    "dompurify": "^3.2.0",
+    "highlight.js": "^11.10.0"
+  },
+  "sideEffects": false,
+  "keywords": [
+    "angular",
+    "chat",
+    "component",
+    "messaging",
+    "ui"
+  ],
+  "license": "MIT",
+  "module": "fesm2022/cdevhub-ngx-chat.mjs",
+  "typings": "types/cdevhub-ngx-chat.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./types/cdevhub-ngx-chat.d.ts",
+      "default": "./fesm2022/cdevhub-ngx-chat.mjs"
+    },
+    "./testing": {
+      "types": "./types/cdevhub-ngx-chat-testing.d.ts",
+      "default": "./fesm2022/cdevhub-ngx-chat-testing.mjs"
+    }
+  }
+}

package/types/cdevhub-ngx-chat-testing.d.ts

@@ -0,0 +1,362 @@
+import { ComponentHarness, BaseHarnessFilters, HarnessPredicate } from '@angular/cdk/testing';
+import { ChatMessage, ConfirmAction, SelectAction, MultiSelectAction, ButtonsAction, MessageAttachment, ChatMessageError } from '@cdevhub/ngx-chat';
+
+/**
+ * @fileoverview Test harness for ChatComponent.
+ * Provides ergonomic methods for testing chat interactions.
+ * @module ngx-chat/testing
+ */
+
+/**
+ * Filter criteria for ChatHarness.
+ */
+interface ChatHarnessFilters extends BaseHarnessFilters {
+    /** Filters by disabled state. */
+    disabled?: boolean;
+}
+/**
+ * Message data returned from getMessages().
+ */
+interface ChatMessageData {
+    /** Message text content. */
+    content: string;
+    /** Sender type: 'self', 'other', or 'system'. */
+    sender: 'self' | 'other' | 'system';
+    /** Sender name if available. */
+    senderName?: string;
+}
+/**
+ * Test harness for ChatComponent.
+ *
+ * Provides methods for:
+ * - Sending messages
+ * - Typing in the input
+ * - Querying message state
+ * - Checking component state
+ *
+ * @example
+ * ```typescript
+ * const harness = await loader.getHarness(ChatHarness);
+ * await harness.typeMessage('Hello');
+ * await harness.sendMessage('Hello');
+ * const count = await harness.getMessageCount();
+ * ```
+ */
+declare class ChatHarness extends ComponentHarness {
+    static hostSelector: string;
+    private readonly _textarea;
+    private readonly _sendButton;
+    private readonly _messagesList;
+    private readonly _messages;
+    private readonly _messageTexts;
+    private readonly _typingIndicator;
+    private readonly _loadingIndicator;
+    private readonly _emptyState;
+    /**
+     * Gets a `HarnessPredicate` that can be used to search for a chat harness
+     * that meets certain criteria.
+     * @param options Options for filtering which chat instances are considered a match.
+     * @returns A predicate for finding matching chat harnesses.
+     */
+    static with(options?: ChatHarnessFilters): HarnessPredicate<ChatHarness>;
+    /**
+     * Types a message and sends it.
+     * Combines typeMessage and clicking send button.
+     * @param content The message content to send.
+     */
+    sendMessage(content: string): Promise<void>;
+    /**
+     * Types content into the message input.
+     * Clears existing content first.
+     * @param content The content to type.
+     */
+    typeMessage(content: string): Promise<void>;
+    /**
+     * Clears the message input.
+     */
+    clearInput(): Promise<void>;
+    /**
+     * Focuses the message input.
+     */
+    focusInput(): Promise<void>;
+    /**
+     * Blurs the message input.
+     */
+    blurInput(): Promise<void>;
+    /**
+     * Gets the number of messages displayed.
+     * @returns The message count.
+     */
+    getMessageCount(): Promise<number>;
+    /**
+     * Gets all messages with their content and sender info.
+     * @returns Array of message data.
+     */
+    getMessages(): Promise<ChatMessageData[]>;
+    /**
+     * Gets the content of the last message.
+     * @returns The last message content, or null if no messages.
+     */
+    getLastMessageContent(): Promise<string | null>;
+    /**
+     * Gets the current value of the message input.
+     * @returns The input value.
+     */
+    getInputValue(): Promise<string>;
+    /**
+     * Checks if the chat is disabled.
+     * @returns True if disabled.
+     */
+    isDisabled(): Promise<boolean>;
+    /**
+     * Checks if the send button is enabled (can send a message).
+     * @returns True if can send.
+     */
+    canSend(): Promise<boolean>;
+    /**
+     * Checks if the typing indicator is visible.
+     * @returns True if typing indicator is shown.
+     */
+    isTypingIndicatorVisible(): Promise<boolean>;
+    /**
+     * Checks if the loading indicator is visible.
+     * @returns True if loading.
+     */
+    isLoading(): Promise<boolean>;
+    /**
+     * Checks if the empty state is visible.
+     * @returns True if showing empty state.
+     */
+    isEmpty(): Promise<boolean>;
+    /**
+     * Checks if any messages are displayed.
+     * @returns True if messages are visible.
+     */
+    hasMessages(): Promise<boolean>;
+    /**
+     * Gets the placeholder text of the input.
+     * @returns The placeholder text.
+     */
+    getPlaceholder(): Promise<string>;
+    /**
+     * Checks if the input has focus.
+     * @returns True if input is focused.
+     */
+    isInputFocused(): Promise<boolean>;
+}
+
+/**
+ * @fileoverview Mock data and test scenarios for ngx-chat testing.
+ * Provides pre-built scenarios and generator functions for comprehensive testing.
+ * @module ngx-chat/testing
+ */
+
+/**
+ * Sample confirm action for testing.
+ */
+declare const SAMPLE_CONFIRM_ACTION: ConfirmAction;
+/**
+ * Sample select action for testing.
+ */
+declare const SAMPLE_SELECT_ACTION: SelectAction;
+/**
+ * Sample multi-select action for testing.
+ */
+declare const SAMPLE_MULTI_SELECT_ACTION: MultiSelectAction;
+/**
+ * Sample buttons action for testing.
+ */
+declare const SAMPLE_BUTTONS_ACTION: ButtonsAction;
+/**
+ * Sample image attachment.
+ */
+declare const SAMPLE_IMAGE_ATTACHMENT: MessageAttachment;
+/**
+ * Sample file attachment.
+ */
+declare const SAMPLE_FILE_ATTACHMENT: MessageAttachment;
+/**
+ * Sample video attachment.
+ */
+declare const SAMPLE_VIDEO_ATTACHMENT: MessageAttachment;
+/**
+ * Sample audio attachment.
+ */
+declare const SAMPLE_AUDIO_ATTACHMENT: MessageAttachment;
+/**
+ * Sample network error.
+ */
+declare const SAMPLE_NETWORK_ERROR: ChatMessageError;
+/**
+ * Sample timeout error.
+ */
+declare const SAMPLE_TIMEOUT_ERROR: ChatMessageError;
+/**
+ * Sample rate limit error.
+ */
+declare const SAMPLE_RATE_LIMIT_ERROR: ChatMessageError;
+/**
+ * Pre-built test scenarios for common testing needs.
+ * Each scenario provides a complete, valid ChatMessage[] array.
+ *
+ * @example
+ * ```typescript
+ * // In a test
+ * const messages = MOCK_SCENARIOS.simpleConversation;
+ * fixture.componentRef.setInput('messages', messages);
+ * ```
+ */
+declare const MOCK_SCENARIOS: {
+    /**
+     * Empty message list for testing empty states.
+     */
+    readonly empty: readonly ChatMessage[];
+    /**
+     * Single message from self.
+     */
+    readonly singleMessage: readonly ChatMessage[];
+    /**
+     * Simple back-and-forth conversation.
+     */
+    readonly simpleConversation: readonly ChatMessage[];
+    /**
+     * Messages with various actions attached.
+     */
+    readonly withActions: readonly ChatMessage[];
+    /**
+     * Message with multi-select action.
+     */
+    readonly withMultiSelect: readonly ChatMessage[];
+    /**
+     * Message with buttons action.
+     */
+    readonly withButtons: readonly ChatMessage[];
+    /**
+     * Messages with error states.
+     */
+    readonly withErrors: readonly ChatMessage[];
+    /**
+     * Messages with file attachments.
+     */
+    readonly withAttachments: readonly ChatMessage[];
+    /**
+     * Long conversation with 100 messages for scroll testing.
+     */
+    readonly longConversation: readonly ChatMessage[];
+    /**
+     * Large dataset with 1000 messages for performance testing.
+     */
+    readonly performanceTest: readonly ChatMessage[];
+    /**
+     * RTL content for internationalization testing.
+     */
+    readonly rtlContent: readonly ChatMessage[];
+    /**
+     * Mixed content with markdown, code, and special characters.
+     */
+    readonly mixedContent: readonly ChatMessage[];
+    /**
+     * System messages for notifications and status updates.
+     */
+    readonly systemMessages: readonly ChatMessage[];
+};
+/**
+ * Generates a conversation with alternating self/other messages.
+ *
+ * @param count - Number of messages to generate
+ * @returns Array of ChatMessage objects
+ *
+ * @example
+ * ```typescript
+ * const messages = generateConversation(50);
+ * expect(messages.length).toBe(50);
+ * ```
+ */
+declare function generateConversation(count: number): readonly ChatMessage[];
+/**
+ * Generates messages with various action types attached.
+ *
+ * @param count - Number of messages to generate (each will have an action)
+ * @returns Array of ChatMessage objects with actions
+ *
+ * @example
+ * ```typescript
+ * const messages = generateWithActions(10);
+ * expect(messages.every(m => m.actions?.length)).toBe(true);
+ * ```
+ */
+declare function generateWithActions(count: number): readonly ChatMessage[];
+/**
+ * Generates messages with various attachment types.
+ *
+ * @param count - Number of messages to generate
+ * @returns Array of ChatMessage objects with attachments
+ */
+declare function generateWithAttachments(count: number): readonly ChatMessage[];
+/**
+ * Default timeout for wait operations in milliseconds.
+ */
+declare const DEFAULT_WAIT_TIMEOUT = 5000;
+/**
+ * Default polling interval for wait operations in milliseconds.
+ */
+declare const DEFAULT_POLL_INTERVAL = 50;
+/**
+ * Waits for the chat harness to display a specific number of messages.
+ *
+ * @param harness - The ChatHarness instance
+ * @param count - Expected number of messages
+ * @param timeout - Maximum wait time in milliseconds (default: 5000)
+ * @returns Promise that resolves when count is reached or rejects on timeout
+ *
+ * @example
+ * ```typescript
+ * const harness = await loader.getHarness(ChatHarness);
+ * fixture.componentRef.setInput('messages', generateConversation(5));
+ * await waitForMessages(harness, 5);
+ * ```
+ */
+declare function waitForMessages(harness: ChatHarness, count: number, timeout?: number): Promise<void>;
+/**
+ * Waits for the typing indicator to reach a specific visibility state.
+ *
+ * @param harness - The ChatHarness instance
+ * @param visible - Expected visibility state (true = visible, false = hidden)
+ * @param timeout - Maximum wait time in milliseconds (default: 5000)
+ * @returns Promise that resolves when state is reached or rejects on timeout
+ *
+ * @example
+ * ```typescript
+ * const harness = await loader.getHarness(ChatHarness);
+ * fixture.componentRef.setInput('isTyping', true);
+ * await waitForTypingIndicator(harness, true);
+ * ```
+ */
+declare function waitForTypingIndicator(harness: ChatHarness, visible: boolean, timeout?: number): Promise<void>;
+/**
+ * Waits for the loading indicator to reach a specific visibility state.
+ *
+ * @param harness - The ChatHarness instance
+ * @param visible - Expected visibility state
+ * @param timeout - Maximum wait time in milliseconds (default: 5000)
+ */
+declare function waitForLoading(harness: ChatHarness, visible: boolean, timeout?: number): Promise<void>;
+/**
+ * Waits for the empty state to reach a specific visibility state.
+ *
+ * @param harness - The ChatHarness instance
+ * @param visible - Expected visibility state
+ * @param timeout - Maximum wait time in milliseconds (default: 5000)
+ */
+declare function waitForEmpty(harness: ChatHarness, visible: boolean, timeout?: number): Promise<void>;
+/**
+ * Waits for the send button to become enabled or disabled.
+ *
+ * @param harness - The ChatHarness instance
+ * @param enabled - Expected enabled state
+ * @param timeout - Maximum wait time in milliseconds (default: 5000)
+ */
+declare function waitForSendEnabled(harness: ChatHarness, enabled: boolean, timeout?: number): Promise<void>;
+
+export { ChatHarness, DEFAULT_POLL_INTERVAL, DEFAULT_WAIT_TIMEOUT, MOCK_SCENARIOS, SAMPLE_AUDIO_ATTACHMENT, SAMPLE_BUTTONS_ACTION, SAMPLE_CONFIRM_ACTION, SAMPLE_FILE_ATTACHMENT, SAMPLE_IMAGE_ATTACHMENT, SAMPLE_MULTI_SELECT_ACTION, SAMPLE_NETWORK_ERROR, SAMPLE_RATE_LIMIT_ERROR, SAMPLE_SELECT_ACTION, SAMPLE_TIMEOUT_ERROR, SAMPLE_VIDEO_ATTACHMENT, generateConversation, generateWithActions, generateWithAttachments, waitForEmpty, waitForLoading, waitForMessages, waitForSendEnabled, waitForTypingIndicator };
+export type { ChatHarnessFilters, ChatMessageData };