@nanobpm/urban 0.6.0 → 0.7.0

package/dist/runtime/core/host.d.ts

@@ -99,6 +99,10 @@ export interface EngineClient {
         processInstanceKey: string;
         variables?: Record<string, unknown>;
     }>;
+    /** Cancel a running process instance (the pages surface's row-cancel action). */
+    cancelInstance(input: {
+        processInstanceKey: string;
+    }): Promise<void>;
     /** Publish a message for correlation. */
     publishMessage(input: {
         name: string;

package/dist/runtime/core/manifest.d.ts

@@ -36,6 +36,14 @@ export interface SurfaceDecl {
     enabled?: boolean;
     path?: string;
     agent?: string;
+    /** pages surface: directory of `*.page.json` (relative to app root). Default `pages`. */
+    pagesDir?: string;
+    /** pages surface: the page served at `/`. Default `home`. */
+    homePage?: string;
+    /** pages surface: max rows a `dataGrid` fetch returns. Default 200. */
+    rowLimit?: number;
+    /** pages surface: the injected default datasource name. Default `app`. */
+    sourceName?: string;
 }
 export interface AppManifest {
     $schema?: string;

package/dist/runtime/core/modules/gateway.d.ts

@@ -47,6 +47,8 @@ export interface DataSource {
      * (default "id"). */
     table<T extends object = Row>(name: string, pk?: string): Table<T>;
 }
+/** Double-quote a SQL identifier (table/column), escaping embedded quotes. */
+export declare function quoteIdent(name: string): string;
 /** A typed gateway over a single table — the record-oriented data object a handler binds to
  * instead of hand-writing SQL (the Delphi `TTable`/data-module idea, ADR 0029 §6). It builds
  * parameterised SQL from a typed row object's own keys, so callers manipulate rows as records.

package/dist/runtime/core/modules/gateway.js

@@ -11,7 +11,8 @@
 //   const orders = db.table<Order>("orders");   // a typed gateway over one table
 //   await orders.insert({ id, status: "new" });
 //   const o = await orders.get(id);
-function quoteIdent(name) {
+/** Double-quote a SQL identifier (table/column), escaping embedded quotes. */
+export function quoteIdent(name) {
     return `"${name.replaceAll('"', '""')}"`;
 }
 /** Build a parameterised ` WHERE a = ? AND b = ?` clause from an equality map; an empty map

package/dist/runtime/core/modules/pages.d.ts

@@ -0,0 +1,42 @@
+import type { AppApi, RuntimeContext } from "../context.ts";
+import type { EngineClient } from "../host.ts";
+import { type Route } from "../router.ts";
+/** The subset of the datasource gateway the page runtime needs. */
+export interface PagesDataSource {
+    query(sql: string, params?: unknown[]): Promise<Record<string, unknown>[]>;
+    schema(): Promise<{
+        name: string;
+    }[]>;
+}
+export interface PagesOptions {
+    /** Directory holding `*.page.json` (relative to the app root). Default `pages`. */
+    pagesDir?: string;
+    /** The page served at `/`. Default `home`. */
+    homePage?: string;
+    /** Max rows a `dataGrid` fetch returns. Default 200. */
+    rowLimit?: number;
+    /** The injected default datasource name (the alias apps bind to). Default `app`. */
+    sourceName?: string;
+}
+export interface PagesDeps {
+    db: PagesDataSource;
+    engine: EngineClient;
+    /** Read a page file; injectable for tests. */
+    readPage(path: string): Promise<string>;
+}
+/**
+ * Build the page-runtime routes over an injected datasource + engine. Pure over its deps
+ * so it is unit-testable without a real host/server (see pages.test.ts).
+ */
+export declare function createPagesRoutes(opts: PagesOptions, deps: PagesDeps): Route[];
+export interface PagesHandle {
+    readonly name: string;
+    routes: Route[];
+    describe(): Record<string, unknown>;
+}
+/**
+ * Mount the `pages` surface when enabled in the manifest. Binds the page runtime to the
+ * app's datasource gateway (`app.data.open(source)`), engine, and the host's file read.
+ * Returns no routes when the surface is disabled or absent.
+ */
+export declare function mountPages(ctx: RuntimeContext, app: AppApi): PagesHandle;