webcake-storefront-mcp 1.38.0 → 1.39.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.js +190 -138
- package/dist/builder/attributes.js +1 -1
- package/dist/builder/guide.js +11 -5
- package/dist/builder/native-first.js +4 -5
- package/dist/builder/page.js +247 -13
- package/dist/builder/shape.js +174 -0
- package/dist/changelog.json +7 -7
- package/dist/config.js +7 -0
- package/dist/persistence/screenshot-client.js +208 -0
- package/dist/tools/builder-extras.js +172 -4
- package/dist/tools/builder.js +30 -23
- package/dist/tools/global-section-write.js +1 -1
- package/dist/tools/global-sources.js +25 -75
- package/dist/tools/page-draft.js +3 -2
- package/dist/tools/pages.js +32 -70
- package/dist/web-guide-scene.js +10 -4
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -1,9 +1,15 @@
|
|
|
1
|
+
import { buildSection, finalizeForRender } from "./builder/page.js";
|
|
1
2
|
import { BREAKPOINTS } from "./builder/grid.js";
|
|
2
3
|
const DEFAULT_TIMEOUT = 15000;
|
|
3
4
|
/** Stamped on every site and page this MCP server creates (backend columns `sites.by_ai`
|
|
4
5
|
* and `pages.by_ai`), so the builder can flag AI-authored work. Mirrors the landing-page convention. */
|
|
5
6
|
export const BY_AI_MARKER = "mcp";
|
|
6
7
|
const SETTINGS_READ_ERR = "Không đọc được site settings, huỷ lưu để tránh ghi đè rỗng";
|
|
8
|
+
const listOf = (r) => (Array.isArray(r?.data) ? r.data : Array.isArray(r) ? r : []);
|
|
9
|
+
const parseMaybe = (v) => (typeof v === "string" ? (v ? JSON.parse(v) : null) : v ?? null);
|
|
10
|
+
const globalsOf = (src) => (src?.sections || []).filter((s) => s && s.specials && s.specials.global);
|
|
11
|
+
/** Key-order-independent JSON, so a re-serialised but equal node doesn't count as an edit. */
|
|
12
|
+
const canon = (v) => JSON.stringify(v ?? null, (_k, x) => (x && typeof x === "object" && !Array.isArray(x) ? Object.fromEntries(Object.entries(x).sort(([a], [b]) => (a < b ? -1 : 1))) : x));
|
|
7
13
|
export class WebcakeCmsApi {
|
|
8
14
|
/** Parse (if string) and guarantee settings.breakpoints is a usable object — an empty/missing
|
|
9
15
|
* breakpoints would make the backend compile CSS without media queries. */
|
|
@@ -30,7 +36,7 @@ export class WebcakeCmsApi {
|
|
|
30
36
|
sessionId;
|
|
31
37
|
_adminToken;
|
|
32
38
|
_cmsApiKey;
|
|
33
|
-
_siteBps = null;
|
|
39
|
+
_siteBps = null; // cached site.settings (breakpoints, defaultGrid)
|
|
34
40
|
constructor({ baseUrl, token, siteId, sessionId }) {
|
|
35
41
|
this.baseUrl = (baseUrl || "").replace(/\/$/, "");
|
|
36
42
|
this.token = token;
|
|
@@ -155,11 +161,18 @@ export class WebcakeCmsApi {
|
|
|
155
161
|
/** The site's breakpoints ({ bpN: [minW, maxW] } from settings, which may be a JSON string),
|
|
156
162
|
* or null when unset/unreadable — callers then use the standard four. Cached per site. */
|
|
157
163
|
getSiteBreakpoints() {
|
|
164
|
+
return this.siteLayout().then((s) => s?.breakpoints || null);
|
|
165
|
+
}
|
|
166
|
+
/** The site's section grid per breakpoint (settings.defaultGrid): the editor builds every new
|
|
167
|
+
* section from it (editor.js addBlankSection), so generated sections must too. */
|
|
168
|
+
getSiteDefaultGrid() {
|
|
169
|
+
return this.siteLayout().then((s) => s?.defaultGrid || null);
|
|
170
|
+
}
|
|
171
|
+
siteLayout() {
|
|
158
172
|
this._siteBps ??= this.getSite()
|
|
159
173
|
.then((res) => {
|
|
160
174
|
const site = res?.data ?? res;
|
|
161
|
-
|
|
162
|
-
return settings?.breakpoints || null;
|
|
175
|
+
return (typeof site?.settings === "string" ? JSON.parse(site.settings || "{}") : site?.settings) || null;
|
|
163
176
|
})
|
|
164
177
|
.catch(() => {
|
|
165
178
|
this._siteBps = null; // don't cache a failed lookup — retry on the next save
|
|
@@ -226,12 +239,14 @@ export class WebcakeCmsApi {
|
|
|
226
239
|
* `slug`/`is_homepage` are NOT applied at create — set them afterwards via updatePage.
|
|
227
240
|
* Every page born here is AI-authored, so we stamp `by_ai` (persisted to `pages.by_ai`)
|
|
228
241
|
* and the builder shows an "AI" tag next to the page name. */
|
|
229
|
-
createPage(params, opts) {
|
|
242
|
+
async createPage(params, opts) {
|
|
230
243
|
const body = { ...params };
|
|
231
244
|
if (body.source != null && typeof body.source !== "string")
|
|
232
245
|
body.source = JSON.stringify(body.source);
|
|
246
|
+
// The editor never saves an empty page: it creates one blank grid section to drop into
|
|
247
|
+
// (editor.js createPage). An empty `sections` opened with nothing to drop elements on.
|
|
233
248
|
if (body.source == null)
|
|
234
|
-
body.source = JSON.stringify({ sections: [] });
|
|
249
|
+
body.source = JSON.stringify(finalizeForRender({ sections: [buildSection([])] }, await this.getSiteBreakpoints(), await this.getSiteDefaultGrid()));
|
|
235
250
|
if (body.by_ai == null)
|
|
236
251
|
body.by_ai = BY_AI_MARKER;
|
|
237
252
|
return this.request("POST", `/api/v1/site/${this.siteId}/page`, { body, timeout: opts?.timeout });
|
|
@@ -239,8 +254,23 @@ export class WebcakeCmsApi {
|
|
|
239
254
|
updatePage(pageId, params) {
|
|
240
255
|
return this.request("POST", `/api/v1/site/${this.siteId}/${pageId}/update_page`, { body: params });
|
|
241
256
|
}
|
|
242
|
-
|
|
243
|
-
|
|
257
|
+
/** Write a page source, then re-save it through /save like the editor (CSS + global sections,
|
|
258
|
+
* see syncPageAfterWrite). The source is already stored when the sync runs, so a sync failure
|
|
259
|
+
* says so instead of reading as a lost write. `sync:false` skips the /save, for intermediate
|
|
260
|
+
* writes of a batch whose last write syncs (each sync rebuilds the page CSS). */
|
|
261
|
+
async updatePageSource(pageId, params, opts) {
|
|
262
|
+
const sync = params && params.source != null && opts?.sync !== false;
|
|
263
|
+
const src = sync ? (typeof params.source === "string" ? JSON.parse(params.source) : params.source) : null;
|
|
264
|
+
// With a global section on the page, keep the sources as they were BEFORE this write: only a
|
|
265
|
+
// global node this write actually changed may be pushed to the other pages.
|
|
266
|
+
const before = src && globalsOf(src).length ? listOf(await this.listPages()) : null;
|
|
267
|
+
const res = await this.request("POST", `/api/v1/site/${this.siteId}/${pageId}/update_page_source`, { body: params, timeout: opts?.timeout });
|
|
268
|
+
if (sync) {
|
|
269
|
+
await this.syncPageAfterWrite(pageId, src, before).catch((e) => {
|
|
270
|
+
throw new Error(`Page source SAVED, but rebuilding its CSS / syncing global sections via /save failed: ${e?.message || e}. Retry the same write.`);
|
|
271
|
+
});
|
|
272
|
+
}
|
|
273
|
+
return res;
|
|
244
274
|
}
|
|
245
275
|
deletePage(params) {
|
|
246
276
|
return this.request("POST", `/api/v1/site/${this.siteId}/delete_page`, { body: params });
|
|
@@ -264,136 +294,145 @@ export class WebcakeCmsApi {
|
|
|
264
294
|
listGlobalSections() {
|
|
265
295
|
return this.request("GET", `/api/v1/site/${this.siteId}/global_sections`);
|
|
266
296
|
}
|
|
267
|
-
/**
|
|
268
|
-
*
|
|
269
|
-
*
|
|
270
|
-
*
|
|
271
|
-
*
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
297
|
+
/** The cart drawer + popups, as the editor sends them with every save and publish
|
|
298
|
+
* (PagePublish.vue: `global_sources: cart.source.concat(popup.popups)`). /save builds the
|
|
299
|
+
* cart CSS only from these, and /publish copies them into the LIVE global sources: sending []
|
|
300
|
+
* left popups and the cart unpublished and dropped the cart CSS. `source` goes as an object
|
|
301
|
+
* (the backend Jason.encode!s it). */
|
|
302
|
+
async globalSourcesForSave() {
|
|
303
|
+
const list = (r) => (Array.isArray(r?.data) ? r.data : Array.isArray(r) ? r : []);
|
|
304
|
+
const [cart, popups] = await Promise.all([this.getSourceCart(), this.getGlobalSources({ component: "popup" })]);
|
|
305
|
+
return [...list(cart), ...list(popups)].map((g) => ({
|
|
306
|
+
...g,
|
|
307
|
+
source: typeof g.source === "string" ? JSON.parse(g.source) : g.source,
|
|
308
|
+
}));
|
|
309
|
+
}
|
|
310
|
+
/** POST /save or /publish with the body the editor sends (PagePublish.vue savePage):
|
|
311
|
+
* current site settings (or /save nulls them), the cart + popups, and the given pages /
|
|
312
|
+
* global sections. /publish is /save plus the live copy (site_controller.ex `publish` →
|
|
313
|
+
* `save(is_publish: true)`), so one call builds each page's CSS and publishes it. Every /save
|
|
314
|
+
* also stamps site.published_at, which opens the 10-minute draft preview. */
|
|
315
|
+
async siteSave(path, { pages = [], global_sections = [], changes = {}, domain }) {
|
|
316
|
+
const [settings, global_sources] = await Promise.all([this.readSettingsOrThrow(), this.globalSourcesForSave()]);
|
|
317
|
+
return this.request("POST", `/api/v1/site/${this.siteId}/${path}`, {
|
|
280
318
|
body: {
|
|
281
|
-
settings:
|
|
282
|
-
global_sources: [],
|
|
283
|
-
page_contents: [],
|
|
284
|
-
changes: changes || {},
|
|
319
|
+
settings: JSON.stringify(this.ensureSafeSettings(settings)),
|
|
285
320
|
pages,
|
|
321
|
+
changes,
|
|
322
|
+
global_sources,
|
|
286
323
|
global_sections,
|
|
324
|
+
page_contents: [],
|
|
325
|
+
...(domain ? { domain } : {}),
|
|
287
326
|
},
|
|
288
327
|
timeout: 120000,
|
|
289
328
|
});
|
|
290
329
|
}
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
330
|
+
/** A /save with no pages: stamps site.published_at, which (re)opens the draft preview window
|
|
331
|
+
* (PreviewExpire: 10 min after published_at on prod) without changing any content. */
|
|
332
|
+
refreshDraftPreview() {
|
|
333
|
+
return this.siteSave("save", {});
|
|
334
|
+
}
|
|
335
|
+
/** /save every page (as the editor's save does): popups and the cart drawer are compiled into
|
|
336
|
+
* each page's app_css (Qwik gets `popups` + `source_cart`), so after one changes, every page's
|
|
337
|
+
* CSS must be rebuilt or the new popup/cart renders unstyled until some page is saved. */
|
|
338
|
+
async resaveAllPages() {
|
|
339
|
+
const pages = listOf(await this.listPages())
|
|
340
|
+
.filter((p) => p && p.source && p.source.source != null && p.source.source !== "")
|
|
341
|
+
.map((p) => ({ id: p.id, source: typeof p.source.source === "string" ? p.source.source : JSON.stringify(p.source.source) }));
|
|
342
|
+
return this.siteSave("save", { pages });
|
|
343
|
+
}
|
|
344
|
+
/** A popup/cart write landed; rebuild every page's CSS. If that fails the write is still saved,
|
|
345
|
+
* so say so: retrying a create would duplicate the popup. */
|
|
346
|
+
async afterGlobalSourceWrite(res) {
|
|
347
|
+
await this.resaveAllPages().catch((e) => {
|
|
348
|
+
const id = res?.data?.id ?? res?.id;
|
|
349
|
+
throw new Error(`Global source SAVED${id ? ` (id ${id})` : ""} — do not create it again — but rebuilding the pages' CSS via /save failed: ${e?.message || e}. Any page save or publish_site rebuilds it.`);
|
|
350
|
+
});
|
|
296
351
|
}
|
|
297
|
-
/**
|
|
298
|
-
*
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
const src = p && p.source && p.source.source;
|
|
309
|
-
if (src == null || src === "")
|
|
310
|
-
return null;
|
|
311
|
-
return {
|
|
312
|
-
id: p.id,
|
|
313
|
-
source: typeof src === "string" ? src : JSON.stringify(src),
|
|
314
|
-
settings: JSON.stringify(p.settings || {}),
|
|
315
|
-
custom_code: p.custom_code || {},
|
|
316
|
-
};
|
|
317
|
-
})
|
|
318
|
-
.filter(Boolean);
|
|
319
|
-
if (!pages.length)
|
|
320
|
-
return { rebuilt: 0 };
|
|
321
|
-
let s = settings;
|
|
322
|
-
if (s === undefined)
|
|
323
|
-
s = await this.readSettingsOrThrow();
|
|
324
|
-
const settingsStr = JSON.stringify(this.ensureSafeSettings(s));
|
|
325
|
-
const changes = {};
|
|
326
|
-
for (const p of pages)
|
|
327
|
-
changes[p.id] = 1;
|
|
328
|
-
await this.request("POST", `/api/v1/site/${this.siteId}/save`, {
|
|
329
|
-
body: { pages, settings: settingsStr, changes, global_sources: [], global_sections: [], page_contents: [] },
|
|
330
|
-
timeout: 120000,
|
|
352
|
+
/** Drop a deleted page from every global section's `pages` list, as the editor does on delete
|
|
353
|
+
* (globalSection.js removeGlobalSectionOfPage). */
|
|
354
|
+
async unlinkPageFromGlobalSections(pageId) {
|
|
355
|
+
const stale = listOf(await this.listGlobalSections()).filter((r) => (r.pages || []).includes(pageId));
|
|
356
|
+
if (!stale.length)
|
|
357
|
+
return 0;
|
|
358
|
+
await this.siteSave("save", {
|
|
359
|
+
global_sections: stale.map((r) => ({
|
|
360
|
+
section_id: r.section_id, name: r.name, type: r.type, status: "update",
|
|
361
|
+
pages: r.pages.filter((id) => id !== pageId), section: parseMaybe(r.section), contents: [],
|
|
362
|
+
})),
|
|
331
363
|
});
|
|
332
|
-
return
|
|
333
|
-
}
|
|
334
|
-
/**
|
|
335
|
-
*
|
|
336
|
-
*
|
|
337
|
-
*
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
*
|
|
343
|
-
*
|
|
344
|
-
*
|
|
345
|
-
*
|
|
346
|
-
*
|
|
347
|
-
*
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
const
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
return null;
|
|
367
|
-
return {
|
|
368
|
-
id: p.id,
|
|
369
|
-
source: typeof src === "string" ? src : JSON.stringify(src),
|
|
370
|
-
type: p.type,
|
|
371
|
-
slug: p.slug,
|
|
372
|
-
is_homepage: p.is_homepage === true,
|
|
373
|
-
settings: JSON.stringify(p.settings || {}),
|
|
374
|
-
};
|
|
375
|
-
})
|
|
376
|
-
.filter(Boolean);
|
|
364
|
+
return stale.length;
|
|
365
|
+
}
|
|
366
|
+
/** Upsert/delete global sections (Header/Footer/reusable blocks) through /save, like the
|
|
367
|
+
* editor. Each entry carries `status` ("new"|"update"|"delete") and is matched by
|
|
368
|
+
* (site_id, section_id); `section` is an OBJECT. Pass `pages` (each { id, source } with source
|
|
369
|
+
* a JSON STRING) to embed the node in page sources in the same atomic save. */
|
|
370
|
+
saveGlobalSections({ global_sections = [], pages = [], changes } = {}) {
|
|
371
|
+
return this.siteSave("save", { global_sections, pages, changes: changes || {} });
|
|
372
|
+
}
|
|
373
|
+
/** After a page's source is written: re-save it through /save the way the editor does, so
|
|
374
|
+
* (1) its compiled CSS (app_css) is rebuilt — update_page_source never builds it, and the
|
|
375
|
+
* draft preview renders page.source.app_css; (2) a global header/footer/section edited on
|
|
376
|
+
* this page reaches its GlobalSection record and every other page that embeds it — the
|
|
377
|
+
* editor's updateGlobalSections(), without which the edit stays on one page and the editor
|
|
378
|
+
* later replaces it with the stale record.
|
|
379
|
+
* A global node is pushed only when THIS write changed it (vs `pagesBefore`) and it differs
|
|
380
|
+
* from the record: a write carrying an older copy of the header must not revert the newer
|
|
381
|
+
* one site-wide. `changes` stays {}: a version row per write (and per popup) is noise; publish
|
|
382
|
+
* versions every page. */
|
|
383
|
+
async syncPageAfterWrite(pageId, src, pagesBefore = null) {
|
|
384
|
+
const changed = [];
|
|
385
|
+
const globals = globalsOf(src);
|
|
386
|
+
if (globals.length && pagesBefore) {
|
|
387
|
+
const prev = pagesBefore.find((p) => p && p.id === pageId);
|
|
388
|
+
const prevSrc = parseMaybe(prev?.source?.source);
|
|
389
|
+
const prevNode = (id) => (prevSrc?.sections || []).find((s) => s && s.id === id);
|
|
390
|
+
const res = await this.listGlobalSections();
|
|
391
|
+
const records = listOf(res);
|
|
392
|
+
for (const node of globals) {
|
|
393
|
+
const rec = records.find((r) => r.section_id === node.id);
|
|
394
|
+
if (!rec || canon(prevNode(node.id)) === canon(node) || canon(parseMaybe(rec.section)) === canon(node))
|
|
395
|
+
continue;
|
|
396
|
+
changed.push({ section_id: rec.section_id, name: rec.name, type: rec.type, pages: rec.pages || [], status: "update", section: node, contents: [] });
|
|
397
|
+
}
|
|
377
398
|
}
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
399
|
+
const pages = [{ id: pageId, source: JSON.stringify(src) }];
|
|
400
|
+
if (changed.length) {
|
|
401
|
+
const byId = new Map(changed.map((g) => [g.section_id, g.section]));
|
|
402
|
+
for (const p of pagesBefore || []) {
|
|
403
|
+
if (!p || p.id === pageId)
|
|
404
|
+
continue;
|
|
405
|
+
const other = parseMaybe(p.source?.source);
|
|
406
|
+
if (!other || !(other.sections || []).some((s) => s && byId.has(s.id)))
|
|
407
|
+
continue;
|
|
408
|
+
other.sections = other.sections.map((s) => (s && byId.has(s.id) ? byId.get(s.id) : s));
|
|
409
|
+
pages.push({ id: p.id, source: JSON.stringify(other) });
|
|
410
|
+
}
|
|
382
411
|
}
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
412
|
+
await this.siteSave("save", { pages, global_sections: changed });
|
|
413
|
+
return { rebuilt_pages: pages.length, global_sections_synced: changed.length };
|
|
414
|
+
}
|
|
415
|
+
getSite() {
|
|
416
|
+
return this.request("GET", `/api/v1/site/${this.siteId}/`);
|
|
417
|
+
}
|
|
418
|
+
/** Publish the site live, like the editor's "Xuất bản" (PagePublish.vue): every page with its
|
|
419
|
+
* saved source as `{ id, source, type, slug, is_homepage, settings }`. Sending no pages made
|
|
420
|
+
* the backend publish nothing. /publish runs the whole /save first, so CSS is built here; the
|
|
421
|
+
* old separate rebuild doubled the work and the page-version history. */
|
|
422
|
+
async publishSite(params = {}) {
|
|
423
|
+
const res = await this.listPages();
|
|
424
|
+
const pages = ((res && res.data) || res || [])
|
|
425
|
+
.filter((p) => p && p.source && p.source.source != null && p.source.source !== "")
|
|
426
|
+
.map((p) => ({
|
|
427
|
+
id: p.id,
|
|
428
|
+
source: typeof p.source.source === "string" ? p.source.source : JSON.stringify(p.source.source),
|
|
429
|
+
type: p.type,
|
|
430
|
+
slug: p.slug,
|
|
431
|
+
is_homepage: p.is_homepage === true,
|
|
432
|
+
settings: JSON.stringify(p.settings || {}),
|
|
433
|
+
}));
|
|
434
|
+
const changes = Object.fromEntries(pages.map((p) => [p.id, 1]));
|
|
435
|
+
return this.siteSave("publish", { pages, changes, domain: params.domain });
|
|
397
436
|
}
|
|
398
437
|
uploadImageBase64({ base64, content_type } = {}) {
|
|
399
438
|
return this.request("POST", `/api/v1/site/${this.siteId}/media/content/b64`, {
|
|
@@ -739,23 +778,36 @@ export class WebcakeCmsApi {
|
|
|
739
778
|
getSourceCart() {
|
|
740
779
|
return this.request("GET", `/api/v1/site/${this.siteId}/cart/get_source_cart`);
|
|
741
780
|
}
|
|
742
|
-
createSourceCart(params) {
|
|
743
|
-
|
|
781
|
+
async createSourceCart(params) {
|
|
782
|
+
const res = await this.request("POST", `/api/v1/site/${this.siteId}/cart/create_source_cart`, { body: params });
|
|
783
|
+
await this.afterGlobalSourceWrite(res);
|
|
784
|
+
return res;
|
|
744
785
|
}
|
|
745
|
-
updateSourceCart(params) {
|
|
746
|
-
|
|
786
|
+
async updateSourceCart(params) {
|
|
787
|
+
const res = await this.request("POST", `/api/v1/site/${this.siteId}/cart/update_source_cart`, { body: params });
|
|
788
|
+
await this.afterGlobalSourceWrite(res);
|
|
789
|
+
return res;
|
|
747
790
|
}
|
|
748
791
|
getGlobalSources(query) {
|
|
749
792
|
return this.request("GET", `/api/v1/site/${this.siteId}/global_source/`, { query });
|
|
750
793
|
}
|
|
751
|
-
createGlobalSource(params) {
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
794
|
+
async createGlobalSource(params) {
|
|
795
|
+
const res = await this.request("POST", `/api/v1/site/${this.siteId}/global_source/create`, { body: params });
|
|
796
|
+
await this.afterGlobalSourceWrite(res);
|
|
797
|
+
return res;
|
|
798
|
+
}
|
|
799
|
+
async updateGlobalSource(params) {
|
|
800
|
+
const res = await this.request("POST", `/api/v1/site/${this.siteId}/global_source/update`, { body: params });
|
|
801
|
+
await this.afterGlobalSourceWrite(res);
|
|
802
|
+
return res;
|
|
803
|
+
}
|
|
804
|
+
async deleteGlobalSource(params) {
|
|
805
|
+
const res = await this.request("POST", `/api/v1/site/${this.siteId}/global_source/delete`, { body: params });
|
|
806
|
+
// A deleted popup's CSS stays compiled into every page until they are re-saved.
|
|
807
|
+
await this.resaveAllPages().catch((e) => {
|
|
808
|
+
throw new Error(`Global source DELETED, but rebuilding the pages' CSS via /save failed: ${e?.message || e}. Any page save or publish_site rebuilds it.`);
|
|
809
|
+
});
|
|
810
|
+
return res;
|
|
759
811
|
}
|
|
760
812
|
getGlobalSourceContents(query) {
|
|
761
813
|
return this.request("GET", `/api/v1/dashboard/site/${this.siteId}/multilingual/global_source_contents`, { query });
|
|
@@ -20,7 +20,7 @@ const NOISE_KEYS = new Set(["undefined", "locked", "loaded", "isChangeSection"])
|
|
|
20
20
|
export const SHARED_SPECIALS = {
|
|
21
21
|
custom_class: "CSS class(es) on the element — a hook for a few lines of site CSS, or for CMS glue code to write into it. Try style/config first.",
|
|
22
22
|
custom_css: "Raw CSS scoped to this element. Last resort: try runtime.style/config first (see NATIVE FIRST).",
|
|
23
|
-
element_async: "
|
|
23
|
+
element_async: "Editor responsive toggle: true = this element keeps different styles per breakpoint (the editor stops copying desktop edits onto tablet/mobile). Set automatically when breakpoints differ.",
|
|
24
24
|
event_name_custom: "Custom analytics event name fired on interaction.",
|
|
25
25
|
tabIndex: "Bind this element to a tab item (TAB-ITEM-…) so a tabs element shows/hides it.",
|
|
26
26
|
text_animation_type: "Animated words in text/button: set to the type used by the <span class=\"animationText\" data-type …> inside specials.text (typed|typed2|clip|rotate3|animate.css name). See get_build_guide → Motion.",
|
package/dist/builder/guide.js
CHANGED
|
@@ -224,9 +224,10 @@ You can still hand-set a final \`node.bpN\` when editing an already-saved page.
|
|
|
224
224
|
- Image: \`runtime.config.src\` (URL). The URL MUST be a WebCake CDN url — the storefront
|
|
225
225
|
whitelists image domains, so external URLs (Pexels, random sites) won't render. Get CDN
|
|
226
226
|
urls from search_images (uploads by default → use its cdn_url) or upload_images.
|
|
227
|
-
- Form: wrap inputs in a \`form\`; set \`form.specials.type\`
|
|
228
|
-
|
|
229
|
-
|
|
227
|
+
- Form: wrap inputs in a \`form\`; ALWAYS set \`form.specials.type\` — the renderer treats a form
|
|
228
|
+
with no type as form_order (a checkout). Contact / lead / quote request / newsletter →
|
|
229
|
+
\`subscribe\` (the editor's own contact form). Others: form_order (checkout) | form_login |
|
|
230
|
+
form_signup | form_discount | order_tracking | form_booking. Each input needs \`specials.field_name\`.
|
|
230
231
|
- EMBED = LAST RESORT. Build everything native elements can build (text, image, button, form,
|
|
231
232
|
container, gallery, swiper, video, googlemap, countdown…) natively. Use \`embed\` ONLY for the
|
|
232
233
|
one piece no element can do (a third-party widget, a tracking/chat snippet, a custom
|
|
@@ -426,9 +427,14 @@ List existing popups with list_global_sources({component:"popup"}); edit via upd
|
|
|
426
427
|
2. list_elements / get_element to pick the right component types; get_page_schema for the exact
|
|
427
428
|
node contract ({ sections:[ { id,type,specials,runtime:{style,config},children,events,bindings } ] }).
|
|
428
429
|
3. Build sections with new_section (or new_element for one node), fill content.
|
|
429
|
-
4. validate_page — fix every error
|
|
430
|
+
4. validate_page — fix every error; treat warnings as a fix list.
|
|
430
431
|
5. build_page with dry_run:true first → review → dry_run:false to persist.
|
|
431
|
-
6.
|
|
432
|
+
6. LOOK at it: preview_page (desktop 1280 + mobile 420 screenshots of the saved draft, nothing
|
|
433
|
+
goes live). Judge it like the designer at the canvas: matches the brief? clear hierarchy,
|
|
434
|
+
consistent spacing and colours from the design system, nothing cut off or overflowing,
|
|
435
|
+
images loaded, mobile stacks cleanly. Fix each issue with update_page_element(s) (per
|
|
436
|
+
breakpoint via responsive.bpN), then preview_page again. Only then publish_site.
|
|
437
|
+
7. For existing pages, prefer surgical edits (update_page_element) over full rewrites.
|
|
432
438
|
|
|
433
439
|
## LARGE PAGES — avoid timeout (use the DRAFT flow)
|
|
434
440
|
A multi-section page sent in one build_page can be a huge request and hit the 15s timeout.
|
|
@@ -31,8 +31,6 @@ export const CODE_BUDGET = {
|
|
|
31
31
|
};
|
|
32
32
|
/** custom_css + embed code across one page or global source. */
|
|
33
33
|
export const NODE_CODE_BUDGET = { soft: 10_000, hard: 30_000 };
|
|
34
|
-
/** Growth still allowed on a site already past the ceiling, so it can ship fixes while it migrates. */
|
|
35
|
-
const SMALL_FIX = 2_000;
|
|
36
34
|
export const NATIVE_FIRST_GUIDE = `## NATIVE FIRST — elements on the canvas before any code
|
|
37
35
|
Pages are edited by dragging elements on the canvas. UI written in code is not on that canvas: the
|
|
38
36
|
shop owner can't edit it, it is missing from the page HTML until scripts run, and it loads on every
|
|
@@ -68,7 +66,7 @@ ${NATIVE_ALTERNATIVES.map((a) => `- ${a.need}: ${a.elements.join(", ")}${a.note
|
|
|
68
66
|
|
|
69
67
|
Limits: site scripts ${CODE_BUDGET.script.soft / 1000}k chars, site CSS ${CODE_BUDGET.css.soft / 1000}k chars. Above that, a write is refused unless
|
|
70
68
|
it names the gap in native_gap (scripts ${CODE_BUDGET.script.hard / 1000}k / CSS ${CODE_BUDGET.css.hard / 1000}k is refused outright; a site already past that may only
|
|
71
|
-
|
|
69
|
+
shrink or swap code: no write may grow it, publish_site refuses to publish it). validate_page also refuses new placeholder JSON in text and more than
|
|
72
70
|
${NODE_CODE_BUDGET.hard / 1000}k chars of custom_css + embed code on one page. Content already on a page never blocks an unrelated save.`;
|
|
73
71
|
const SMELLS = [
|
|
74
72
|
{
|
|
@@ -122,7 +120,8 @@ export function codeUsage(values) {
|
|
|
122
120
|
};
|
|
123
121
|
}
|
|
124
122
|
/** Judge a write by what it ADDS: shrinking or swapping code on an already-large site always passes,
|
|
125
|
-
* so a site can move off custom code step by step
|
|
123
|
+
* so a site can move off custom code step by step. Past the ceiling nothing may grow: small fixes
|
|
124
|
+
* used to be allowed and ratcheted a site to 90k chars of CSS, which then failed to publish. */
|
|
126
125
|
export function checkSiteCode(before, changes) {
|
|
127
126
|
const after = { ...before, ...changes };
|
|
128
127
|
const hard = [];
|
|
@@ -136,7 +135,7 @@ export function checkSiteCode(before, changes) {
|
|
|
136
135
|
if (now.length <= old.length)
|
|
137
136
|
continue;
|
|
138
137
|
const { soft: softLimit, hard: hardLimit } = CODE_BUDGET[kind];
|
|
139
|
-
if (now.length > hardLimit
|
|
138
|
+
if (now.length > hardLimit)
|
|
140
139
|
hard.push(`Site ${kind} would reach ${now.length} chars (ceiling ${hardLimit}). That is an app, not a snippet: move UI to native elements, data to a collection, logic to an HTTP function.`);
|
|
141
140
|
else if (now.length > softLimit)
|
|
142
141
|
soft.push(`Site ${kind} would reach ${now.length} chars (budget ${softLimit}).`);
|