@pylonts/dsl 1.1.4 → 1.1.6

package/src/page-def.ts

@@ -1,80 +1,80 @@
-import type { ImportableSchemaBase, CollectionSchemaBase, SchemaBase } from './dsl.js';
-import { DtoField } from './dto.js';
-import type { DtoMessage, DtoArrayField, DtoObjectField } from './dto.js';
-import type { ComponentSchema } from './component.js';
-import type { ActionSchema } from './action.js';
-
-export type { RouteDataSchema } from './route.js';
-export { defineRouteData } from './route.js';
-
-// PageDef: a page skeleton declaration. Describes what data a page needs
-// and where each field comes from (route params, provider calls, or literals).
-// Driver identifies the source by inspecting each field's .schema back-reference.
-
-/** Page lifecycle events that trigger data loading. */
-export interface EventSchema extends SchemaBase {
-  type: 'onLoad' | 'onShow' | 'onHide' | 'onPullDownRefresh' | 'onReachBottom';
-  /** Actions that fire when this event occurs. */
-  actions?: ActionSchema[];
-}
-
-export const events = {
-  onLoad(actions?: ActionSchema[], description?: string): EventSchema {
-    return { name: 'onLoad', type: 'onLoad', actions, description };
-  },
-  onShow(actions?: ActionSchema[], description?: string): EventSchema {
-    return { name: 'onShow', type: 'onShow', actions, description };
-  },
-  onHide(actions?: ActionSchema[], description?: string): EventSchema {
-    return { name: 'onHide', type: 'onHide', actions, description };
-  },
-  onPullDownRefresh(actions?: ActionSchema[], description?: string): EventSchema {
-    return { name: 'onPullDownRefresh', type: 'onPullDownRefresh', actions, description };
-  },
-  onReachBottom(actions?: ActionSchema[], description?: string): EventSchema {
-    return { name: 'onReachBottom', type: 'onReachBottom', actions, description };
-  },
-};
-
-/** Page data: a named collection of fields that defines the page's data shape. */
-export interface PageDataSchema extends CollectionSchemaBase {
-  type: 'pageData';
-  fields: Record<string, DtoField | DtoMessage | DtoArrayField | DtoObjectField>;
-}
-
-export function definePageData(fields: PageDataSchema['fields']): PageDataSchema {
-  // Page data has no meaningful identity of its own; the page name already
-  // scopes it, so the schema name defaults to 'data'.
-  const data: PageDataSchema = { name: 'data', type: 'pageData', fields };
-  // Write back field names (same convention as buildMessage) so defineRef
-  // produces refs with a real field name instead of ''.
-  for (const key of Object.keys(data.fields)) {
-    const df = data.fields[key];
-    if (df instanceof DtoField) {
-      df.name = key;
-      df.schema = data;
-    }
-  }
-  return data;
-}
-
-/** Page skeleton definition. */
-export interface PageDef extends ImportableSchemaBase {
-  data: PageDataSchema;
-  /** Lifecycle events that trigger data loading. */
-  events: EventSchema[];
-  /** Page actions (provider calls, navigation, etc.). */
-  actions: ActionSchema[];
-  /** UI component declarations that make up the page skeleton. */
-  components: ComponentSchema[];
-  /** Whether the driver should generate page-level loading / error / empty state wrappers. */
-  handleStates?: boolean;
-}
-
-/** Define a page skeleton. */
-export function definePageDef(
-  name: string,
-  schema: Omit<PageDef, 'name'>,
-): PageDef {
-  return { name, ...schema };
+import type { ImportableSchemaBase, CollectionSchemaBase, SchemaBase } from './dsl.js';
+import { DtoField } from './dto.js';
+import type { DtoMessage, DtoArrayField, DtoObjectField } from './dto.js';
+import type { ComponentSchema } from './component.js';
+import type { ActionSchema } from './action.js';
+
+export type { RouteDataSchema } from './route.js';
+export { defineRouteData } from './route.js';
+
+// PageDef: a page skeleton declaration. Describes what data a page needs
+// and where each field comes from (route params, provider calls, or literals).
+// Driver identifies the source by inspecting each field's .schema back-reference.
+
+/** Page lifecycle events that trigger data loading. */
+export interface EventSchema extends SchemaBase {
+  type: 'onLoad' | 'onShow' | 'onHide' | 'onPullDownRefresh' | 'onReachBottom';
+  /** Actions that fire when this event occurs. */
+  actions?: ActionSchema[];
+}
+
+export const events = {
+  onLoad(actions?: ActionSchema[], description?: string): EventSchema {
+    return { name: 'onLoad', type: 'onLoad', actions, description };
+  },
+  onShow(actions?: ActionSchema[], description?: string): EventSchema {
+    return { name: 'onShow', type: 'onShow', actions, description };
+  },
+  onHide(actions?: ActionSchema[], description?: string): EventSchema {
+    return { name: 'onHide', type: 'onHide', actions, description };
+  },
+  onPullDownRefresh(actions?: ActionSchema[], description?: string): EventSchema {
+    return { name: 'onPullDownRefresh', type: 'onPullDownRefresh', actions, description };
+  },
+  onReachBottom(actions?: ActionSchema[], description?: string): EventSchema {
+    return { name: 'onReachBottom', type: 'onReachBottom', actions, description };
+  },
+};
+
+/** Page data: a named collection of fields that defines the page's data shape. */
+export interface PageDataSchema extends CollectionSchemaBase {
+  type: 'pageData';
+  fields: Record<string, DtoField | DtoMessage | DtoArrayField | DtoObjectField>;
+}
+
+export function definePageData(fields: PageDataSchema['fields']): PageDataSchema {
+  // Page data has no meaningful identity of its own; the page name already
+  // scopes it, so the schema name defaults to 'data'.
+  const data: PageDataSchema = { name: 'data', type: 'pageData', fields };
+  // Write back field names (same convention as buildMessage) so defineRef
+  // produces refs with a real field name instead of ''.
+  for (const key of Object.keys(data.fields)) {
+    const df = data.fields[key];
+    if (df instanceof DtoField) {
+      df.name = key;
+      df.schema = data;
+    }
+  }
+  return data;
+}
+
+/** Page skeleton definition. */
+export interface PageDef extends ImportableSchemaBase {
+  data: PageDataSchema;
+  /** Lifecycle events that trigger data loading. */
+  events: EventSchema[];
+  /** Page actions (provider calls, navigation, etc.). */
+  actions: ActionSchema[];
+  /** UI component declarations that make up the page skeleton. */
+  components: ComponentSchema[];
+  /** Whether the driver should generate page-level loading / error / empty state wrappers. */
+  handleStates?: boolean;
+}
+
+/** Define a page skeleton. */
+export function definePageDef(
+  name: string,
+  schema: Omit<PageDef, 'name'>,
+): PageDef {
+  return { name, ...schema };
 }

package/src/page-flow.ts

@@ -1,154 +1,154 @@
-import { SchemaBase } from './dsl.js';
-import type { ActionSchema } from './action.js';
-import { Page, getRegisteredPages, clearRegisteredPages } from './page.js';
-import type { PageDef } from './page-def.js';
-import type { NavigationAction } from './navigation.js';
-
-// Page-driven flow: every node is a page, and a page belongs to an app.
-// Leaf nodes are pages too — a journey starts at a page and ends at a page.
-// Page definitions (PageSchema/Page/actions) live in page.ts; this file
-// models the flow graph between pages.
-
-export interface PageEdge extends SchemaBase {
-  /** Trigger action; undefined = default path (success/normal). */
-  when?: ActionSchema;
-  start: Page;
-  end: Page;
-}
-
-export interface PageFlow extends SchemaBase {
-  /** Entry page. */
-  start: Page;
-  /** All pages explicitly declared by the caller. */
-  pages: Page[];
-  edges: PageEdge[];
-}
-
-export function pageEdge(start: Page, end: Page, when?: ActionSchema, description?: string): PageEdge {
-  // Auto name for uniformity with SchemaBase; `when` stays the branch marker.
-  return { name: `${start.name}->${end.name}`, start, end, when, description };
-}
-
-export function definePageFlow(
-  name: string,
-  schema: {
-    start: Page;
-    pages: Page[];
-    edges: PageEdge[];
-    description?: string;
-  },
-): PageFlow {
-  const { start, pages, edges: explicitEdges, description } = schema;
-
-  // Resolve the back action from any page's actions list (PageSchema at runtime)
-  const backAction = findBackAction(pages);
-
-  // Auto-generate back edges: for every explicit edge A→B (not itself a back),
-  // if B has no explicit back edge and no existing edge B→A, add B→A with back.
-  const hasExplicitBack = new Set<Page>();
-  for (const e of explicitEdges) {
-    if (e.when && e.when.name === 'back') hasExplicitBack.add(e.start);
-  }
-  const hasReverse = new Set<string>();
-  for (const e of explicitEdges) {
-    hasReverse.add(`${e.start.name}->${e.end.name}`);
-  }
-  const generatedBackEdges: PageEdge[] = [];
-  if (backAction) {
-    for (const e of explicitEdges) {
-      if (e.when && e.when.name === 'back') continue;
-      if (hasExplicitBack.has(e.end)) continue;
-      if (hasReverse.has(`${e.end.name}->${e.start.name}`)) continue;
-      generatedBackEdges.push({
-        name: `${e.end.name}->${e.start.name}`,
-        start: e.end,
-        end: e.start,
-        when: backAction,
-        description: 'auto-generated back edge',
-      });
-      hasExplicitBack.add(e.end);
-    }
-  }
-  const edges = [...explicitEdges, ...generatedBackEdges];
-
-  // Validate: every registered page must be in the flow's pages
-  const registered = getRegisteredPages();
-  const orphaned: string[] = [];
-  for (const rp of registered) {
-    // Compare by object identity — caller passes the same reference
-    if (!pages.includes(rp as unknown as Page)) {
-      orphaned.push(rp.name);
-    }
-  }
-  if (orphaned.length > 0) {
-    throw new Error(
-      `[definePageFlow "${name}"] orphaned pages (defined but not in flow): ${orphaned.join(', ')}`,
-    );
-  }
-  clearRegisteredPages();
-
-  // Validate: start must be in pages
-  if (!pages.includes(start)) {
-    throw new Error(
-      `[definePageFlow "${name}"] start page "${start.name}" not in pages`,
-    );
-  }
-
-  // Validate: every page appears in at least one edge
-  const inEdge = new Set<Page>();
-  for (const e of edges) {
-    inEdge.add(e.start);
-    inEdge.add(e.end);
-  }
-  const isolated: string[] = [];
-  for (const p of pages) {
-    if (!inEdge.has(p)) isolated.push(p.name);
-  }
-  if (isolated.length > 0) {
-    throw new Error(
-      `[definePageFlow "${name}"] isolated pages (no edges): ${isolated.join(', ')}`,
-    );
-  }
-
-  // Validate: all pages reachable from start
-  const adj = new Map<Page, Page[]>();
-  for (const p of pages) adj.set(p, []);
-  for (const e of edges) {
-    const neighbors = adj.get(e.start);
-    if (neighbors) neighbors.push(e.end);
-  }
-  const visited = new Set<Page>();
-  const stack: Page[] = [start];
-  while (stack.length > 0) {
-    const cur = stack.pop()!;
-    if (visited.has(cur)) continue;
-    visited.add(cur);
-    for (const next of adj.get(cur) ?? []) {
-      if (!visited.has(next)) stack.push(next);
-    }
-  }
-  const unreachable: string[] = [];
-  for (const p of pages) {
-    if (!visited.has(p)) unreachable.push(p.name);
-  }
-  if (unreachable.length > 0) {
-    throw new Error(
-      `[definePageFlow "${name}"] unreachable pages: ${unreachable.join(', ')}`,
-    );
-  }
-
-  return { name, description, start, pages, edges };
-}
-
-/** Walk all pages' pageDef.actions (PageSchema runtime shape) to find a NavigationAction with method 'back'. */
-function findBackAction(pages: Page[]): NavigationAction | undefined {
-  for (const p of pages) {
-    const pageDef = (p as unknown as Record<string, unknown>).pageDef as PageDef | undefined;
-    if (!pageDef?.actions) continue;
-    for (const a of pageDef.actions) {
-      const na = a as NavigationAction;
-      if (na.type === 'navigation' && na.method === 'back') return na;
-    }
-  }
-  return undefined;
+import { SchemaBase } from './dsl.js';
+import type { ActionSchema } from './action.js';
+import { Page, getRegisteredPages, clearRegisteredPages } from './page.js';
+import type { PageDef } from './page-def.js';
+import type { NavigationAction } from './navigation.js';
+
+// Page-driven flow: every node is a page, and a page belongs to an app.
+// Leaf nodes are pages too — a journey starts at a page and ends at a page.
+// Page definitions (PageSchema/Page/actions) live in page.ts; this file
+// models the flow graph between pages.
+
+export interface PageEdge extends SchemaBase {
+  /** Trigger action; undefined = default path (success/normal). */
+  when?: ActionSchema;
+  start: Page;
+  end: Page;
+}
+
+export interface PageFlow extends SchemaBase {
+  /** Entry page. */
+  start: Page;
+  /** All pages explicitly declared by the caller. */
+  pages: Page[];
+  edges: PageEdge[];
+}
+
+export function pageEdge(start: Page, end: Page, when?: ActionSchema, description?: string): PageEdge {
+  // Auto name for uniformity with SchemaBase; `when` stays the branch marker.
+  return { name: `${start.name}->${end.name}`, start, end, when, description };
+}
+
+export function definePageFlow(
+  name: string,
+  schema: {
+    start: Page;
+    pages: Page[];
+    edges: PageEdge[];
+    description?: string;
+  },
+): PageFlow {
+  const { start, pages, edges: explicitEdges, description } = schema;
+
+  // Resolve the back action from any page's actions list (PageSchema at runtime)
+  const backAction = findBackAction(pages);
+
+  // Auto-generate back edges: for every explicit edge A→B (not itself a back),
+  // if B has no explicit back edge and no existing edge B→A, add B→A with back.
+  const hasExplicitBack = new Set<Page>();
+  for (const e of explicitEdges) {
+    if (e.when && e.when.name === 'back') hasExplicitBack.add(e.start);
+  }
+  const hasReverse = new Set<string>();
+  for (const e of explicitEdges) {
+    hasReverse.add(`${e.start.name}->${e.end.name}`);
+  }
+  const generatedBackEdges: PageEdge[] = [];
+  if (backAction) {
+    for (const e of explicitEdges) {
+      if (e.when && e.when.name === 'back') continue;
+      if (hasExplicitBack.has(e.end)) continue;
+      if (hasReverse.has(`${e.end.name}->${e.start.name}`)) continue;
+      generatedBackEdges.push({
+        name: `${e.end.name}->${e.start.name}`,
+        start: e.end,
+        end: e.start,
+        when: backAction,
+        description: 'auto-generated back edge',
+      });
+      hasExplicitBack.add(e.end);
+    }
+  }
+  const edges = [...explicitEdges, ...generatedBackEdges];
+
+  // Validate: every registered page must be in the flow's pages
+  const registered = getRegisteredPages();
+  const orphaned: string[] = [];
+  for (const rp of registered) {
+    // Compare by object identity — caller passes the same reference
+    if (!pages.includes(rp as unknown as Page)) {
+      orphaned.push(rp.name);
+    }
+  }
+  if (orphaned.length > 0) {
+    throw new Error(
+      `[definePageFlow "${name}"] orphaned pages (defined but not in flow): ${orphaned.join(', ')}`,
+    );
+  }
+  clearRegisteredPages();
+
+  // Validate: start must be in pages
+  if (!pages.includes(start)) {
+    throw new Error(
+      `[definePageFlow "${name}"] start page "${start.name}" not in pages`,
+    );
+  }
+
+  // Validate: every page appears in at least one edge
+  const inEdge = new Set<Page>();
+  for (const e of edges) {
+    inEdge.add(e.start);
+    inEdge.add(e.end);
+  }
+  const isolated: string[] = [];
+  for (const p of pages) {
+    if (!inEdge.has(p)) isolated.push(p.name);
+  }
+  if (isolated.length > 0) {
+    throw new Error(
+      `[definePageFlow "${name}"] isolated pages (no edges): ${isolated.join(', ')}`,
+    );
+  }
+
+  // Validate: all pages reachable from start
+  const adj = new Map<Page, Page[]>();
+  for (const p of pages) adj.set(p, []);
+  for (const e of edges) {
+    const neighbors = adj.get(e.start);
+    if (neighbors) neighbors.push(e.end);
+  }
+  const visited = new Set<Page>();
+  const stack: Page[] = [start];
+  while (stack.length > 0) {
+    const cur = stack.pop()!;
+    if (visited.has(cur)) continue;
+    visited.add(cur);
+    for (const next of adj.get(cur) ?? []) {
+      if (!visited.has(next)) stack.push(next);
+    }
+  }
+  const unreachable: string[] = [];
+  for (const p of pages) {
+    if (!visited.has(p)) unreachable.push(p.name);
+  }
+  if (unreachable.length > 0) {
+    throw new Error(
+      `[definePageFlow "${name}"] unreachable pages: ${unreachable.join(', ')}`,
+    );
+  }
+
+  return { name, description, start, pages, edges };
+}
+
+/** Walk all pages' pageDef.actions (PageSchema runtime shape) to find a NavigationAction with method 'back'. */
+function findBackAction(pages: Page[]): NavigationAction | undefined {
+  for (const p of pages) {
+    const pageDef = (p as unknown as Record<string, unknown>).pageDef as PageDef | undefined;
+    if (!pageDef?.actions) continue;
+    for (const a of pageDef.actions) {
+      const na = a as NavigationAction;
+      if (na.type === 'navigation' && na.method === 'back') return na;
+    }
+  }
+  return undefined;
 }

package/src/page.ts

@@ -1,77 +1,77 @@
-import { SchemaBase } from './dsl.js';
-import { FrontAppSchema } from './project.js';
-import type { PageDef } from './page-def.js';
-import type { RouteDataSchema } from './route.js';
-
-// Page definitions: standalone page schemas and the page node type used by
-// page-driven flows. Kept separate from page-flow.ts (the flow graph itself).
-
-// Module-level registry: every definePage/defineTabPage call registers its
-// result so definePageFlow can check that no page is left out.
-const _pageRegistry = new Set<PageSchema>();
-
-export function getRegisteredPages(): ReadonlySet<PageSchema> {
-  return _pageRegistry;
-}
-
-export function clearRegisteredPages(): void {
-  _pageRegistry.clear();
-}
-
-/** Standalone page definition. A page is a shared value object: it belongs to
- *  exactly one frontend app. Actions live in the page skeleton (PageDef.actions),
- *  not on the page itself — the page only carries what the flow/topology needs. */
-export interface PageSchema extends SchemaBase {
-  /** Short display name for topology diagrams. */
-  label: string;
-  /** The frontend app this page belongs to (shared instance from project.config). */
-  app: FrontAppSchema;
-  /** Full page skeleton definition (optional). */
-  pageDef?: PageDef;
-  /** Route params this page expects (e.g. detail page expects productId). */
-  params?: RouteDataSchema;
-}
-
-export function definePage(schema: {
-  name: string;
-  label: string;
-  description?: string;
-  app: FrontAppSchema;
-  pageDef?: PageDef;
-  params?: RouteDataSchema;
-}): PageSchema {
-  const p: PageSchema = { ...schema };
-  _pageRegistry.add(p);
-  return p;
-}
-
-/** Page with bottom tab navigation. tabs collects the child pages reachable via tab switch. */
-export interface TabPageSchema extends PageSchema {
-  tabs: PageSchema[];
-}
-
-export function defineTabPage(schema: {
-  name: string;
-  label: string;
-  description?: string;
-  app: FrontAppSchema;
-  tabs: PageSchema[];
-  pageDef?: PageDef;
-  params?: RouteDataSchema;
-}): TabPageSchema {
-  const p: TabPageSchema = { ...schema };
-  _pageRegistry.add(p);
-  return p;
-}
-
-/** A page node in a page-driven flow: every node is a page, and a page belongs to an app. */
-export interface Page extends SchemaBase {
-  /** Short display name for topology diagrams. */
-  label?: string;
-  /** The frontend app this page belongs to (shared instance from project.config). */
-  app: FrontAppSchema;
-}
-
-export function page(app: FrontAppSchema, name: string, description?: string, label?: string): Page {
-  return { name, label, app, description };
+import { SchemaBase } from './dsl.js';
+import { FrontAppSchema } from './project.js';
+import type { PageDef } from './page-def.js';
+import type { RouteDataSchema } from './route.js';
+
+// Page definitions: standalone page schemas and the page node type used by
+// page-driven flows. Kept separate from page-flow.ts (the flow graph itself).
+
+// Module-level registry: every definePage/defineTabPage call registers its
+// result so definePageFlow can check that no page is left out.
+const _pageRegistry = new Set<PageSchema>();
+
+export function getRegisteredPages(): ReadonlySet<PageSchema> {
+  return _pageRegistry;
+}
+
+export function clearRegisteredPages(): void {
+  _pageRegistry.clear();
+}
+
+/** Standalone page definition. A page is a shared value object: it belongs to
+ *  exactly one frontend app. Actions live in the page skeleton (PageDef.actions),
+ *  not on the page itself — the page only carries what the flow/topology needs. */
+export interface PageSchema extends SchemaBase {
+  /** Short display name for topology diagrams. */
+  label: string;
+  /** The frontend app this page belongs to (shared instance from project.config). */
+  app: FrontAppSchema;
+  /** Full page skeleton definition (optional). */
+  pageDef?: PageDef;
+  /** Route params this page expects (e.g. detail page expects productId). */
+  params?: RouteDataSchema;
+}
+
+export function definePage(schema: {
+  name: string;
+  label: string;
+  description?: string;
+  app: FrontAppSchema;
+  pageDef?: PageDef;
+  params?: RouteDataSchema;
+}): PageSchema {
+  const p: PageSchema = { ...schema };
+  _pageRegistry.add(p);
+  return p;
+}
+
+/** Page with bottom tab navigation. tabs collects the child pages reachable via tab switch. */
+export interface TabPageSchema extends PageSchema {
+  tabs: PageSchema[];
+}
+
+export function defineTabPage(schema: {
+  name: string;
+  label: string;
+  description?: string;
+  app: FrontAppSchema;
+  tabs: PageSchema[];
+  pageDef?: PageDef;
+  params?: RouteDataSchema;
+}): TabPageSchema {
+  const p: TabPageSchema = { ...schema };
+  _pageRegistry.add(p);
+  return p;
+}
+
+/** A page node in a page-driven flow: every node is a page, and a page belongs to an app. */
+export interface Page extends SchemaBase {
+  /** Short display name for topology diagrams. */
+  label?: string;
+  /** The frontend app this page belongs to (shared instance from project.config). */
+  app: FrontAppSchema;
+}
+
+export function page(app: FrontAppSchema, name: string, description?: string, label?: string): Page {
+  return { name, label, app, description };
 }