Pre-ship checklist

Before you ship a file#

1. Loads with clay.js as a classic script at the end of <body>, every tag on the same version prefix.
2. <html autosave> unless it is a deliberate manual-save writer.
3. sync is in the plugin list, and exclude=richclay if there is no rich text.
4. The fallback rule html:not([editmode="true"]) [show-when\:editmode="true"] { display: none } is in the stylesheet, and every edit-only control has show-when:editmode="true".
5. Records are authored in the saved form (inert-contenteditable, disabled, readonly); templates in the active form.
6. Every repeated record has a unique data-id; templates carry none; every create and duplicate mints a fresh one.
7. Every control whose value matters has persist; no filter or search box does.
8. All chrome is cloned from a <template> into clay="editor-ui" after clay.ready; nothing in the file is chrome.
9. Tab-local state is in the hash, localStorage or memory, painted through a runtime style; opening, filtering and searching leave clay.hasUnsavedChanges() false.
10. Derived values are sapjs paints, in editor-ui, or no-dirty when the file must show them; every hand-written derived write is guarded, and no script copies a record into a second attribute.
11. Commands are wrapped in clay.undo.commit; derived views are drawn in clay.effect, with no effect warnings in the console.
12. Views whose record a peer deleted are closed, in the effect or a clay:sync-applied handler.
13. The app script starts with clay.start; all listeners are delegated.
14. Nothing writes the record at boot.
15. Edit-only calls are guarded for view mode, and edit actions check clay.isEditMode.
16. clay.confirm calls have a rejection handler.
17. Save failures are visible (indicator, savestatus CSS or clay-ui).
18. Library residue (Sortable, third-party editors) is stripped in a snapshot hook.
19. Images use clay.upload, embedding only on unsupported.
20. The file opens in view mode with JavaScript disabled and shows correct content and no edit controls.
21. With sap: Sap.status().ok, the live root matches the file after load (no computed value rewritten), no [sap-error], rows with your own ids.

Testing a document that changes modes#

Each check names the clayjs test that proves the library side.

• It opens in view by default. tests/unit/mode-decision.test.js pins the table, including an owner cookie alone opening in view with permission kept.
• An explicit edit enters edit. The same file covers ?editmode=true, window.clayEditMode = true and <html opens-in="edit">, and tests/unit/mode-transition.test.js covers an explicit initial edit preparing the session a live first entry does.
• A draft document stays a draft. tests/unit/mode-draft.test.js shows a declared draft refusing both directions.
• A refused exit can be retried. tests/unit/mode-lifecycle.test.js covers a quiesce that refuses and resumes the same leases, and tests/unit/mode-transition.test.js covers the next entry starting a fresh session.
• Pending work refuses the exit. tests/unit/mode-transition.test.js covers a registered pending source, and tests/unit/mode-save-barrier.test.js covers the barrier’s codes.
• A clean enter and exit writes nothing. tests/unit/mode-transition.test.js asserts it, and the corpus case enter-leave-zero-writes records the same run.

tests/mode-counterexamples/ is a set of recorded cases. Each one boots a fixture in jsdom through the real loader, applies a schedule with the transport, the chunk imports and the clock supplied by the harness, and judges the result from what the run left behind. It is not a browser run: no phone, no keyboard and no real network appears in it.

Trap index#