@pramen/cms-editor 0.0.49 → 0.0.50

package/src/types.ts

@@ -5,9 +5,32 @@
 /** Any JSON value — the wire form of everything the CMS stores. */
 export type JsonValue = string | number | boolean | null | JsonValue[] | { [key: string]: JsonValue };
 
+/** A rich-text document — the editor's structured JSON. Mirrors `RichTextDoc` in
+ * @pramen/cms; a `richtext` field is this tree, never an HTML string. */
+export interface RichTextDoc {
+  type: "doc";
+  content?: RichTextNode[];
+}
+
+/** One node in a {@link RichTextDoc}. */
+export interface RichTextNode {
+  type: string;
+  content?: RichTextNode[];
+  text?: string;
+  marks?: RichTextMark[];
+  attrs?: Record<string, JsonValue>;
+}
+
+/** An inline mark on a text node. */
+export interface RichTextMark {
+  type: string;
+  attrs?: Record<string, JsonValue>;
+}
+
 /** One authored field value. Mirrors `FieldValue` in @pramen/cms: a `"media"` field
- * arrives resolved to a `Media`, and `group`/`repeater` fields nest further bags. */
-export type FieldValue = JsonValue | Media | FieldValues | FieldValue[];
+ * arrives resolved to a `Media`, a `"richtext"` field is a `RichTextDoc`, and
+ * `group`/`repeater` fields nest further bags. */
+export type FieldValue = JsonValue | Media | RichTextDoc | FieldValues | FieldValue[];
 
 /** A block / collection / page `fields` bag — field name -> authored value. */
 export interface FieldValues {
@@ -103,8 +126,17 @@ export interface CollectionMeta {
    * from this to open/save/delete it. */
   idField: string;
   orderBy?: { column: string; dir?: "asc" | "desc" };
+  /** The workflow features the collection opted into server-side (`supports`), e.g.
+   * `["drafts", "scheduling"]`. Carried here so this mirror stays faithful to
+   * `CollectionMeta`. The editor renders the matching affordances (publish/unpublish, a
+   * schedule picker, a preview link, a revision list) in `CollectionWorkflow`; an empty
+   * list renders none of them. */
+  supports?: CollectionFeature[];
 }
 
+/** Mirror of @pramen/cms `CollectionFeature`. */
+export type CollectionFeature = "drafts" | "scheduling" | "revisions" | "preview";
+
 export interface Page {
   id: string;
   typeId: string;