@coveo/atomic 3.34.0-pre.00dc0c9faa → 3.34.0-pre.011ede392f

package/dist/types/decorators/commerce/product-template-decorators.d.ts

@@ -1,68 +0,0 @@
-import type { InteractiveProduct, Product } from '@coveo/headless/commerce';
-import type { LitElement } from 'lit';
-import { InteractiveItemContextController, type InteractiveItemContextEvent } from "../../components/common/item-list/context/interactive-item-context-controller";
-import { ItemContextController, type ItemContextEvent } from "../../components/common/item-list/context/item-context-controller";
-/**
- * Creates a [Lit reactive controller](https://lit.dev/docs/composition/controllers/) for managing product context in product template components.
- *
- * @param host - The Lit component instance
- * @param options - Configuration options
- * @returns ItemContextController instance configured for atomic-product
- *
- * @example
- * ```typescript
- * @customElement('my-product-component')
- * export class MyProductComponent extends LitElement {
- *   private productController = createProductContextController(this);
- *
- *   @state() product!: Product;
- *
- *   render() {
- *     this.product = this.productController.item;
- *     return html`<div>${this.product?.ec_name}</div>`;
- *   }
- * }
- * ```
- */
-export declare function createProductContextController(host: LitElement & {
-    error: Error | null;
-}, options?: {
-    folded?: boolean;
-}): ItemContextController<Product>;
-/**
- * Creates a [Lit reactive controller](https://lit.dev/docs/composition/controllers/) for managing interactive product context in product template components.
- *
- * @param host - The Lit component instance
- * @returns InteractiveItemContextController instance
- *
- * @example
- * ```typescript
- * @customElement('my-interactive-product-component')
- * export class MyInteractiveProductComponent extends LitElement {
- *   private interactiveProductController = createInteractiveProductContextController(this);
- *
- *   @state() product!: Product;
- *
- *   render() {
- *     this.product = this.interactiveProductController.interactiveItem;
- *     return html`<div>${this.product?.ec_name}</div>`;
- *   }
- * }
- * ```
- */
-export declare function createInteractiveProductContextController(host: LitElement & {
-    error: Error;
-}): InteractiveItemContextController<InteractiveProduct>;
-export type ProductContextEvent<T = Product> = ItemContextEvent<T>;
-export type InteractiveProductContextEvent<T extends InteractiveProduct = InteractiveProduct> = InteractiveItemContextEvent<T>;
-/**
- * Retrieves `Product` on a rendered `atomic-product`.
- *
- * This utility function is useful for building custom product template elements, see [Create a Product List](https://docs.coveo.com/en/atomic/latest/cc-search/create-custom-components/native-components/#custom-product-template-component-example) for more information.
- *
- * You should use the utility function in the [`connectedCallback` lifecycle method](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements#using_the_lifecycle_callbacks).
- *
- * @param element - The element that the event is dispatched to, which must be the child of a rendered `atomic-product`.
- * @returns A promise that resolves on initialization of the parent `atomic-product` element, or rejects when there is no parent `atomic-product` element.
- */
-export declare function fetchProductContext<T extends Product>(element: Element): Promise<T>;