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

feat: create loader that returns only suggestions based on the query #981

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
20 changes: 11 additions & 9 deletions konfidency/actions/submitReviews.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@ export interface Props {
review: WriteReview;
}

export default async function action(props: Props, _req: Request, ctx: AppContext): Promise<ResponseWriteReview | null> {

const { customer, api } = ctx
const { review, sku } = props
export default async function action(
props: Props,
_req: Request,
ctx: AppContext,
): Promise<ResponseWriteReview | null> {
const { customer, api } = ctx;
const { review, sku } = props;

try {
const response = await api[`POST /:customer/:sku/review`]({
Expand All @@ -23,13 +26,12 @@ export default async function action(props: Props, _req: Request, ctx: AppContex
body: {
...review,
},
}).then((r) => r.json())
return await response
}).then((r) => r.json());
return await response;
} catch (error) {
const errorObj = error as { name: string; message: string };
logger.error(`{ errorName: ${errorObj.name},
errorMessage: ${errorObj.message} }`);
return null
return null;
}

}
}
24 changes: 13 additions & 11 deletions konfidency/loaders/productDetailsPage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ import { toReview } from "../utils/transform.ts";
import { logger } from "@deco/deco/o11y";
export interface Props {
/**
* @description Rating type, default: helpfulScore
* @default "helpfulScore"
*/
* @description Rating type, default: helpfulScore
* @default "helpfulScore"
*/
sortField?: "helpfulScore" | "created" | "rating";
/**
* @description Default value: asc
Expand All @@ -24,7 +24,8 @@ export interface Props {
page?: number;
}
export default function productDetailsPage(
{ pageSize = 5, page = 1, sortField = "helpfulScore", sortOrder = "asc" }: Props,
{ pageSize = 5, page = 1, sortField = "helpfulScore", sortOrder = "asc" }:
Props,
_req: Request,
ctx: AppContext,
): ExtensionOf<ProductDetailsPage | null> {
Expand All @@ -34,13 +35,14 @@ export default function productDetailsPage(
return null;
}
try {
const reviews = await api["GET /:customer/:sku/summary/:sortField,:sortOrder"]({
customer,
"sortField,:sortOrder": `${sortField},${sortOrder}`,
page,
pageSize,
sku: productDetailsPage.product.inProductGroupWithID as string,
}).then((res) => res.json());
const reviews = await api
["GET /:customer/:sku/summary/:sortField,:sortOrder"]({
customer,
"sortField,:sortOrder": `${sortField},${sortOrder}`,
page,
pageSize,
sku: productDetailsPage.product.inProductGroupWithID as string,
}).then((res) => res.json());
const { aggregateRating, review } = toReview(reviews.reviews[0]);
return {
...productDetailsPage,
Expand Down
2 changes: 1 addition & 1 deletion konfidency/manifest.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
// This file SHOULD be checked into source version control.
// This file is automatically updated during development when running `dev.ts`.

import * as $$$0 from "./loaders/productDetailsPage.ts";
import * as $$$$$$$$$0 from "./actions/submitReviews.ts";
import * as $$$0 from "./loaders/productDetailsPage.ts";

const manifest = {
"loaders": {
Expand Down
6 changes: 3 additions & 3 deletions konfidency/utils/client.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { PDPReview, WriteReview, ResponseWriteReview } from "./types.ts";
import type { PDPReview, ResponseWriteReview, WriteReview } from "./types.ts";

export interface API {
"GET /:customer/:sku/summary/:sortField,:sortOrder": {
Expand All @@ -10,7 +10,7 @@ export interface API {
};

"POST /:customer/:sku/review": {
response: ResponseWriteReview
response: ResponseWriteReview;
body: WriteReview;
}
};
}
28 changes: 14 additions & 14 deletions konfidency/utils/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,17 @@ export interface WriteReview {
}

export interface ResponseWriteReview {
helpful: number;
unhelpful: number;
verified: boolean;
status: string;
_id: string;
created: string;
customer: string;
userId: string;
name: string;
sku: string;
text: string;
recommended: boolean;
rating: number;
}
helpful: number;
unhelpful: number;
verified: boolean;
status: string;
_id: string;
created: string;
customer: string;
userId: string;
name: string;
sku: string;
text: string;
recommended: boolean;
rating: number;
}
29 changes: 29 additions & 0 deletions vtex/loaders/intelligentSearch/searches.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import { Suggestion } from "../../../commerce/types.ts";
import { AppContext } from "../../mod.ts";
import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";

export interface Props {
query?: string;
}

export default async function loader(
{ query }: Props,
_req: Request,
ctx: AppContext,
): Promise<Suggestion> {
const segment = getSegmentFromBag(ctx);
const locale = segment?.payload?.cultureInfo ??
ctx.defaultSegment?.cultureInfo ?? "pt-BR";

return await ctx.vcsDeprecated[
"GET /api/io/_v/api/intelligent-search/search_suggestions"
](
{
locale,
query: query ?? "",
},
{
headers: withSegmentCookie(segment),
},
).then((res) => res.json());
}
126 changes: 64 additions & 62 deletions vtex/manifest.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,37 +35,38 @@ import * as $$$4 from "./loaders/intelligentSearch/productDetailsPage.ts";
import * as $$$5 from "./loaders/intelligentSearch/productList.ts";
import * as $$$6 from "./loaders/intelligentSearch/productListingPage.ts";
import * as $$$7 from "./loaders/intelligentSearch/productSearchValidator.ts";
import * as $$$8 from "./loaders/intelligentSearch/suggestions.ts";
import * as $$$9 from "./loaders/intelligentSearch/topsearches.ts";
import * as $$$10 from "./loaders/legacy/brands.ts";
import * as $$$11 from "./loaders/legacy/pageType.ts";
import * as $$$12 from "./loaders/legacy/productDetailsPage.ts";
import * as $$$13 from "./loaders/legacy/productList.ts";
import * as $$$14 from "./loaders/legacy/productListingPage.ts";
import * as $$$15 from "./loaders/legacy/relatedProductsLoader.ts";
import * as $$$16 from "./loaders/legacy/suggestions.ts";
import * as $$$17 from "./loaders/logistics/getSalesChannelById.ts";
import * as $$$18 from "./loaders/logistics/listPickupPoints.ts";
import * as $$$19 from "./loaders/logistics/listPickupPointsByLocation.ts";
import * as $$$20 from "./loaders/logistics/listSalesChannelById.ts";
import * as $$$21 from "./loaders/logistics/listStockByStore.ts";
import * as $$$22 from "./loaders/masterdata/searchDocuments.ts";
import * as $$$23 from "./loaders/navbar.ts";
import * as $$$24 from "./loaders/options/productIdByTerm.ts";
import * as $$$25 from "./loaders/orders/list.ts";
import * as $$$26 from "./loaders/paths/PDPDefaultPath.ts";
import * as $$$27 from "./loaders/paths/PLPDefaultPath.ts";
import * as $$$28 from "./loaders/product/extend.ts";
import * as $$$29 from "./loaders/product/extensions/detailsPage.ts";
import * as $$$30 from "./loaders/product/extensions/list.ts";
import * as $$$31 from "./loaders/product/extensions/listingPage.ts";
import * as $$$32 from "./loaders/product/extensions/suggestions.ts";
import * as $$$33 from "./loaders/product/wishlist.ts";
import * as $$$34 from "./loaders/proxy.ts";
import * as $$$35 from "./loaders/user.ts";
import * as $$$36 from "./loaders/wishlist.ts";
import * as $$$37 from "./loaders/workflow/product.ts";
import * as $$$38 from "./loaders/workflow/products.ts";
import * as $$$8 from "./loaders/intelligentSearch/searches.ts";
import * as $$$9 from "./loaders/intelligentSearch/suggestions.ts";
import * as $$$10 from "./loaders/intelligentSearch/topsearches.ts";
import * as $$$11 from "./loaders/legacy/brands.ts";
import * as $$$12 from "./loaders/legacy/pageType.ts";
import * as $$$13 from "./loaders/legacy/productDetailsPage.ts";
import * as $$$14 from "./loaders/legacy/productList.ts";
import * as $$$15 from "./loaders/legacy/productListingPage.ts";
import * as $$$16 from "./loaders/legacy/relatedProductsLoader.ts";
import * as $$$17 from "./loaders/legacy/suggestions.ts";
import * as $$$18 from "./loaders/logistics/getSalesChannelById.ts";
import * as $$$19 from "./loaders/logistics/listPickupPoints.ts";
import * as $$$20 from "./loaders/logistics/listPickupPointsByLocation.ts";
import * as $$$21 from "./loaders/logistics/listSalesChannelById.ts";
import * as $$$22 from "./loaders/logistics/listStockByStore.ts";
import * as $$$23 from "./loaders/masterdata/searchDocuments.ts";
import * as $$$24 from "./loaders/navbar.ts";
import * as $$$25 from "./loaders/options/productIdByTerm.ts";
import * as $$$26 from "./loaders/orders/list.ts";
import * as $$$27 from "./loaders/paths/PDPDefaultPath.ts";
import * as $$$28 from "./loaders/paths/PLPDefaultPath.ts";
import * as $$$29 from "./loaders/product/extend.ts";
import * as $$$30 from "./loaders/product/extensions/detailsPage.ts";
import * as $$$31 from "./loaders/product/extensions/list.ts";
import * as $$$32 from "./loaders/product/extensions/listingPage.ts";
import * as $$$33 from "./loaders/product/extensions/suggestions.ts";
import * as $$$34 from "./loaders/product/wishlist.ts";
import * as $$$35 from "./loaders/proxy.ts";
import * as $$$36 from "./loaders/user.ts";
import * as $$$37 from "./loaders/wishlist.ts";
import * as $$$38 from "./loaders/workflow/product.ts";
import * as $$$39 from "./loaders/workflow/products.ts";
import * as $$$$$$0 from "./sections/Analytics/Vtex.tsx";
import * as $$$$$$$$$$0 from "./workflows/events.ts";
import * as $$$$$$$$$$1 from "./workflows/product/index.ts";
Expand All @@ -80,37 +81,38 @@ const manifest = {
"vtex/loaders/intelligentSearch/productList.ts": $$$5,
"vtex/loaders/intelligentSearch/productListingPage.ts": $$$6,
"vtex/loaders/intelligentSearch/productSearchValidator.ts": $$$7,
"vtex/loaders/intelligentSearch/suggestions.ts": $$$8,
"vtex/loaders/intelligentSearch/topsearches.ts": $$$9,
"vtex/loaders/legacy/brands.ts": $$$10,
"vtex/loaders/legacy/pageType.ts": $$$11,
"vtex/loaders/legacy/productDetailsPage.ts": $$$12,
"vtex/loaders/legacy/productList.ts": $$$13,
"vtex/loaders/legacy/productListingPage.ts": $$$14,
"vtex/loaders/legacy/relatedProductsLoader.ts": $$$15,
"vtex/loaders/legacy/suggestions.ts": $$$16,
"vtex/loaders/logistics/getSalesChannelById.ts": $$$17,
"vtex/loaders/logistics/listPickupPoints.ts": $$$18,
"vtex/loaders/logistics/listPickupPointsByLocation.ts": $$$19,
"vtex/loaders/logistics/listSalesChannelById.ts": $$$20,
"vtex/loaders/logistics/listStockByStore.ts": $$$21,
"vtex/loaders/masterdata/searchDocuments.ts": $$$22,
"vtex/loaders/navbar.ts": $$$23,
"vtex/loaders/options/productIdByTerm.ts": $$$24,
"vtex/loaders/orders/list.ts": $$$25,
"vtex/loaders/paths/PDPDefaultPath.ts": $$$26,
"vtex/loaders/paths/PLPDefaultPath.ts": $$$27,
"vtex/loaders/product/extend.ts": $$$28,
"vtex/loaders/product/extensions/detailsPage.ts": $$$29,
"vtex/loaders/product/extensions/list.ts": $$$30,
"vtex/loaders/product/extensions/listingPage.ts": $$$31,
"vtex/loaders/product/extensions/suggestions.ts": $$$32,
"vtex/loaders/product/wishlist.ts": $$$33,
"vtex/loaders/proxy.ts": $$$34,
"vtex/loaders/user.ts": $$$35,
"vtex/loaders/wishlist.ts": $$$36,
"vtex/loaders/workflow/product.ts": $$$37,
"vtex/loaders/workflow/products.ts": $$$38,
"vtex/loaders/intelligentSearch/searches.ts": $$$8,
"vtex/loaders/intelligentSearch/suggestions.ts": $$$9,
"vtex/loaders/intelligentSearch/topsearches.ts": $$$10,
"vtex/loaders/legacy/brands.ts": $$$11,
"vtex/loaders/legacy/pageType.ts": $$$12,
"vtex/loaders/legacy/productDetailsPage.ts": $$$13,
"vtex/loaders/legacy/productList.ts": $$$14,
"vtex/loaders/legacy/productListingPage.ts": $$$15,
"vtex/loaders/legacy/relatedProductsLoader.ts": $$$16,
"vtex/loaders/legacy/suggestions.ts": $$$17,
"vtex/loaders/logistics/getSalesChannelById.ts": $$$18,
"vtex/loaders/logistics/listPickupPoints.ts": $$$19,
"vtex/loaders/logistics/listPickupPointsByLocation.ts": $$$20,
"vtex/loaders/logistics/listSalesChannelById.ts": $$$21,
"vtex/loaders/logistics/listStockByStore.ts": $$$22,
"vtex/loaders/masterdata/searchDocuments.ts": $$$23,
"vtex/loaders/navbar.ts": $$$24,
"vtex/loaders/options/productIdByTerm.ts": $$$25,
"vtex/loaders/orders/list.ts": $$$26,
"vtex/loaders/paths/PDPDefaultPath.ts": $$$27,
"vtex/loaders/paths/PLPDefaultPath.ts": $$$28,
"vtex/loaders/product/extend.ts": $$$29,
"vtex/loaders/product/extensions/detailsPage.ts": $$$30,
"vtex/loaders/product/extensions/list.ts": $$$31,
"vtex/loaders/product/extensions/listingPage.ts": $$$32,
"vtex/loaders/product/extensions/suggestions.ts": $$$33,
"vtex/loaders/product/wishlist.ts": $$$34,
"vtex/loaders/proxy.ts": $$$35,
"vtex/loaders/user.ts": $$$36,
"vtex/loaders/wishlist.ts": $$$37,
"vtex/loaders/workflow/product.ts": $$$38,
"vtex/loaders/workflow/products.ts": $$$39,
},
"handlers": {
"vtex/handlers/sitemap.ts": $$$$0,
Expand Down
Loading