Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(headless): make ssr-commerce definers public #4929

Merged
merged 1 commit into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ export interface CartDefinition
* @group Definers
*
* @returns The `Cart` controller definition.
*
* @internal
*/
export function defineCart(): CartDefinition {
return {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ export interface ContextDefinition
* @group Definers
*
* @returns The `Context` controller definition.
*
* @internal
*/
export function defineContext(): ContextDefinition {
return {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ export type {BreadcrumbManager, BreadcrumbManagerState};
* @group Definers
*
* @returns The `BreadcrumbManager` controller definition.
*
* @internal
*/
export function defineBreadcrumbManager<
TOptions extends ControllerDefinitionOption | undefined,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,8 +167,6 @@ export interface FacetGeneratorProps {
}

/**
* @internal
*
* Creates a `FacetGenerator` sub-controller for server-side rendering purposes (SSR).
*
* @param engine - The SSR commerce engine.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ export type {Pagination, PaginationProps, PaginationState};
*
* @param props - The configurable `Pagination` properties.
* @returns The `Pagination` controller definition.
*
* @internal
*/
export function definePagination<
TOptions extends ControllerDefinitionOption | undefined,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@ export type {
* @group Definers
*
* @returns The `ParameterManager` controller definition.
*
* @internal
*/
export function defineParameterManager<
TOptions extends ControllerDefinitionOption | undefined,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ export type {Sort, SortProps, SortState};
*
* @param props - The configurable `Sort` properties.
* @returns The `Sort` controller definition.
*
* @internal
*/
export function defineSort<
TOptions extends ControllerDefinitionOption | undefined,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ export type {
* @group Definers
*
* @returns The `Summary` controller definition.
*
* @internal
*/
export function defineSummary<
TOptions extends ControllerDefinitionOption | undefined,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ export interface FieldSuggestionsGeneratorDefinition
* @group Definers
*
* @returns The `FieldSuggestionsGenerator` controller definition.
*
* @internal
*/
export function defineFieldSuggestionsGenerator(): FieldSuggestionsGeneratorDefinition {
return {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ export interface InstantProductsDefinition
* @group Definers
*
* @returns The `InstantProducts` controller definition.
*
* @internal
*/
export function defineInstantProducts(
props: InstantProductsProps = {options: {}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,7 @@ export type ProductList = Pick<
* @group Definers
*
* @returns The `ProductList` controller definition.
*
* @internal
* */
*/
export function defineProductList<
TOptions extends ControllerDefinitionOption | undefined,
>(options?: TOptions) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ export interface ProductViewDefinition
*
* @returns The `ProductView` controller definition.
*
* @internal
* @group Definers
*/
export function defineProductView(): ProductViewDefinition {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ export interface RecentQueriesListDefinition
*
* @param props - The configuration `RecentQueriesList` properties.
* @returns The `RecentQueriesList` controller definition.
*
* @internal
*/
export function defineRecentQueriesList(
props: RecentQueriesListProps = {}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@ import {

export type {Recommendations, RecommendationsState};

/**
* @internal
* */
export type RecommendationsDefinitionMeta = {
[recommendationInternalOptionKey]: {} & RecommendationsProps['options'];
};
Expand All @@ -32,7 +29,6 @@ export interface RecommendationsDefinition
> {}

/**
* @internal
* Defines a `Recommendations` controller instance.
* @group Definers
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ export interface SearchBoxDefinition
* @group Definers
*
* @returns The `SearchBox` controller definition.
*
* @internal
*/
export function defineSearchBox(
props: SearchBoxProps = {}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ export type {DidYouMean, DidYouMeanState};
* @group Definers
*
* @returns The `DidYouMean` controller definition.
*
* @internal
* */
*/
export function defineDidYouMean(): SearchOnlyControllerDefinitionWithoutProps<DidYouMean> {
return {
search: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ export interface StandaloneSearchBoxDefinition
*
* @param props - The configurable `StandaloneSearchBox` properties.
* @returns The `StandaloneSearchBox` controller definition.
*
* @internal
*/
export function defineStandaloneSearchBox(
props: StandaloneSearchBoxProps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ export interface NotifyTriggerDefinition
* @group Definers
*
* @returns The `NotifyTrigger` controller definition.
*
* @internal
*/
export function defineNotifyTrigger(): NotifyTriggerDefinition {
return {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ export interface QueryTriggerDefinition
* @group Definers
*
* @returns The `NotifyTrigger` controller definition.
*
* @internal
*/
export function defineQueryTrigger(): QueryTriggerDefinition {
return {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ export interface RedirectionTriggerDefinition
* @group Definers
*
* @returns The `NotifyTrigger` controller definition.
*
* @internal
*/
export function defineRedirectionTrigger(): RedirectionTriggerDefinition {
return {
Expand Down
Loading