@jxsuite/schema 0.35.0 → 1.1.0

package/types.ts

@@ -3,7 +3,6 @@ import type { FromSchema } from "json-schema-to-ts";
 import type { headEntrySchema } from "./defs/head-entry.schema";
 import type { imageConfigSchema } from "./defs/image-config.schema";
 import type { cemEventSchema, cemParameterSchema } from "./defs/cem.schema";
-import type { contentTypeDefSchema } from "./defs/content-type-def.schema";
 import type { projectConfigSchema } from "./defs/project-config.schema";
 import type { refObjectSchema } from "./defs/ref-object.schema";
 import type { styleObjectSchema } from "./defs/style-object.schema";
@@ -32,7 +31,6 @@ export namespace Strict {
   export type ImageConfig = FromSchema<typeof imageConfigSchema>;
   export type CemParameter = FromSchema<typeof cemParameterSchema>;
   export type CemEvent = FromSchema<typeof cemEventSchema>;
-  export type ContentTypeDef = FromSchema<typeof contentTypeDefSchema>;
   export type RefObject = FromSchema<typeof refObjectSchema>;
   export type Style = FromSchema<typeof styleObjectSchema>;
   export type Element = FromSchema<typeof elementDefSchema>;
@@ -90,18 +88,29 @@ export type JxExpressionOperand =
   | number
   | boolean
   | null
-  | JxExpressionOperand[];
+  | JxExpressionOperand[]
+  // Plain-object literal (e.g. an Intl options bag); $ref/operator shapes are the members above.
+  | Record<string, JsonValue>;
 
 export interface JxExpressionNode {
   operator: string;
   target: JxExpressionOperand;
   value?: JxExpressionOperand;
   initial?: JxExpressionOperand;
+  /** `switch` only: matched discriminant value (string form) → result operand. */
+  cases?: Record<string, JxExpressionOperand>;
+  /** `switch` only: result operand when no case key matches. */
+  default?: JxExpressionOperand;
 }
 
 /** A state entry (or event binding) whose value is computed from a declarative expression. */
 export interface JxExpressionDef {
   $expression: JxExpressionNode;
+  /**
+   * Named-formula parameters (CEM convention, as on Function entries). Present ⇒ the entry is a
+   * callable formula invoked via the `call` operator, with `$args/<name>` refs in its body.
+   */
+  parameters?: (string | CemParameter)[];
   [key: string]: unknown;
 }
 
@@ -110,11 +119,50 @@ export interface JxExpressionDef {
 // Detection algorithm in buildScope(). Use the guards in `@jxsuite/schema/guards`
 // To discriminate.
 
+// ─── Statement Model (spec §20) ─────────────────────────────────────────────────
+// Structured function bodies: `body` as a statement array instead of opaque JS source,
+// Mirroring ESTree's BlockStatement.body = Statement[].
+
+/** An `{ if, then, else }` branch — the JSON Schema 2020-12 conditional keyword triple. */
+export interface JxIfStatement {
+  if: JxExpressionOperand;
+  then: JxStatement[];
+  else?: JxStatement[];
+}
+
+/** A `{ $switch, cases }` multiway branch in statement position (element-level convention). */
+export interface JxSwitchStatement {
+  $switch: JxExpressionOperand;
+  cases: Record<string, JxStatement[]>;
+  default?: JxStatement[];
+}
+
+/** A WHATWG `dispatchEvent` statement: emits a CustomEvent with CustomEventInit members. */
+export interface JxDispatchStatement {
+  dispatchEvent: string;
+  detail?: JxExpressionOperand;
+  bubbles?: boolean;
+  composed?: boolean;
+}
+
+/**
+ * One statement of a structured function body: a bare expression node in statement position
+ * (mutation or `call`), a branch, a multiway branch, or an event dispatch.
+ */
+export type JxStatement =
+  | JxExpressionNode
+  | JxIfStatement
+  | JxSwitchStatement
+  | JxDispatchStatement;
+
 /** A function declaration: inline `body` or external `$src`/`$export`. */
 export interface JxFunctionDef {
   $prototype: "Function";
-  /** Inline function body. The reactive scope is the implicit first parameter. */
-  body?: string;
+  /**
+   * Inline function body: opaque JS source (the reactive scope is the implicit first parameter) or
+   * a structured statement array (spec §20).
+   */
+  body?: string | JxStatement[];
   /** Parameters after the implicit scope parameter: bare names or CEM parameter objects. */
   parameters?: (string | CemParameter)[];
   /** Explicit function name; defaults to the state key. */
@@ -186,8 +234,6 @@ export interface CemEvent {
   deprecated?: boolean | string;
 }
 
-export type ContentTypeDef = FromSchema<typeof contentTypeDefSchema>;
-
 export type RefObject = FromSchema<typeof refObjectSchema>;
 
 export interface JxStyle {
@@ -445,6 +491,8 @@ export interface DeployConfig {
 }
 
 export interface ProjectConfig {
+  /** Relative path to the generated per-project schema (written by `jx schema`). */
+  $schema?: string;
   name?: string;
   url?: string;
   state?: Record<string, unknown>;
@@ -460,7 +508,12 @@ export interface ProjectConfig {
   };
   images?: ImageConfig;
   imports?: Record<string, string>;
-  contentTypes?: Record<string, ContentTypeDef>;
+  /**
+   * Extension packages: bare package names (resolved project-first) or relative paths. Each must
+   * export jx-extension.json. Extension-contributed sections (e.g. `content`) are opaque top-level
+   * keys absorbed by the index signature.
+   */
+  extensions?: string[];
   /** Redirect map: source path → destination (or destination with HTTP status). */
   redirects?: Record<string, string | { destination: string; status?: number }>;
   defaults?: {
@@ -480,13 +533,15 @@ export interface ProjectConfig {
 export type JxAttributeValue = Bindable<string | number | boolean>;
 
 /**
- * A dynamic-route path source (spec §4.3): content-type based, explicit values, data-file ref, or a
- * legacy array of param objects.
+ * A dynamic-route path source (spec §4.3): explicit values, data-file ref, a legacy array of param
+ * objects, or an extension-discriminated source (an object carrying a `resolvePaths` discriminator
+ * key registered by an enabled extension, e.g. the parser's `contentType` — the extension owns the
+ * narrow shape).
  */
 export type JxPathsDef =
-  | { contentType: string; param?: string; field?: string }
   | { values: JsonValue[]; param?: string }
   | { $ref: string; param?: string; field?: string }
+  | { param?: string; field?: string; [discriminator: string]: unknown }
   | Record<string, JsonValue>[];
 
 /**
@@ -541,6 +596,8 @@ export interface JxMutableNode {
 export type JxPath = (string | number)[];
 
 // ─── Content Type Schema ────────────────────────────────────────────────────────
+// Part-3 cleanup: move to parser — the parser extension owns the content-section shapes now; these
+// Stay here only while the studio still imports them from @jxsuite/schema/types.
 
 /** One field within a content-type JSON schema; recursive for nested objects. */
 export interface ContentTypeSchemaField {
@@ -558,3 +615,29 @@ export interface ContentTypeSchema {
   required?: string[];
   [key: string]: unknown;
 }
+
+// ─── Content Wire Types ─────────────────────────────────────────────────────────
+// Core wire shapes for content loading (specs/extensions.md §8): format classes' `load`
+// Capabilities return ContentLoaderEntry[], and hosts pass the entries through untouched.
+// Extensions implement them; core only threads them.
+
+/** A table-of-contents entry extracted from a loaded content document. */
+export interface TocEntry {
+  depth: number;
+  text: string;
+  id: string;
+}
+
+/** One loaded content entry, as produced by a format class's `load` capability. */
+export interface ContentLoaderEntry {
+  id: string;
+  data: Record<string, unknown>;
+  body: string | null;
+  $children?: (JxElement | string)[];
+  _meta?: {
+    excerpt?: string;
+    toc?: TocEntry[];
+    readingTime?: number;
+    wordCount?: number;
+  };
+}

package/defs/content-type-def.schema.ts

@@ -1,37 +0,0 @@
-export const contentTypeDefSchema = {
-  description:
-    "Content type definition. Defines the source directory, frontmatter schema, and element dependencies.",
-  properties: {
-    $elements: {
-      description: "Custom elements available in markdown directives for this content type.",
-      items: {
-        oneOf: [
-          {
-            properties: { $ref: { type: "string" } },
-            required: ["$ref"],
-            type: "object",
-          },
-          { type: "string" },
-        ],
-      },
-      type: "array",
-    },
-    format: {
-      description:
-        "Import name of a format class declared in the project imports map " +
-        '(e.g. "Markdown", "Csv"). When omitted, the format is derived from the ' +
-        'source file extension via the format registry. "json" is the only built-in.',
-      type: "string",
-    },
-    schema: {
-      description: "JSON Schema for validating frontmatter of content type entries.",
-      type: "object",
-    },
-    source: {
-      description: "Path to the content directory relative to the project root.",
-      examples: ["./content/blog/", "./content/docs/"],
-      type: "string",
-    },
-  },
-  type: "object",
-} as const;