@stechquick/studio-cli 4.1.2-0 → 4.2.0-0-BETA-release-4.2.0-2026.9.9.8.51

package/dist/studio-cli/kits/wf-app-kit/.ai-kit/ui-kit/reference/qjson-schema.md

@@ -0,0 +1,188 @@
+# QJSON Schema (`S` system)
+
+> ⚠️ **STOP — before applying any rule below, confirm which style system the target page is on.** Read its root-level `opt.V` (and whether its nodes carry an `S` object): **`opt.V >= 2.0` / has `S` → S system**; **`opt.V` missing or `< 2.0` → legacy**. The two systems are not interchangeable on a page. Unsure how to route? → [index.md Step 0](../index.md).
+>
+> **This file is the `S` track.** Design is authored in the node's `S` object; `O.layout` is not authored. On a **legacy** page instead (where `S` does not render) → [qjson-schema-legacy.md](qjson-schema-legacy.md).
+>
+> Extracted from the TypeScript interfaces the Quick runtime and compiler use.
+
+## 1. File envelope (`IQJSon`)
+
+A `.qjson` file is a JS module exporting `pjson`:
+
+```javascript
+let pjson = {
+  "pJson": [],     // ICompJson[]  — authored component tree (you write this)
+  "lrids": {},     // ILRID        — localization you write, by language code
+  "opt": {}        // IQJsonOptions
+};
+export default pjson
+```
+
+An **AI-authored file carries only these three keys** (`pJson`, `lrids`, `opt`). The compiled twins `cJson` (compiled tree) and `clrids` (compiled localization) are generated by the editor/compiler on import — **omit them entirely**: never write them into a new file, and strip them from any existing file you edit.
+
+Full `IQJSon` interface fields:
+
+| Key | Type | Authored? | Notes |
+|-----|------|-----------|-------|
+| `pJson` | `ICompJson[]` | **you** | the component tree |
+| `cJson` | `ICompJson[]` | generated | compiled twin of pJson; **absent in AI-authored files** (omit/strip — Studio regenerates it) |
+| `lrids` | `ILRID` | **you** | `{ "tr-TR": {key:"'val'"}, ... }` |
+| `clrids` | `ILRID` | generated | compiled localization; **absent in AI-authored files** (omit/strip — Studio regenerates it) |
+| `opt` | `IQJsonOptions` | optional | page options (below) |
+| `description` | `string` | optional | page description |
+| `files` / `cFiles` | `Record<string,string>` | optional | TS 2.0 external handler files (`HF`) and compiled twins |
+| `namedViews` | `Record<string, IQView>` | optional | additional named views (advanced) |
+
+`IQJsonOptions` (`opt`):
+
+| Field | Meaning |
+|-------|---------|
+| `QL` | QJSON default scripting language (`ScriptLang`). Event handlers still use explicit `HL:"TS"`; properties/bindings may use `HL:"QS"`. |
+| `V` | schema version number. A **new `S`-system page sets `V: 2.5`** (the current version — this is what marks it as `S`-system); a legacy page has `V` missing or `< 2.0`. |
+| `otelDiag` / `otelChannel` | telemetry tags |
+
+> `ScriptLang = "QS" | "JS" | "TS" | "FL" | "GUI"`. `QS`=QScript, `TS`=TypeScript, `JS`=plain JS (passthrough), `FL`=Flow (visual), `GUI`=editor-generated.
+
+AI-authoring convention: an authored file carries three keys (`pJson`, `lrids`, `opt`) and **omits `cJson`/`clrids` entirely**; the editor/compiler fills the compiled twins on import/save. The file must close with `};` then `export default pjson`.
+
+## 2. Component node (`ICompJson`)
+
+```ts
+interface ICompJson {
+  T: string;                        // component type name (see component-catalog.md)
+  CP?: string;                      // CompPath for a Named component
+  P: IPropJson;                     // properties (ID is required)
+  E: IDictionary<IEventJson>;       // events
+  C: IDictionary<IChildJson>;       // children grouped by slot name
+  D?: Record<string, Record<string, IDirectiveJson>>;  // directives (advanced)
+  O?: IOptJson;                     // options (cType, layout, ...)
+  SA?: Array<string>;               // applied Styled Component names (reusable named styles)
+  S?: StyleValue;                   // Style-tab inline styles, keyed by resolution range
+  SC?: IStyleChild;                 // style overrides for child sub-elements
+  _Editor: IEditorJson;             // { eID: string }
+}
+```
+
+Required for a valid node: `T`, `P.ID.H`, `_Editor.eID`, and **`C`** (use `{}` for leaf components — omitting `C` is an error). `E` is typically present (often `{}`). `O` carries `cType` and layout.
+
+### Styling fields: `S`, `SA`, `SC` (the Style System)
+These are produced by Studio's **Style tab**.
+
+- **`S`** (`StyleValue = Record<string, string | boolean | Record<string,string>>`): inline styles keyed by **resolution range** (e.g. `"xs-xl"`, `"md-xl"`), each a map of CSS-camelCase properties: `width`/`height`, `fontColor`/`fontFamily`/`fontSize`/`fontStyle`/`fontWeight`/`lineHeight`/`textAlign`, `backgroundColor`/`color`/`iconColor`, `border*`/`boxShadow`/`boxSizing`, margins/paddings, and (on containers) `col`/`flexDirection`/`alignItems`/`justifyContent`. Empty `""` = unset.
+- **`SA`**: array of applied **Styled Component** names (reusable named styles shared across pages).
+- **`SC`** (`IStyleChild`): style overrides targeting a component's child sub-elements.
+
+You hand-write `S` for **all** per-component design here — layout included (grid `col`, `flexDirection`/`alignItems`/`justifyContent`, spacing); `SA`/`SC` are normally produced by applying Styled Components in Studio. The `O.layout` field (§6) exists in the schema but belongs to the legacy era — **do not author it** on an `S`-system page. Full guidance: [knowledge/styling.md](../knowledge/styling.md).
+
+`CP` (CompPath for Named components) and `D` (directives) are advanced/editor-managed; hand-authoring rarely needs them.
+
+### `_Editor.eID`
+`{ "eID": "<id>" }` — the editor's stable internal id. It is **equal to `P.ID.H` for auto-generated components** (both `EdtrComp_42`) but **may differ** when the ID is renamed in Studio (real files contain both: e.g. `ID:"PageComp"` with `eID:"EdtrComp_1"`). So equality is not required. Rules that ARE required: both `P.ID.H` and `_Editor.eID` must be present and unique per page. When hand-authoring a new component, setting `eID` = `ID` (one unique value) is the simplest valid choice.
+
+## 3. Properties (`IPropJson` / `IPropertyJson`)
+
+```ts
+interface IPropertyJson {
+  H: string | object;   // value/expression (the "handler")
+  T: PTyped;            // "prop" | "class" | "text" | "attr"
+  DE?: boolean;         // Don't-Evaluate: use H literally, skip script evaluation
+  HF?: string;          // external handler file (TS 2.0)
+  HL?: ScriptLang;      // property language; QS is permitted and is the default for property expressions
+}
+```
+
+`PType` enum (how the value is applied at render):
+
+| `T` | Destination | Use for |
+|-----|-------------|---------|
+| `"prop"` | Vue component prop | the common case (`color`, `label`, `visible`, `items`, `QLabel.text`) |
+| `"class"` | CSS class string | `class` |
+| `"text"` | component slot **text content** | `VIcon` icon name; raw text content |
+| `"attr"` | DOM attribute | `data-*`, `aria-*`, masks like `format` |
+
+Value quoting inside `H` (QScript expression semantics):
+- String → single-quoted: `"'primary'"`
+- Number/boolean → bare: `"10"`, `"true"`
+- Expression/binding → bare: `"item.name"`, `"data.title"`, `"components.x.qValue"`
+- Array → `"[1,2,3]"`; QScript object literals use `=` keys: `"[{text='A', value=1}]"`
+
+`IPropJson` reserves `ID` (required, `IDefinedPropertyJson` — `H` is a plain string), plus `Render`, `DiscardSettings`, `class`.
+
+## 4. Events (`IEventJson`)
+
+```ts
+interface IEventJson {
+  H: string | IQuickFlowModel;  // handler code (TS/QScript text), or a Flow model
+  P?: string;   // params. QS: "x,y,z" 
+  HF?: string;  // external handler file (TS 2.0)
+  I?: boolean;  // immediate (run synchronously during render — used by lifecycle init)
+  C?: boolean;  // custom event (triggered via quick.MM.trigger)
+  PE?: boolean; // property event (fires on a property change; charts use this)
+  TO?: number;  // post-render trigger order
+  EV?: boolean; // externally visible (callable from a parent/other qjson)
+  HL: "TS";        // event handlers use TS only
+  SM?: string;  // source map (debug)
+}
+```
+
+- Event handler text uses `\r\n` line breaks.
+- Custom events you call with `quick.MM.trigger('name', [payload])` must be declared with `"C": true`.
+- Events callable from another page/parent need `"EV": true`.
+- Lifecycle init events are often marked `"I": true`.
+- Use `quick.return` (never native `return`); see [scripting knowledge](../knowledge/events-and-scripting.md).
+
+## 5. Children & slots (`IChildJson` / `CType`)
+
+```ts
+interface IChildJson { cType: CTyped; c: Array<ICompJson>; }
+enum CType { child = "child", slot = "slot", scopedSlot = "scopedSlot" }
+```
+
+`C` is keyed by **slot name**:
+
+```json
+"C": {
+  "default":      { "c": [ ...children... ], "cType": "slot" },
+  "item.actions": { "c": [ ...per-row cells... ], "cType": "scopedSlot" }
+}
+```
+
+| `cType` | Meaning (from source) |
+|---------|------------------------|
+| `"slot"` | normal named slot |
+| `"child"` | direct/structural child (Messaging, service components, Ghost) |
+| `"scopedSlot"` | callback slot receiving per-item data (`VDataTable` `item.<col>` — `item` available in child bindings) |
+
+## 6. Options (`IOptJson`)
+
+```ts
+interface IOptJson {
+  cType?: CTyped;                       // matches the node's slot context
+  dynProps?: boolean;                   // dynamic-prop component (e.g. CustomComponent)
+  CL?: ScriptLang;                      // component language (defaults to QS)
+  forceUpdateAfterPropertySetting?: boolean;
+  compDomClasses?: string;              // editor-rendered DOM class string (editor-managed)
+  layout?: ILayoutJson;                 // legacy — see note below; { dOpt: {bp: string[]}, class: string }
+}
+interface ILayoutJson { dOpt: IDictionary<Array<string>>; class: string; }
+```
+
+- **`O.layout` — do not author it here.** It's the pre-`S` legacy layout mechanism (`dOpt` keyed by breakpoint → prefixed tokens, flattened into a synced `class` string). It exists in the schema and the compiler still accepts it, but on an `S`-system page grid width, flex direction/align/justify, and spacing are all `S` params (`col`, `flexDirection`, `alignItems`, `justifyContent`, margins/paddings) — see [knowledge/layout-and-slots.md](../knowledge/layout-and-slots.md) and [knowledge/styling.md](../knowledge/styling.md). (If you are actually editing a legacy page, you are in the wrong doc — see [qjson-schema-legacy.md](qjson-schema-legacy.md).)
+
+## 7. Compiled form (`cJson`) — do not author
+
+When compiled, handler `H` values get wrapped with sentinel delimiters (e.g. `╬...╩╩`) and `cJson`/`clrids` are populated. **AI-authored files omit `cJson`/`clrids` entirely** — never write them into a new file, and strip them from any existing file you edit. Author `pJson`/`lrids`; the editor regenerates the compiled twins on import. See [validation](../knowledge/validation.md).
+
+## 8. Minimal valid node
+
+```json
+{
+  "T": "QLabel",
+  "P": { "ID": { "H": "lblTitle", "T": "prop" },
+         "text": { "H": "'Hello'", "T": "prop" } },
+  "E": {}, "C": {},
+  "O": { "cType": "slot" },
+  "_Editor": { "eID": "lblTitle" }
+}
+```