Subchapter 16.609

Plans

Pricing Plans

Rentalsstatic

Restaurants

815 more in the appendix

Plansrest

Source

pricing-plans/rest/plans.ts

TypeScript58 lines3 KB

1// Plan reads over REST — the twin of app/wix/pricing-plans/plans.ts. Same exports, same DTOs; the
2// rules and mappers come from plans-core (the SAME file the SDK transport uses, deployed flat next
3// to this one by deploy.mjs --stack static), so this file is only the transport: one fetch with a
4// literal body per function. Every call here is safe from a browser with a visitor token.
5// A plan without a numeric price is malformed and never returned (plans-core `planAmount`).
6// Porting: keep the path, keep the body, port the core once.
7// docs: https://dev.wix.com/docs/api-reference/business-solutions/pricing-plans/plans-v3/query-plans.md
8import { wixRequest } from "../../shared/rest/client.js";
9import { imgSrc } from "../../shared/rest/media.js";
10import { plansQuery, toDetail, toSummaries,

plans.ts on GitHub

type

FormatOptions,

type

Raw }

from

"../app/wix/pricing-plans/plans-core.js"

;

import type { PlanDetail, PlanSummary } from "../app/wix/pricing-plans/types.js";

export type { FormatOptions };

const QUERY = "/pricing-plans/v3/plans/query";

export interface FetchPlansOptions extends FormatOptions {

/** 1–100, default 100. */

limit?: number;

}

/**

* The public plans for the pricing grid, as card-ready DTOs.

* POST /pricing-plans/v3/plans/query { query: { filter: { visibility: "PUBLIC" }, cursorPaging: { limit } } }

*/

export async function fetchPlans({ limit = 100, locale }: FetchPlansOptions = {}): Promise<PlanSummary[]> {

const res = await wixRequest<Raw>(QUERY, { body: { query: plansQuery({ limit }) } });

return toSummaries((res?.plans ?? []) as Raw[], imgSrc, { locale });

}

/**

* Specific public plans by id, in the API's order; unknown ids are simply absent.

* POST /pricing-plans/v3/plans/query { query: { filter: { visibility: "PUBLIC", id: { $in: ids } }, cursorPaging: { limit } } }

*/

export async function fetchPlansByIds(ids: string[], { locale }: FormatOptions = {}): Promise<PlanSummary[]> {

const res = await wixRequest<Raw>(QUERY, { body: { query: plansQuery({ ids, limit: Math.min(Math.max(ids.length, 1), 100) }) } });

return toSummaries((res?.plans ?? []) as Raw[], imgSrc, { locale });

}

/**

* One public plan by its URL slug; null when the slug doesn't resolve (an empty `plans`, not a 404).

* POST /pricing-plans/v3/plans/query { query: { filter: { visibility: "PUBLIC", slug }, cursorPaging: { limit: 1 } } }

*/

export async function fetchPlanBySlug(slug: string, { locale }: FormatOptions = {}): Promise<PlanDetail | null> {

const res = await wixRequest<Raw>(QUERY, { body: { query: plansQuery({ limit: 1, slug }) } });

const raw: Raw | undefined = res?.plans?.[0];

return raw ? toDetail(raw, imgSrc, { locale }) : null;

}

/**

* One public plan by id; null when not found.

* POST /pricing-plans/v3/plans/query { query: { filter: { visibility: "PUBLIC", id: { $in: [planId] } }, cursorPaging: { limit: 1 } } }

*/

export async function fetchPlanById(planId: string, { locale }: FormatOptions = {}): Promise<PlanDetail | null> {

const res = await wixRequest<Raw>(QUERY, { body: { query: plansQuery({ limit: 1, ids: [planId] }) } });

const raw: Raw | undefined = res?.plans?.[0];

return raw ? toDetail(raw, imgSrc, { locale }) : null;

}