@dotcms/types 1.2.0-next.5 → 1.2.0-next.6

package/index.cjs.js

@@ -1,5 +1,12 @@
 'use strict';
 
+const DotCMSEntityState = {
+  IDLE: 'IDLE',
+  LOADING: 'LOADING',
+  SUCCESS: 'SUCCESS',
+  ERROR: 'ERROR'
+};
+
 /**
  * Development mode
  *
@@ -434,6 +441,7 @@ class DotErrorAISearch extends Error {
 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;

package/index.esm.js

@@ -1,3 +1,10 @@
+const DotCMSEntityState = {
+  IDLE: 'IDLE',
+  LOADING: 'LOADING',
+  SUCCESS: 'SUCCESS',
+  ERROR: 'ERROR'
+};
+
 /**
  * Development mode
  *
@@ -429,4 +436,4 @@ class DotErrorAISearch extends Error {
   }
 }
 
-export { BaseHttpClient, DEVELOPMENT_MODE, DISTANCE_FUNCTIONS, DotCMSUVEAction, DotErrorAISearch, DotErrorContent, DotErrorNavigation, DotErrorPage, DotHttpError, PRODUCTION_MODE, UVEEventType, UVE_MODE };
+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.2.0-next.5",
+  "version": "1.2.0-next.6",
   "keywords": [
     "dotCMS",
     "CMS",

package/src/index.d.ts

@@ -1,4 +1,5 @@
 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';

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

@@ -1,3 +1,4 @@
+import { DotCMSAISearchRawResponse } from './internal';
 import { DotHttpError } from '../client/public';
 import { DotCMSBasicContentlet } from '../page/public';
 /**
@@ -159,12 +160,12 @@ export declare class DotErrorAISearch extends Error {
  * @public
  * @interface DotCMSAISearchResponse
  */
-export interface DotCMSAISearchResponse<T extends DotCMSBasicContentlet> {
+export interface DotCMSAISearchResponse<T extends DotCMSBasicContentlet> extends Omit<DotCMSAISearchRawResponse<T>, 'dotCMSResults'> {
     /**
      * The results from the AI search.
-     * @property {DotCMSAISearchContentletData<T>[]} dotCMSResults - The results from the AI search.
+     * @property {DotCMSAISearchContentletData<T>[]} results - The results from the AI search.
      */
-    dotCMSResults: DotCMSAISearchContentletData<T>[];
+    results: DotCMSAISearchContentletData<T>[];
 }
 /**
  * The match from the AI search.

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;
+};