@coveo/atomic 3.50.0 → 3.52.0

package/dist/types/components/search/result-template-component-utils/context/stencil-result-template-decorators.d.ts

@@ -1,32 +0,0 @@
-import { FoldedResult, Result } from '@coveo/headless';
-import { InteractiveItemContextEvent, ItemContextEvent } from "../../../common/item-list/stencil-item-decorators";
-/**
- * A [StencilJS property decorator](https://stenciljs.com/) to be used for result template components.
- * This allows the Stencil component to fetch the current result from its rendered parent, the `atomic-result` component.
- *
- * Example:
- * @ResultContext() private result!: Result;
- *
- * For more information and examples, view the "Utilities" section of the readme.
- *
- * @deprecated should only be used for Stencil components. For Lit components, use `createResultContextController` from \@/src/components/search/result-template-component-utils/context/result-context-controller.ts
- */
-export declare function ResultContext(opts?: {
-    folded: boolean;
-}): (component: import("@stencil/core").ComponentInterface, itemVariable: string) => void;
-export declare function InteractiveResultContext(): (component: import("@stencil/core").ComponentInterface, interactiveItemVariable: string) => void;
-export type ResultContextEvent<T = Result> = ItemContextEvent<T>;
-export type InteractiveResultContextEvent = InteractiveItemContextEvent;
-/**
- * Retrieves `Result` on a rendered `atomic-result`.
- *
- * This method is useful for building custom result template elements, see [Create a Result List](https://docs.coveo.com/en/atomic/latest/cc-search/create-custom-components/native-components/#custom-result-template-component-example) for more information.
- *
- * You should use the method 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-result" element.
- * @returns A promise that resolves on initialization of the parent "atomic-result" element, or rejects when there is no parent "atomic-result" element.
- *
- * @deprecated should only be used for Stencil components. For Lit components, use `fetchResultContext` from \@/src/components/search/result-template-component-utils/context/fetch-result-context.ts
- */
-export declare function resultContext<T extends Result | FoldedResult = Result>(element: Element): Promise<T>;

package/dist/types/components/search/result-template-components/quickview-iframe/stencil-quickview-iframe.d.ts

@@ -1,14 +0,0 @@
-import { SearchEngine } from '@coveo/headless';
-import { FunctionalComponent } from '../../../../stencil-public-runtime';
-/**
- * @deprecated should only be used for Stencil components.
- */
-export declare const QuickviewIframe: FunctionalComponent<{
-    title: string;
-    content?: string;
-    onSetIframeRef: (ref: HTMLIFrameElement) => void;
-    uniqueIdentifier?: string;
-    sandbox?: string;
-    src?: string;
-    logger?: SearchEngine['logger'];
-}>;

package/dist/types/utils/__mocks__/stencil-resource-url.d.ts

@@ -1 +0,0 @@
-export declare const getResourceUrl: () => undefined;

package/dist/types/utils/initialization-utils.d.ts

@@ -1,70 +0,0 @@
-import { ComponentInterface } from '../stencil-public-runtime';
-import { TOptions } from 'i18next';
-import { AnyBindings } from '../components/common/interface/bindings';
-import { Bindings } from '../components/search/atomic-search-interface/atomic-search-interface';
-import { InitializeEventHandler } from './initialization-lit-stencil-common-utils';
-export type InitializeEvent = CustomEvent<InitializeEventHandler>;
-/**
- * Retrieves `Bindings` or `CommerceBindings` on a configured parent interface.
- * @param event - The element on which to dispatch the event, which must be the child of a configured Atomic container element.
- * @returns A promise that resolves upon initialization of the parent container element, and rejects otherwise.
- */
-export declare function initializeBindings<SpecificBindings extends AnyBindings = Bindings>(element: Element): Promise<SpecificBindings>;
-export { MissingInterfaceParentError, InitializeEventHandler, initializeEventName, } from './initialization-lit-stencil-common-utils';
-/**
- * Necessary interface an Atomic Component must have to initialize itself correctly.
- * @deprecated To be used for Stencil components. For Lit components. use `InitializableComponent` from './decorators/types/'
- */
-export interface InitializableComponent<SpecificBindings extends AnyBindings = Bindings> extends ComponentInterface {
-    /**
-     * Bindings passed from the `AtomicSearchInterface` to its children components.
-     */
-    bindings: SpecificBindings;
-    /**
-     * Method called right after the `bindings` property is defined. This is the method where Headless Framework controllers should be initialized.
-     */
-    initialize?: () => void;
-    error: Error;
-}
-type InitializeBindingsProps = {
-    forceUpdate?: boolean;
-};
-/**
- * A [StencilJS property decorator](https://stenciljs.com/) to be used on a property named `bindings`.
- * This will automatically fetch the `Bindings` from the parent `atomic-search-interface` or `atomic-external` components.
- *
- * Once a component is bound, the `initialize` method is called.
- * In the event of an initialization error, the `error` property will be set and an `atomic-component-error` will be rendered.
- *
- * In order for a component using this decorator to render properly, it should have an internal state bound to one of the properties from `bindings`.
- * This is possible by using the `BindStateToController` decorator.
- *
- * @example
- * @InitializeBindings() public bindings!: Bindings;
- *
- * For more information and examples, view the "Utilities" section of the readme.
- * @deprecated To be used for Stencil components. For Lit components, use `BindingController` Reactive Controller from @/mixins/bindings-mixin.ts.
- */
-export declare function InitializeBindings<SpecificBindings extends AnyBindings>({ forceUpdate, }?: InitializeBindingsProps): (component: InitializableComponent<SpecificBindings>, bindingsProperty: string) => void;
-/**
- * A [StencilJS property decorator](https://stenciljs.com/) is used together with the [State decorator](https://stenciljs.com/docs/state#state-decorator).
- * This allows the Stencil component state property to automatically get updates from a [Coveo Headless controller](https://docs.coveo.com/en/headless/latest/usage/#use-headless-controllers).
- *
- * @example
- * @BindStateToController('pager') @State() private pagerState!: PagerState;
- *
- * For more information and examples, view the "Utilities" section of the readme.
- *
- * @param controllerProperty The controller property to subscribe to. The controller has to be created inside of the `initialize` method.
- * @param options The configurable `BindStateToController` options.
- *
- * @deprecated To be used for Stencil components. For Lit components. use `bindStateToController` from '../decorators/bind-state.ts'
- */
-export declare function BindStateToController(controllerProperty: string, options?: {
-    /**
-     * Component's method to be called when state is updated.
-     */
-    onUpdateCallbackMethod?: string;
-}): (component: InitializableComponent<AnyBindings>, stateProperty: string) => void;
-export declare function DeferUntilRender(): (component: ComponentInterface, methodName: string) => void;
-export type I18nState = Record<string, (variables?: TOptions) => string>;

package/dist/types/utils/jsx-utils.d.ts

@@ -1,6 +0,0 @@
-import { FunctionalComponent } from '../stencil-public-runtime';
-import { LocalizedStringProps } from '../directives/localized-string';
-/**
- * @deprecated Should only be used for Stencil components; for Lit components, use the localizedString directive instead
- */
-export declare const LocalizedString: FunctionalComponent<LocalizedStringProps>;

package/dist/types/utils/stencil-accessibility-utils.d.ts

@@ -1,43 +0,0 @@
-import { AtomicAriaLive } from '../components/common/atomic-aria-live/atomic-aria-live';
-import { AnyBindings } from '../components/common/interface/bindings';
-import { InitializableComponent } from './initialization-utils';
-/**
- * @deprecated use Lit equivalent
- */
-export interface FindAriaLiveEventArgs {
-    element?: AtomicAriaLive;
-}
-/**
- * @deprecated use Lit equivalent
- */
-export declare function AriaLiveRegion(regionName: string, assertive?: boolean): (component: InitializableComponent<AnyBindings>, setterName: string) => void;
-/**
- * @deprecated use Lit equivalent
- */
-export declare class FocusTargetController {
-    private component;
-    private bindings;
-    private lastSearchId?;
-    private element?;
-    registerFocusCallback: (callback: Function) => void;
-    private internalOnFocusCallback?;
-    private doFocusAfterSearch;
-    private doFocusOnNextTarget;
-    private publicOnFocusCallbacks;
-    constructor(component: InitializableComponent<AnyBindings>);
-    private clearFocusCallbacks;
-    setTarget(el: HTMLElement | undefined): void;
-    focus(): Promise<void>;
-    focusAfterSearch(): Promise<unknown>;
-    focusOnNextTarget(): Promise<unknown>;
-    disableForCurrentSearch(): void;
-    private handleComponentRenderLoop;
-}
-/**
- * @deprecated use Lit equivalent
- */
-export declare function getFocusableDescendants(element: Element): Generator<HTMLElement>;
-/**
- * @deprecated use Lit equivalent
- */
-export declare function getFirstFocusableDescendant(element: Element): HTMLElement | null;

package/dist/types/utils/stencil-asset-path-utils.d.ts

@@ -1 +0,0 @@
-export declare function getAssetPath(path: string): string;

package/dist/types/utils/stencil-resource-url.d.ts

@@ -1 +0,0 @@
-export declare const getResourceUrl: () => string;