@coveo/headless 3.30.0-pre.8837ba3c8d → 3.30.0-pre.8bfbf841d4

package/dist/cjs/recommendation/headless.cjs

@@ -881,7 +881,7 @@ var validateObject = (engine, schema, obj, validationMessage, errorMessage) => {
 };
 
 // src/utils/version.ts
-var VERSION = "3.30.0-pre.8837ba3c8d";
+var VERSION = "3.30.0-pre.8bfbf841d4";
 var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
 
 // src/features/configuration/configuration-actions.ts

package/dist/cjs/ssr/headless.cjs

@@ -1306,7 +1306,7 @@ var import_toolkit2 = require("@reduxjs/toolkit");
 var import_toolkit = require("@reduxjs/toolkit");
 
 // src/utils/version.ts
-var VERSION = "3.30.0-pre.8837ba3c8d";
+var VERSION = "3.30.0-pre.8bfbf841d4";
 var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
 
 // src/api/analytics/analytics-selectors.ts

package/dist/cjs/ssr-commerce/headless.cjs

@@ -468,7 +468,7 @@ var import_bueno8 = require("@coveo/bueno");
 var import_toolkit3 = require("@reduxjs/toolkit");
 
 // src/utils/version.ts
-var VERSION = "3.30.0-pre.8837ba3c8d";
+var VERSION = "3.30.0-pre.8bfbf841d4";
 var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
 
 // src/features/configuration/configuration-actions.ts

package/dist/cjs/ssr-commerce-next/headless.cjs

@@ -467,7 +467,7 @@ var import_bueno8 = require("@coveo/bueno");
 var import_toolkit3 = require("@reduxjs/toolkit");
 
 // src/utils/version.ts
-var VERSION = "3.30.0-pre.8837ba3c8d";
+var VERSION = "3.30.0-pre.8bfbf841d4";
 var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
 
 // src/features/configuration/configuration-actions.ts

package/dist/cjs/ssr-next/headless.cjs

@@ -1306,7 +1306,7 @@ var import_toolkit2 = require("@reduxjs/toolkit");
 var import_toolkit = require("@reduxjs/toolkit");
 
 // src/utils/version.ts
-var VERSION = "3.30.0-pre.8837ba3c8d";
+var VERSION = "3.30.0-pre.8bfbf841d4";
 var COVEO_FRAMEWORK = ["@coveo/atomic", "@coveo/quantic"];
 
 // src/api/analytics/analytics-selectors.ts

package/dist/definitions/features/attached-results/attached-results-actions-loader.d.ts

@@ -2,7 +2,6 @@ import type { PayloadAction } from '@reduxjs/toolkit';
 import type { InsightEngine } from '../../app/insight-engine/insight-engine.js';
 import { type SetAttachedResultsActionCreatorPayload } from './attached-results-actions.js';
 import type { AttachedResult } from './attached-results-state.js';
-export type { SetAttachedResultsActionCreatorPayload, AttachedResult };
 /**
  * The attached results action creators.
  *
@@ -27,6 +26,20 @@ export interface AttachedResultsActionCreators {
      * @returns A dispatchable action.
      */
     setAttachedResults(payload: SetAttachedResultsActionCreatorPayload): PayloadAction<SetAttachedResultsActionCreatorPayload>;
+    /**
+     * Creates an action that attaches a result to a case.
+     *
+     * @param payload - The action creator payload containing the result to attach.
+     * @returns A dispatchable action.
+     */
+    attachResult(payload: AttachedResult): PayloadAction<AttachedResult>;
+    /**
+     * Creates an action that detaches a result from a case.
+     *
+     * @param payload - The action creator payload containing the result to detach.
+     * @returns A dispatchable action.
+     */
+    detachResult(payload: AttachedResult): PayloadAction<AttachedResult>;
 }
 /**
  * Loads the `attachedResults` reducer and returns possible action creators.

package/dist/definitions/features/attached-results/attached-results-actions.d.ts

@@ -9,13 +9,6 @@ export interface SetAttachedResultsActionCreatorPayload {
      */
     loading?: boolean;
 }
-interface SetAttachToCaseAttachActionCreatorPayload {
-    result: AttachedResult;
-}
-interface SetAttachToCaseDetachActionCreatorPayload {
-    result: AttachedResult;
-}
 export declare const setAttachedResults: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetAttachedResultsActionCreatorPayload], SetAttachedResultsActionCreatorPayload, "insight/attachToCase/setAttachedResults", never, never>;
-export declare const attachResult: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetAttachToCaseAttachActionCreatorPayload], SetAttachToCaseAttachActionCreatorPayload | SetAttachToCaseDetachActionCreatorPayload, "insight/attachToCase/attach", never, never>;
-export declare const detachResult: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: SetAttachToCaseDetachActionCreatorPayload], SetAttachToCaseAttachActionCreatorPayload | SetAttachToCaseDetachActionCreatorPayload, "insight/attachToCase/detach", never, never>;
-export {};
+export declare const attachResult: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: AttachedResult], AttachedResult, "insight/attachToCase/attach", never, never>;
+export declare const detachResult: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[payload: AttachedResult], AttachedResult, "insight/attachToCase/detach", never, never>;

package/dist/definitions/features/attached-results/attached-results-analytics-actions-loader.d.ts

@@ -0,0 +1,35 @@
+import type { Result } from '../../api/search/search/result.js';
+import type { InsightEngine } from '../../app/insight-engine/insight-engine.js';
+import type { InsightAction } from '../analytics/analytics-utils.js';
+/**
+ * The attached results action creators.
+ *
+ * @group Actions
+ * @category AttachedResults
+ */
+export interface AttachedResultsAnalyticsActionCreators {
+    /**
+     * Creates an analytics action for when a case attach event occurs.
+     *
+     * @param result - The result to attach.
+     * @returns A dispatchable action.
+     */
+    logCaseAttach(result: Result): InsightAction;
+    /**
+     * Creates an analytics action for when a case detach event occurs.
+     *
+     * @param result - The result to detach.
+     * @returns A dispatchable action.
+     */
+    logCaseDetach(result: Result): InsightAction;
+}
+/**
+ * Loads the `attachedResults` reducer and returns possible analytics action creators.
+ *
+ * @param engine - The headless engine.
+ * @returns An object holding the analytics action creators.
+ *
+ * @group Actions
+ * @category AttachedResults
+ */
+export declare function loadAttachedResultsAnalyticsActions(engine: InsightEngine): AttachedResultsAnalyticsActionCreators;

package/dist/definitions/insight.index.d.ts

@@ -92,6 +92,7 @@ export { buildInsightInterface } from './controllers/insight-interface/insight-i
 export * from './features/analytics/generic-analytics-actions-loader.js';
 export * from './features/analytics/insight-analytics-actions-loader.js';
 export * from './features/attached-results/attached-results-actions-loader.js';
+export * from './features/attached-results/attached-results-analytics-actions-loader.js';
 export * from './features/case-context/case-context-actions-loader.js';
 export * from './features/context/context-actions-loader.js';
 export type { CategoryFacetSortCriterion, CategoryFacetValueRequest, } from './features/facets/category-facet-set/interfaces/request.js';

package/dist/esm/controllers/insight/attach-to-case/headless-attach-to-case.js

@@ -49,15 +49,11 @@ export function buildAttachToCase(engine, props) {
             return isResultAttached();
         },
         attach() {
-            dispatch(attachResult({
-                result: buildAttachedResultFromSearchResult(result, caseId),
-            }));
+            dispatch(attachResult(buildAttachedResultFromSearchResult(result, caseId)));
             dispatch(logCaseAttach(result));
         },
         detach() {
-            dispatch(detachResult({
-                result: buildAttachedResultFromSearchResult(result, caseId),
-            }));
+            dispatch(detachResult(buildAttachedResultFromSearchResult(result, caseId)));
             dispatch(logCaseDetach(result));
         },
     };

package/dist/esm/features/attached-results/attached-results-actions-loader.js

@@ -1,5 +1,5 @@
-import { attachedResultsReducer as attachedResults } from '../../features/attached-results/attached-results-slice.js';
-import { setAttachedResults, } from './attached-results-actions.js';
+import { attachResult, detachResult, setAttachedResults, } from './attached-results-actions.js';
+import { attachedResultsReducer as attachedResults } from './attached-results-slice.js';
 /**
  * Loads the `attachedResults` reducer and returns possible action creators.
  *
@@ -13,5 +13,7 @@ export function loadAttachedResultsActions(engine) {
     engine.addReducers({ attachedResults });
     return {
         setAttachedResults,
+        detachResult,
+        attachResult,
     };
 }

package/dist/esm/features/attached-results/attached-results-actions.js

@@ -1,23 +1,24 @@
 import { ArrayValue, BooleanValue, isNullOrUndefined, RecordValue, SchemaValidationError, } from '@coveo/bueno';
 import { createAction } from '@reduxjs/toolkit';
 import { nonEmptyString, requiredNonEmptyString, serializeSchemaValidationError, validatePayload, } from '../../utils/validate-payload.js';
+const attachedResultPayloadDefinition = {
+    articleLanguage: nonEmptyString,
+    articlePublishStatus: nonEmptyString,
+    articleVersionNumber: nonEmptyString,
+    caseId: requiredNonEmptyString,
+    knowledgeArticleId: nonEmptyString,
+    name: nonEmptyString,
+    permanentId: nonEmptyString,
+    resultUrl: nonEmptyString,
+    source: nonEmptyString,
+    title: requiredNonEmptyString,
+    uriHash: nonEmptyString,
+};
 const RequiredAttachedResultRecord = new RecordValue({
     options: {
         required: true,
     },
-    values: {
-        articleLanguage: nonEmptyString,
-        articlePublishStatus: nonEmptyString,
-        articleVersionNumber: nonEmptyString,
-        caseId: requiredNonEmptyString,
-        knowledgeArticleId: nonEmptyString,
-        name: nonEmptyString,
-        permanentId: nonEmptyString,
-        resultUrl: nonEmptyString,
-        source: nonEmptyString,
-        title: requiredNonEmptyString,
-        uriHash: nonEmptyString,
-    },
+    values: attachedResultPayloadDefinition,
 });
 export const setAttachedResults = createAction('insight/attachToCase/setAttachedResults', (payload) => validatePayload(payload, {
     results: new ArrayValue({
@@ -31,14 +32,12 @@ export const setAttachedResults = createAction('insight/attachToCase/setAttached
 export const attachResult = createAction('insight/attachToCase/attach', (payload) => validatePayloadAndPermanentIdOrUriHash(payload));
 export const detachResult = createAction('insight/attachToCase/detach', (payload) => validatePayloadAndPermanentIdOrUriHash(payload));
 const validatePayloadAndPermanentIdOrUriHash = (payload) => {
-    if (isNullOrUndefined(payload.result.permanentId) &&
-        isNullOrUndefined(payload.result.uriHash)) {
+    if (isNullOrUndefined(payload.permanentId) &&
+        isNullOrUndefined(payload.uriHash)) {
         return {
             payload,
             error: serializeSchemaValidationError(new SchemaValidationError('Either permanentId or uriHash is required')),
         };
     }
-    return validatePayload(payload, {
-        result: RequiredAttachedResultRecord,
-    });
+    return validatePayload(payload, attachedResultPayloadDefinition);
 };

package/dist/esm/features/attached-results/attached-results-analytics-actions-loader.js

@@ -0,0 +1,18 @@
+import { logCaseAttach, logCaseDetach, } from './attached-results-analytics-actions.js';
+import { attachedResultsReducer as attachedResults } from './attached-results-slice.js';
+/**
+ * Loads the `attachedResults` reducer and returns possible analytics action creators.
+ *
+ * @param engine - The headless engine.
+ * @returns An object holding the analytics action creators.
+ *
+ * @group Actions
+ * @category AttachedResults
+ */
+export function loadAttachedResultsAnalyticsActions(engine) {
+    engine.addReducers({ attachedResults });
+    return {
+        logCaseDetach,
+        logCaseAttach,
+    };
+}

package/dist/esm/features/attached-results/attached-results-slice.js

@@ -15,13 +15,13 @@ export const attachedResultsReducer = createReducer(getAttachedResultsInitialSta
         }
     })
         .addCase(attachResult, (state, action) => {
-        if (!isNullOrUndefined(action.payload.result.permanentId) ||
-            !isNullOrUndefined(action.payload.result.uriHash)) {
-            state.results = [...state.results, action.payload.result];
+        if (!isNullOrUndefined(action.payload.permanentId) ||
+            !isNullOrUndefined(action.payload.uriHash)) {
+            state.results = [...state.results, action.payload];
         }
     })
         .addCase(detachResult, (state, action) => {
-        state.results = state.results.filter((result) => attachedResultsMatchIds(result, action.payload.result));
+        state.results = state.results.filter((result) => attachedResultsMatchIds(result, action.payload));
     });
 });
 const attachedResultsMatchIds = (result1, result2) => {

package/dist/esm/insight.index.js

@@ -50,6 +50,7 @@ export { buildInsightInterface } from './controllers/insight-interface/insight-i
 export * from './features/analytics/generic-analytics-actions-loader.js';
 export * from './features/analytics/insight-analytics-actions-loader.js';
 export * from './features/attached-results/attached-results-actions-loader.js';
+export * from './features/attached-results/attached-results-analytics-actions-loader.js';
 export * from './features/case-context/case-context-actions-loader.js';
 export * from './features/context/context-actions-loader.js';
 export * from './features/facets/range-facets/date-facet-set/date-facet-actions-loader.js';

package/dist/esm/utils/version.js

@@ -1,2 +1,2 @@
-export const VERSION = "3.30.0-pre.8837ba3c8d" || 'Test version';
+export const VERSION = "3.30.0-pre.8bfbf841d4" || 'Test version';
 export const COVEO_FRAMEWORK = ['@coveo/atomic', '@coveo/quantic'];