Collections

1// Collection schema reads over REST — the twin of app/wix/cms/collections.ts. Same export, same
2// DTO; the mapper comes from collections-core (the SAME file the SDK transport uses, deployed flat
3// next to this one by deploy.mjs --stack static), so this file is only the transport.
4// docs: https://dev.wix.com/docs/api-reference/business-solutions/cms/data-collections/create-data-collection.md (the Data Collections API; get is GET /wix-data/v2/collections/{id} per the SDK's route table)
5import { WixApiError, wixRequest } from "../../shared/rest/client.js";
6import { toCollectionSchema, type RawCollection } from "../app/wix/cms/collections-core.js";
7import type { CmsCollectionSchema } from "../app/wix/cms/types.js";
8
9const unreadable = (e: unknown): boolean => e instanceof WixApiError && (e.status === 404 || e.status === 403);
10
11/**
12 * A collection's schema — field types, reference targets, permissions. Null when the collection
13 * can't be read: it doesn't exist (404), or the caller may not read schemas (403 — confirm once on
14 * a live site that a visitor token is allowed; if it isn't, read it where an elevated call runs).
15 * GET /wix-data/v2/collections/{dataCollectionId}  → { collection: { id, displayName, fields: [{ key, displayName, type, typeMetadata, systemField, required }], permissions: { insert, update, remove, read } } }
16 */
17export async function getCollectionSchema(collectionId: string): Promise<CmsCollectionSchema | null> {
18  try {
19    const res = await wixRequest<RawCollection>(`/wix-data/v2/collections/${encodeURIComponent(collectionId)}`, { method: "GET" });
20    return res?.collection ? toCollectionSchema(res.collection) : null;
21  } catch (e) {
22    if (unreadable(e)) return null;
23    throw e;
24  }
25}