@dotcms/types 1.1.1 → 1.2.0-next.10

package/README.md

@@ -1,34 +1,51 @@
-# DotCMS Type Definition Library
+# dotCMS Types Library
+
+The `@dotcms/types` package contains TypeScript type definitions for the dotCMS ecosystem. Use it to enable type safety and an enhanced developer experience when working with dotCMS APIs and structured content.
 
 📦 [@dotcms/types on npm](https://www.npmjs.com/package/@dotcms/types)
 🛠️ [View source on GitHub](https://github.com/dotCMS/core/tree/main/core-web/libs/sdk/types)
 
-## Installation
-
-```bash
-npm install @dotcms/types@latest --save-dev
-```
-
-## Overview
-
-This package contains TypeScript type definitions for the dotCMS ecosystem. Use it to enable type safety and an enhanced developer experience when working with dotCMS APIs and structured content.
-
 ## Table of Contents
 
-- [Installation](#installation)
 - [Overview](#overview)
+- [Installation](#installation)
 - [Commonly Used Types](#commonly-used-types)
 - [Type Hierarchy (Jump to Definitions)](#type-hierarchy-jump-to-definitions)
+  - [AI Search](#ai-search)
   - [dotCMS Content & Pages](#dotcms-content--pages)
   - [Universal Visual Editor (UVE)](#universal-visual-editor-uve)
   - [Block Editor](#block-editor)
   - [Client & HTTP](#client--http)
   - [Error Handling](#error-handling)
-- [Type Usage](#type-usage)
+- [Usage Examples](#usage-examples)
   - [Error Type Checking](#error-type-checking)
-- [About](#about)
+- [Support](#support)
+- [Contributing](#contributing)
+- [Licensing](#licensing)
 - [Changelog](#changelog)
 
+## Overview
+
+### When to Use It
+
+- Building TypeScript applications with dotCMS
+- Enabling type safety in your dotCMS integrations
+- Getting better IDE autocomplete and error checking
+- Working with dotCMS Client SDK or other SDK packages
+
+### Key Benefits
+
+- **Type Safety**: Catch errors at compile time instead of runtime
+- **IDE Support**: Rich autocomplete and inline documentation
+- **Better Developer Experience**: Clear interfaces for all dotCMS data structures
+- **Framework Agnostic**: Works with any TypeScript project
+
+## Installation
+
+```bash
+npm install @dotcms/types@latest --save-dev
+```
+
 ## Commonly Used Types
 
 ```ts
@@ -41,12 +58,42 @@ import {
   DotHttpError,
   DotErrorPage,
   DotErrorContent,
-  DotErrorNavigation
+  DotErrorNavigation,
+  DotErrorAISearch,
+  DotCMSAISearchParams,
+  DISTANCE_FUNCTIONS
 } from '@dotcms/types';
 ```
 
 ## Type Hierarchy (Jump to Definitions)
 
+### AI Search
+
+> **⚠️ Experimental:** The AI Search types are experimental and may undergo breaking changes in future releases.
+
+**AI Search Parameters:**
+
+| Type | Description |
+|------|-------------|
+| [DotCMSAISearchParams](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/ai/public.ts#L85) | Complete AI search parameters including query and AI config |
+| [DotCMSAISearchQuery](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/ai/public.ts#L9) | Query parameters (limit, offset, contentType, etc.) |
+| [DotCMSAIConfig](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/ai/public.ts#L50) | AI configuration (threshold, distanceFunction, responseLength) |
+| [DISTANCE_FUNCTIONS](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/ai/public.ts#L103) | Available distance functions for vector similarity |
+
+**AI Search Response:**
+
+| Type | Description |
+|------|-------------|
+| [DotCMSAISearchResponse](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/ai/public.ts#L182) | AI search API response structure |
+| [DotCMSAISearchContentletData](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/ai/public.ts#L213) | Contentlet with AI match information |
+| [DotCMSAISearchMatch](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/ai/public.ts#L195) | Individual match with distance score and extracted text |
+
+**AI Search Errors:**
+
+| Type | Description |
+|------|-------------|
+| [DotErrorAISearch](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/ai/public.ts#L136) | AI Search API specific error with prompt, indexName and params context |
+
 ### dotCMS Content & Pages
 
 **Page:**
@@ -150,8 +197,9 @@ import {
 | [DotErrorPage](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/page/public.ts#L1253) | Page API errors with GraphQL context |
 | [DotErrorContent](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/content/public.ts#L7) | Content API specific error handling |
 | [DotErrorNavigation](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/nav/public.ts#L7) | Navigation API error handling |
+| [DotErrorAISearch](https://github.com/dotCMS/core/blob/main/core-web/libs/sdk/types/src/lib/ai/public.ts#L136) | AI Search API error handling with prompt and params |
 
-## Type Usage
+## Usage Examples
 
 ### Error Type Checking
 
@@ -160,7 +208,8 @@ import {
   DotHttpError,
   DotErrorPage,
   DotErrorContent,
-  DotErrorNavigation
+  DotErrorNavigation,
+  DotErrorAISearch
 } from '@dotcms/types';
 
 // Type-safe error handling
@@ -179,24 +228,63 @@ if (error instanceof DotErrorContent) {
   // Content-specific error context
   console.error(`${error.operation} failed for ${error.contentType}`);
 }
+
+if (error instanceof DotErrorAISearch) {
+  // AI Search-specific error context
+  console.error('AI Search failed for prompt:', error.prompt);
+  console.error('Index name:', error.indexName);
+  console.error('Search params:', error.params);
+}
 ```
 
 > **Note**: For complete implementation examples and usage patterns, see the [@dotcms/client](../client/README.md) package documentation.
 
-## About
+## Support
+
+We offer multiple channels to get help with the dotCMS Types library:
+
+-   **GitHub Issues**: For bug reports and feature requests, please [open an issue](https://github.com/dotCMS/core/issues/new/choose) in the GitHub repository
+-   **Community Forum**: Join our [community discussions](https://community.dotcms.com/) to ask questions and share solutions
+-   **Stack Overflow**: Use the tag `dotcms-types` when posting questions
+-   **Enterprise Support**: Enterprise customers can access premium support through the [dotCMS Support Portal](https://helpdesk.dotcms.com/support/)
+
+When reporting issues, please include:
 
-This package is maintained as part of the [dotCMS core repository](https://github.com/dotCMS/core).
+-   Package version you're using
+-   TypeScript version
+-   Minimal reproduction steps
+-   Expected vs. actual behavior
 
-### Keywords
+## Contributing
 
-* dotcms
-* typescript
-* types
-* cms
-* content-management-system
+GitHub pull requests are the preferred method to contribute code to dotCMS. We welcome contributions to the dotCMS Types library! If you'd like to contribute, please follow these steps:
+
+1. Fork the repository [dotCMS/core](https://github.com/dotCMS/core)
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+Please ensure your code follows the existing style and includes appropriate tests.
 
 ## Changelog
 
+### [1.3.0]
+
+#### ✨ Added - AI Search Types (Experimental)
+
+> **⚠️ Experimental:** AI Search types are experimental and may undergo breaking changes in future releases.
+
+**New AI Search Types:**
+- `DotCMSAISearchParams` - Complete AI search parameters including query and AI config
+- `DotCMSAISearchQuery` - Query parameters (limit, offset, contentType, etc.)
+- `DotCMSAIConfig` - AI configuration (threshold, distanceFunction, responseLength)
+- `DotCMSAISearchResponse<T>` - AI search API response structure
+- `DotCMSAISearchContentletData<T>` - Contentlet with AI match information
+- `DotCMSAISearchMatch` - Individual match with distance score and extracted text
+- `DotErrorAISearch` - AI Search API specific error with prompt, indexName, and params context
+- `DISTANCE_FUNCTIONS` - Available distance functions for vector similarity (cosine, L2, inner product, etc.)
+
 ### [1.1.1]
 
 #### Added
@@ -214,3 +302,9 @@ This package is maintained as part of the [dotCMS core repository](https://githu
 - Renamed `RequestOptions` to `DotRequestOptions` for better naming consistency
 - Renamed `DotCMSGraphQLPageResponse` to `DotGraphQLApiResponse` for clarity
 - Enhanced `DotCMSClientConfig` to support custom `httpClient` implementations
+
+## Licensing
+
+dotCMS comes in multiple editions and as such is dual-licensed. The dotCMS Community Edition is licensed under the GPL 3.0 and is freely available for download, customization, and deployment for use within organizations of all stripes. dotCMS Enterprise Editions (EE) adds several enterprise features and is available via a supported, indemnified commercial license from dotCMS. For the differences between the editions, see [the feature page](http://www.dotcms.com/cms-platform/features).
+
+This package is part of dotCMS's dual-licensed platform (GPL 3.0 for Community, commercial license for Enterprise).

package/index.cjs.js

@@ -1,5 +1,12 @@
 'use strict';
 
+const DotCMSEntityState = {
+  IDLE: 'IDLE',
+  LOADING: 'LOADING',
+  SUCCESS: 'SUCCESS',
+  ERROR: 'ERROR'
+};
+
 /**
  * Development mode
  *
@@ -248,6 +255,11 @@ class DotHttpError extends Error {
  * ```
  */
 class BaseHttpClient {
+  //  This is my proposal to add this method to the class. We will need to stream data on AI Gen/Chat
+  // abstract requestStream(
+  //     url: string,
+  //     options?: DotRequestOptions
+  // ): Promise<{ body: ReadableStream<BufferSource>; contentLength: number }>;
   /**
    * Creates a standardized HttpError from HTTP response details.
    * Handles parsing of error response body automatically.
@@ -356,8 +368,81 @@ class DotErrorNavigation extends Error {
   }
 }
 
+/**
+ * The distance functions for the search results.
+ * @public
+ * @constant DISTANCE_FUNCTIONS
+ */
+const DISTANCE_FUNCTIONS = {
+  /**
+   * The L2 distance function.
+   * @constant L2 - The L2 distance function.
+   */
+  L2: '<->',
+  /**
+   * The inner product distance function.
+   * @constant innerProduct - The inner product distance function.
+   */
+  innerProduct: '<#>',
+  cosine: '<=>',
+  /**
+   * The L1 distance function.
+   * @constant L1 - The L1 distance function.
+   */
+  L1: '<+>',
+  /**
+   * The hamming distance function.
+   * @constant hamming - The hamming distance function.
+   */
+  hamming: '<~>',
+  /**
+   * The jaccard distance function.
+   * @constant jaccard - The jaccard distance function.
+   */
+  jaccard: '<%>'
+};
+/**
+ * AI Search API specific error class
+ * Wraps HTTP errors and adds AI search-specific context including query information
+ */
+class DotErrorAISearch extends Error {
+  constructor({
+    message,
+    httpError,
+    prompt,
+    params,
+    indexName
+  }) {
+    super(message);
+    this.name = 'DotCMAISearchError';
+    this.httpError = httpError;
+    this.prompt = prompt;
+    this.params = params;
+    this.indexName = indexName;
+    // Ensure proper prototype chain for instanceof checks
+    Object.setPrototypeOf(this, DotErrorAISearch.prototype);
+  }
+  /**
+   * Serializes the error to a plain object for logging or transmission
+   */
+  toJSON() {
+    return {
+      name: this.name,
+      message: this.message,
+      httpError: this.httpError?.toJSON(),
+      prompt: this.prompt,
+      params: this.params,
+      indexName: this.indexName,
+      stack: this.stack
+    };
+  }
+}
+
 exports.BaseHttpClient = BaseHttpClient;
 exports.DEVELOPMENT_MODE = DEVELOPMENT_MODE;
+exports.DISTANCE_FUNCTIONS = DISTANCE_FUNCTIONS;
+exports.DotCMSEntityState = DotCMSEntityState;
+exports.DotErrorAISearch = DotErrorAISearch;
 exports.DotErrorContent = DotErrorContent;
 exports.DotErrorNavigation = DotErrorNavigation;
 exports.DotErrorPage = DotErrorPage;

package/index.esm.js

@@ -1,3 +1,10 @@
+const DotCMSEntityState = {
+  IDLE: 'IDLE',
+  LOADING: 'LOADING',
+  SUCCESS: 'SUCCESS',
+  ERROR: 'ERROR'
+};
+
 /**
  * Development mode
  *
@@ -246,6 +253,11 @@ class DotHttpError extends Error {
  * ```
  */
 class BaseHttpClient {
+  //  This is my proposal to add this method to the class. We will need to stream data on AI Gen/Chat
+  // abstract requestStream(
+  //     url: string,
+  //     options?: DotRequestOptions
+  // ): Promise<{ body: ReadableStream<BufferSource>; contentLength: number }>;
   /**
    * Creates a standardized HttpError from HTTP response details.
    * Handles parsing of error response body automatically.
@@ -354,4 +366,74 @@ class DotErrorNavigation extends Error {
   }
 }
 
-export { BaseHttpClient, DEVELOPMENT_MODE, DotCMSUVEAction, DotErrorContent, DotErrorNavigation, DotErrorPage, DotHttpError, PRODUCTION_MODE, UVEEventType, UVE_MODE };
+/**
+ * The distance functions for the search results.
+ * @public
+ * @constant DISTANCE_FUNCTIONS
+ */
+const DISTANCE_FUNCTIONS = {
+  /**
+   * The L2 distance function.
+   * @constant L2 - The L2 distance function.
+   */
+  L2: '<->',
+  /**
+   * The inner product distance function.
+   * @constant innerProduct - The inner product distance function.
+   */
+  innerProduct: '<#>',
+  cosine: '<=>',
+  /**
+   * The L1 distance function.
+   * @constant L1 - The L1 distance function.
+   */
+  L1: '<+>',
+  /**
+   * The hamming distance function.
+   * @constant hamming - The hamming distance function.
+   */
+  hamming: '<~>',
+  /**
+   * The jaccard distance function.
+   * @constant jaccard - The jaccard distance function.
+   */
+  jaccard: '<%>'
+};
+/**
+ * AI Search API specific error class
+ * Wraps HTTP errors and adds AI search-specific context including query information
+ */
+class DotErrorAISearch extends Error {
+  constructor({
+    message,
+    httpError,
+    prompt,
+    params,
+    indexName
+  }) {
+    super(message);
+    this.name = 'DotCMAISearchError';
+    this.httpError = httpError;
+    this.prompt = prompt;
+    this.params = params;
+    this.indexName = indexName;
+    // Ensure proper prototype chain for instanceof checks
+    Object.setPrototypeOf(this, DotErrorAISearch.prototype);
+  }
+  /**
+   * Serializes the error to a plain object for logging or transmission
+   */
+  toJSON() {
+    return {
+      name: this.name,
+      message: this.message,
+      httpError: this.httpError?.toJSON(),
+      prompt: this.prompt,
+      params: this.params,
+      indexName: this.indexName,
+      stack: this.stack
+    };
+  }
+}
+
+export { BaseHttpClient, DEVELOPMENT_MODE, DISTANCE_FUNCTIONS, DotCMSEntityState, DotCMSUVEAction, DotErrorAISearch, DotErrorContent, DotErrorNavigation, DotErrorPage, DotHttpError, PRODUCTION_MODE, UVEEventType, UVE_MODE };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/types",
-  "version": "1.1.1",
+  "version": "1.2.0-next.10",
   "keywords": [
     "dotCMS",
     "CMS",
@@ -36,4 +36,4 @@
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
   "types": "./index.esm.d.ts"
-}
+}

package/src/index.d.ts

@@ -1,7 +1,9 @@
 export * from './lib/components/block-editor-renderer/public';
+export * from './lib/components/generic/public';
 export * from './lib/editor/public';
 export * from './lib/events/public';
 export * from './lib/page/public';
 export * from './lib/client/public';
 export * from './lib/content/public';
 export * from './lib/nav/public';
+export * from './lib/ai/public';

package/src/internal.d.ts

@@ -1,3 +1,4 @@
 export * from './lib/components/block-editor-renderer/internal';
 export * from './lib/events/internal';
 export * from './lib/editor/internal';
+export * from './lib/ai/internal';

package/src/lib/ai/internal.d.ts

@@ -0,0 +1,55 @@
+import { DISTANCE_FUNCTIONS, DotCMSAISearchContentletData } from './public';
+import { DotCMSBasicContentlet } from '../page/public';
+/**
+ * The raw response from the AI search.
+ *
+ * @export
+ * @interface DotCMSAISearchRawResponse
+ */
+export interface DotCMSAISearchRawResponse<T extends DotCMSBasicContentlet> {
+    /**
+     * The time to embeddings.
+     * @property {number} timeToEmbeddings - The time to embeddings.
+     */
+    timeToEmbeddings: number;
+    /**
+     * The total number of results.
+     * @property {number} total - The total number of results.
+     */
+    total: number;
+    /**
+     * The query that was used to search.
+     * @property {string} query - The query.
+     */
+    query: string;
+    /**
+     * The threshold that was used to calculate the distance.
+     * @property {number} threshold - The threshold.
+     */
+    threshold: number;
+    /**
+     * The operator that was used to calculate the distance.
+     * @property {(typeof DISTANCE_FUNCTIONS)[keyof typeof DISTANCE_FUNCTIONS]} operator - The operator.
+     */
+    operator: (typeof DISTANCE_FUNCTIONS)[keyof typeof DISTANCE_FUNCTIONS];
+    /**
+     * The offset of the results.
+     * @property {number} offset - The offset.
+     */
+    offset: number;
+    /**
+     * The limit of the results.
+     * @property {number} limit - The limit.
+     */
+    limit: number;
+    /**
+     * The count of the results.
+     * @property {number} count - The count.
+     */
+    count: number;
+    /**
+     * The dotCMS results.
+     * @property {DotCMSAISearchContentletData<T>[]} dotCMSResults - The dotCMS results.
+     */
+    dotCMSResults: DotCMSAISearchContentletData<T>[];
+}

package/src/lib/ai/public.d.ts

@@ -0,0 +1,198 @@
+import { DotCMSAISearchRawResponse } from './internal';
+import { DotHttpError } from '../client/public';
+import { DotCMSBasicContentlet } from '../page/public';
+/**
+ * Query parameters for AI search - defines what and where to search
+ * @public
+ * @interface DotCMSAISearchQuery
+ */
+export interface DotCMSAISearchQuery {
+    /**
+     * The limit of the search results.
+     * @property {number} limit - The limit of the search results.
+     * @default 1000
+     */
+    limit?: number;
+    /**
+     * The offset of the search results.
+     * @property {number} offset - The offset of the search results.
+     * @default 0
+     */
+    offset?: number;
+    /**
+     * The site identifier.
+     * @property {string} siteId - The site identifier.
+     */
+    siteId?: string;
+    /**
+     * The content type you want to search for.
+     * @property {string} contentType - The content type you want to search for.
+     */
+    contentType?: string;
+    /**
+     * The language id to search in.
+     * @property {number | string} languageId - The language id to search in.
+     */
+    languageId?: number | string;
+}
+/**
+ * AI configuration parameters - controls how AI processes the results
+ * @public
+ * @interface DotCMSAIConfig
+ */
+export interface DotCMSAIConfig {
+    /**
+     * The threshold for the search results.
+     * @property {number} threshold - The threshold for the search results.
+     * @default 0.5
+     */
+    threshold?: number;
+    /**
+     * The distance function for the search results.
+     * Possible values:
+     *
+     * - <-> - L2 distance
+     * - <#> - (negative) inner product
+     * - <=> - cosine distance
+     * - <+> - L1 distance
+     * - <~> - Hamming distance (binary vectors)
+     * - <%> - Jaccard distance (binary vectors)
+     * @default DISTANCE_FUNCTIONS.cosine
+     * @see {@link https://platform.openai.com/docs/guides/embeddings/which-distance-function-should-i-use#which-distance-function-should-i-use} - OpenAI documentation for the distance functions
+     * @property {string} distanceFunction - The distance function for the search results.
+     */
+    distanceFunction?: (typeof DISTANCE_FUNCTIONS)[keyof typeof DISTANCE_FUNCTIONS];
+    /**
+     * The length of the response.
+     * @property {number} responseLength - The length of the response.
+     * @default 1024
+     */
+    responseLength?: number;
+}
+/**
+ * Parameters for making an AI search request to DotCMS.
+ * @public
+ * @interface DotCMSAISearchParams
+ */
+export interface DotCMSAISearchParams {
+    /**
+     * Query parameters defining what and where to search.
+     * @property {DotCMSAISearchQuery} query - The search query parameters.
+     */
+    query?: DotCMSAISearchQuery;
+    /**
+     * AI configuration parameters controlling how results are processed.
+     * @property {DotCMSAIConfig} config - The AI configuration parameters.
+     */
+    config?: DotCMSAIConfig;
+}
+/**
+ * The distance functions for the search results.
+ * @public
+ * @constant DISTANCE_FUNCTIONS
+ */
+export declare const DISTANCE_FUNCTIONS: {
+    /**
+     * The L2 distance function.
+     * @constant L2 - The L2 distance function.
+     */
+    readonly L2: "<->";
+    /**
+     * The inner product distance function.
+     * @constant innerProduct - The inner product distance function.
+     */
+    readonly innerProduct: "<#>";
+    readonly cosine: "<=>";
+    /**
+     * The L1 distance function.
+     * @constant L1 - The L1 distance function.
+     */
+    readonly L1: "<+>";
+    /**
+     * The hamming distance function.
+     * @constant hamming - The hamming distance function.
+     */
+    readonly hamming: "<~>";
+    /**
+     * The jaccard distance function.
+     * @constant jaccard - The jaccard distance function.
+     */
+    readonly jaccard: "<%>";
+};
+/**
+ * AI Search API specific error class
+ * Wraps HTTP errors and adds AI search-specific context including query information
+ */
+export declare class DotErrorAISearch extends Error {
+    readonly httpError?: DotHttpError;
+    readonly prompt?: string;
+    readonly params?: DotCMSAISearchParams;
+    readonly indexName?: string;
+    constructor({ message, httpError, prompt, params, indexName }: {
+        message: string;
+        httpError?: DotHttpError;
+        prompt?: string;
+        params?: DotCMSAISearchParams;
+        indexName?: string;
+    });
+    /**
+     * Serializes the error to a plain object for logging or transmission
+     */
+    toJSON(): {
+        name: string;
+        message: string;
+        httpError: {
+            name: string;
+            message: string;
+            status: number;
+            statusText: string;
+            data: unknown;
+            stack: string | undefined;
+        } | undefined;
+        prompt: string | undefined;
+        params: DotCMSAISearchParams | undefined;
+        indexName: string | undefined;
+        stack: string | undefined;
+    };
+}
+/**
+ * The response from the AI search.
+ * @public
+ * @interface DotCMSAISearchResponse
+ */
+export interface DotCMSAISearchResponse<T extends DotCMSBasicContentlet> extends Omit<DotCMSAISearchRawResponse<T>, 'dotCMSResults'> {
+    /**
+     * The results from the AI search.
+     * @property {DotCMSAISearchContentletData<T>[]} results - The results from the AI search.
+     */
+    results: DotCMSAISearchContentletData<T>[];
+}
+/**
+ * The match from the AI search.
+ * @public
+ * @interface DotCMSAISearchMatch
+ */
+export interface DotCMSAISearchMatch {
+    /**
+     * The distance from the AI search.
+     * @property {number} distance - The distance from the AI search.
+     */
+    distance: number;
+    /**
+     * The extracted text from the AI search.
+     * @property {string} extractedText - The extracted text from the AI search.
+     */
+    extractedText: string;
+}
+/**
+ * The contentlet data from the AI search.
+ * @public
+ * @interface DotCMSAISearchContentletData
+ */
+export type DotCMSAISearchContentletData<T extends DotCMSBasicContentlet> = T & {
+    /**
+     * The matches from the AI search.
+     * @property {DotCMSAISearchMatch[]} matches - The matches from the AI search.
+     */
+    matches?: DotCMSAISearchMatch[];
+};

package/src/lib/components/block-editor-renderer/public.d.ts

@@ -9,7 +9,7 @@ export interface BlockEditorMark {
     attrs: Record<string, string>;
 }
 /**
- * Represents a Content Node used by the Block Editor
+ * Represents a Node in the Block Editor
  *
  * @export
  * @interface BlockEditorNode
@@ -26,13 +26,3 @@ export interface BlockEditorNode {
     /** Optional text content */
     text?: string;
 }
-/**
- * Represents a Block in the Block Editor
- *
- * @export
- * @interface BlockEditorContent
- */
-export interface BlockEditorContent {
-    content?: BlockEditorNode[];
-    type: string;
-}

package/src/lib/components/generic/public.d.ts

@@ -0,0 +1,16 @@
+export declare const DotCMSEntityState: {
+    readonly IDLE: "IDLE";
+    readonly LOADING: "LOADING";
+    readonly SUCCESS: "SUCCESS";
+    readonly ERROR: "ERROR";
+};
+export type DotCMSEntityStatus = {
+    state: typeof DotCMSEntityState.IDLE;
+} | {
+    state: typeof DotCMSEntityState.LOADING;
+} | {
+    state: typeof DotCMSEntityState.SUCCESS;
+} | {
+    state: typeof DotCMSEntityState.ERROR;
+    error: Error;
+};

package/src/lib/editor/internal.d.ts

@@ -100,4 +100,23 @@ export interface DotContentletAttributes {
     'data-dot-container': string;
     'data-dot-on-number-of-pages': string;
 }
+/**
+ * Helper type to create analytics attribute names with the correct prefix
+ * @internal
+ */
+type AnalyticsAttribute<T extends string> = `data-dot-analytics-${T}`;
+/**
+ * Analytics attribute keys
+ * @internal
+ */
+type AnalyticsAttributeKey = 'identifier' | 'inode' | 'basetype' | 'contenttype' | 'title';
+/**
+ * Interface representing the analytics data attributes of a DotCMS contentlet.
+ * Guarantees all keys have the 'data-dot-analytics-' prefix.
+ * Includes a class for fast DOM selection.
+ * @interface DotAnalyticsAttributes
+ */
+export type DotAnalyticsAttributes = {
+    [K in AnalyticsAttributeKey as AnalyticsAttribute<K>]: string;
+};
 export {};