Subchapter 16.381

Faq

Pricing Plans

Rentalsstatic

Restaurants

815 more in the appendix

Faqrest

Source

faq/rest/faq.ts

TypeScript71 lines4 KB

1// FAQ reads over REST — the twin of app/wix/faq/faq.ts. Same exports, same DTOs; the rules and mappers
2// come from faq-core (the SAME file the SDK transport uses, deployed flat next to this one by
3// deploy.mjs --stack static), so this file is only the transport: one fetch with a literal body per
4// function. Both endpoints are the FAQ app's READ scope; whether an anonymous VISITOR token may call
5// them is not documented — the reference shows an elevated example — so a 403 here means the site's
6// read needs a server-side path, not that the body is wrong (INSTRUCTIONS.md, verification caveats).
7// Porting: keep the paths, keep the bodies, port the core once.
8// docs: https://dev.wix.com/docs/api-reference/business-management/faq-app/category-v2/query-categories.md
9// docs: https://dev.wix.com/docs/api-reference/business-management/faq-app/question-entry-v2/query-question-entries.md
10import { wixRequest } from "../../shared/rest/client.js";
11import

faq.ts on GitHub

{ imgSrc }

from

"../../shared/rest/media.js"

;

import {

FAQ_APP_ID,

assembleFaq,

categoriesQueryBody,

loadAllQuestions,

nextCursor,

questionByIdBody,

questionsQueryBody,

sortCategories,

toCategory,

toQuestion,

type Raw,

} from "../app/wix/faq/faq-core.js";

import type { FaqCategory, FaqData, FaqQuestion, FaqQuestionPage, FetchQuestionsOptions } from "../app/wix/faq/types.js";

export { FAQ_APP_ID };

const CATEGORIES_QUERY = "/faq/v2/categories/query";

const QUESTIONS_QUERY = "/faq/v2/question-entries/query";

/**

* All categories in owner order, one page (a site has few). `questionCount` is 0 here — fetchFaq fills it.

* POST /faq/v2/categories/query { query: { sort: [{ fieldName: "sortOrder", order: "ASC" }], cursorPaging: { limit: 100 } } }

* → { categories: [{ id, title, sortOrder, revision, createdDate, updatedDate }], pagingMetadata }

*/

export async function fetchCategories(): Promise<FaqCategory[]> {

const res = await wixRequest<Raw>(CATEGORIES_QUERY, { body: categoriesQueryBody() });

return sortCategories(((res?.categories ?? []) as Raw[]).map((c) => toCategory(c)));

}

/**

* One cursor page of questions, optionally one category's; `nextCursor` continues the same query —

* send it alone, the filter and sort ride inside it.

* POST /faq/v2/question-entries/query { query: { filter?: { categoryId: { $eq } }, sort, cursorPaging: { limit } }, contentFormat: "RICH_CONTENT", fieldSet: ["SHARE_LINKS"] } — first page

* POST /faq/v2/question-entries/query { query: { cursorPaging: { limit, cursor } }, contentFormat, fieldSet } — later pages

* → { questionEntries: [{ id, question, richContent | plainText | draftjs, categoryId, sortOrder, slug, shareLink, labels }], pagingMetadata: { count, cursors: { next, prev }, hasNext } }

*/

export async function fetchQuestions(o: FetchQuestionsOptions = {}): Promise<FaqQuestionPage> {

const res = await wixRequest<Raw>(QUESTIONS_QUERY, { body: questionsQueryBody(o) });

return {

questions: ((res?.questionEntries ?? []) as Raw[]).map((r) => toQuestion(r, imgSrc)),

nextCursor: nextCursor(res?.pagingMetadata),

};

}

/** Everything the FAQ page needs: categories (counted) + every question (paged until done or MAX_QUESTIONS). */

export async function fetchFaq(): Promise<FaqData> {

const [cats, { questions, truncated }] = await Promise.all([fetchCategories(), loadAllQuestions(fetchQuestions)]);

return assembleFaq(cats, questions, truncated);

}

/**

* One question by id — the same query read as the page, so one permission covers both. Null when missing.

* POST /faq/v2/question-entries/query { query: { filter: { _id: { $eq } }, cursorPaging: { limit: 1 } }, contentFormat, fieldSet }

*/

export async function fetchQuestionById(id: string): Promise<FaqQuestion | null> {

const res = await wixRequest<Raw>(QUESTIONS_QUERY, { body: questionByIdBody(id) });

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

return raw ? toQuestion(raw, imgSrc) : null;

}