@telorun/sql 0.8.0 → 0.9.0

package/README.md

@@ -23,7 +23,7 @@ Built to be language-agnostic and infinitely extensible.
 
 ```bash
 # Reconcile your manifest into a running backend
-$ telo ./examples/hello-api.yaml
+$ telo ./examples/hello-api
 
 {"level":30,"time":1771610393008,"pid":1310178,"hostname":"dev","msg":"Server listening at http://127.0.0.1:8844"}
 ```
@@ -44,146 +44,7 @@ $ telo ./examples/hello-api.yaml
 
 ## Example manifest
 
-Here is an example Telo application that defines a simple HTTP API:
-
-```yaml
-kind: Telo.Application
-metadata:
-  name: feedback
-  version: 1.0.0
-  description: |
-    A complete feedback collection REST API — no code, pure YAML.
-    Persists entries to SQLite and serves them over HTTP.
-imports:
-  Http: std/http-server@0.12.0
-  Sql: std/sql@0.9.2
-targets:
-  - !ref Migrations
-  - !ref Server
----
-# SQLite database — swap driver/host/database for PostgreSQL with zero YAML changes
-kind: Sql.Connection
-metadata:
-  name: Db
-driver: sqlite
-file: ./tmp/feedback.db
----
-# Migrations: applied automatically before the server starts
-kind: Sql.Migrations
-metadata:
-  name: Migrations
-connection: !ref Db
----
-kind: Sql.Migration
-metadata:
-  name: Migration_20260413_182154_CreateFeedback
-version: 20260413_182154_CreateFeedback
-sql: |
-  CREATE TABLE IF NOT EXISTS feedback (
-    id        INTEGER PRIMARY KEY AUTOINCREMENT,
-    text      TEXT    NOT NULL,
-    source    TEXT,
-    score     INTEGER NOT NULL DEFAULT 0,
-    created_at DATETIME DEFAULT CURRENT_TIMESTAMP
-  )
----
-kind: Http.Server
-metadata:
-  name: Server
-baseUrl: http://localhost:8844
-port: 8844
-logger: true
-openapi:
-  info:
-    title: Feedback API
-    version: 1.0.0
-mounts:
-  - path: /v1
-    mount: !ref FeedbackRoutes
----
-kind: Http.Api
-metadata:
-  name: FeedbackRoutes
-routes:
-  # POST /v1/feedback — insert a new entry, score derived from body length heuristic
-  - request:
-      path: /feedback
-      method: POST
-      schema:
-        body:
-          type: object
-          properties:
-            text:
-              type: string
-              minLength: 1
-            source:
-              type: string
-          required: [ text ]
-    handler:
-      kind: Sql.Exec
-      connection: !ref Db
-    inputs:
-      sql: "INSERT INTO feedback (text, source, score) VALUES (?, ?, ?)"
-      bindings:
-        - "${{ request.body.text }}"
-        - "${{ request.body.source }}"
-        - "${{ size(request.body.text) }}"
-    response:
-      - status: 201
-        headers:
-          Content-Type: application/json
-        body:
-          ok: true
-          message: Feedback received
-
-  # GET /v1/feedback — list all entries, newest first
-  - request:
-      path: /feedback
-      method: GET
-    handler:
-      kind: Sql.Select
-      connection: !ref Db
-      from: feedback
-      columns: [ id, text, source, score, created_at ]
-      orderBy:
-        - { column: created_at, direction: desc }
-    response:
-      - status: 200
-        headers:
-          Content-Type: application/json
-        body: "${{ result.rows }}"
-
-  # GET /v1/feedback/{id} — fetch a single entry
-  - request:
-      path: /feedback/{id}
-      method: GET
-      schema:
-        params:
-          type: object
-          properties:
-            id:
-              type: integer
-          required: [ id ]
-    handler:
-      kind: Sql.Select
-      connection: !ref Db
-      from: feedback
-      columns: [ id, text, source, score, created_at ]
-      where:
-        - { column: id, op: "=", value: "${{ request.params.id }}" }
-    response:
-      - status: 200
-        when: "size(result.rows) > 0"
-        headers:
-          Content-Type: application/json
-        body: "${{ result.rows[0] }}"
-      - status: 404
-        headers:
-          Content-Type: application/json
-        body:
-          ok: false
-          message: Not found
-```
+See [examples/](./examples/) for a list of working applications.
 
 ## Status
 

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export { SqlConnectionResource, createSqlConnection, type SqlDriver, type PlaceholderStyle, } from "./sql-connection-controller.js";
-export { resolveSqlConnection } from "./sql-connection-ref.js";
+export { isSqlConnection, resolveSqlConnection } from "./sql-connection-ref.js";
 export type { SqliteDb, SqliteStatement } from "./sqlite-driver-interface.js";

package/dist/index.js

@@ -1,2 +1,2 @@
 export { SqlConnectionResource, createSqlConnection, } from "./sql-connection-controller.js";
-export { resolveSqlConnection } from "./sql-connection-ref.js";
+export { isSqlConnection, resolveSqlConnection } from "./sql-connection-ref.js";

package/dist/sql-command-controller.js

@@ -10,7 +10,8 @@ class SqlCommandResource {
     async invoke(input) {
         const m = this.manifest;
         const ctx = this.ctx;
-        const connection = resolveSqlConnection(m.connection, ctx) ?? m.transaction?.getConnection();
+        const connection = resolveSqlConnection(m.connection, ctx, () => `Sql.Command "${m.metadata.name}": 'connection'`) ??
+            m.transaction?.getConnection();
         if (!connection) {
             throw new Error("Sql: either 'connection' or 'transaction' must be set");
         }

package/dist/sql-connection-ref.d.ts

@@ -1,8 +1,11 @@
-import type { ResourceContext } from "@telorun/sdk";
+import type { KindRef, ResourceContext } from "@telorun/sdk";
 import type { SqlConnectionResource } from "./sql-connection-controller.js";
-interface ConnectionRef {
-    name: string;
-    alias?: string;
-}
-export declare function resolveSqlConnection(value: SqlConnectionResource | ConnectionRef | undefined, ctx: ResourceContext): SqlConnectionResource | undefined;
-export {};
+/** True when a value already exposes the connection contract (Phase-5 injected). */
+export declare function isSqlConnection(value: unknown): value is SqlConnectionResource;
+/**
+ * Resolve a `connection` `!ref` field to a live connection. The slot is optional
+ * — an unset one yields `undefined` so the caller can fall back to a `transaction`
+ * — but a slot that IS set must resolve. `describe` names the owning resource and
+ * slot, so the failure points at a concrete manifest location.
+ */
+export declare function resolveSqlConnection(value: SqlConnectionResource | KindRef<SqlConnectionResource> | undefined, ctx: ResourceContext, describe: () => string): SqlConnectionResource | undefined;

package/dist/sql-connection-ref.js

@@ -1,24 +1,15 @@
-export function resolveSqlConnection(value, ctx) {
-    if (!value) {
+/** True when a value already exposes the connection contract (Phase-5 injected). */
+export function isSqlConnection(value) {
+    return typeof value?.execute === "function";
+}
+/**
+ * Resolve a `connection` `!ref` field to a live connection. The slot is optional
+ * — an unset one yields `undefined` so the caller can fall back to a `transaction`
+ * — but a slot that IS set must resolve. `describe` names the owning resource and
+ * slot, so the failure points at a concrete manifest location.
+ */
+export function resolveSqlConnection(value, ctx, describe) {
+    if (!value)
         return undefined;
-    }
-    if (typeof value.execute === "function") {
-        return value;
-    }
-    const ref = value;
-    if (typeof ref.name !== "string") {
-        throw new Error("Sql: invalid connection reference");
-    }
-    // Cross-module reference (`!ref Alias.Connection`): a connection resolved
-    // inside a nested library is not Phase-5-injected, so the controller receives
-    // the raw `{name, alias}` ref and must route through the import's exported
-    // scope rather than a bare local lookup.
-    if (ref.alias && ref.alias !== "Self") {
-        const instance = ctx.moduleContext.resolveImportedInstance(ref.alias, ref.name);
-        if (typeof instance?.execute !== "function") {
-            throw new Error(`Sql: connection reference '${ref.alias}.${ref.name}' did not resolve to an exported connection instance.`);
-        }
-        return instance;
-    }
-    return ctx.moduleContext.getInstance(ref.name);
+    return ctx.resolveRef(value, isSqlConnection, describe, "std/sql#Connection");
 }

package/dist/sql-migrations-controller.js

@@ -32,7 +32,7 @@ class SqlMigrationsResource {
         this.ctx = ctx;
     }
     async run() {
-        const conn = resolveSqlConnection(this.manifest.connection, this.ctx) ?? failMissingConnection();
+        const conn = resolveSqlConnection(this.manifest.connection, this.ctx, () => `Sql.Migrations "${this.manifest.metadata.name}": 'connection'`) ?? failMissingConnection();
         const migrations = {};
         // Legacy: standalone `Sql.Migration` resources in the same module scope.
         for (const [, { resource }] of this.ctx.moduleContext.resourceInstances) {

package/dist/sql-query-controller.js

@@ -10,13 +10,15 @@ class SqlQueryResource {
     async invoke(input) {
         const m = this.manifest;
         const ctx = this.ctx;
-        const connection = resolveConnection(m.connection, m.transaction, ctx);
+        const connection = resolveConnection(m.connection, m.transaction, ctx, () => `Sql.Query "${m.metadata.name}": 'connection'`);
         const result = await runSql(connection, m.transaction, input, ctx);
         return { rows: result.rows, rowCount: result.rows.length };
     }
 }
-function resolveConnection(connection, transaction, ctx) {
-    return (resolveSqlConnection(connection, ctx) ?? transaction?.getConnection() ?? failMissingConnection());
+function resolveConnection(connection, transaction, ctx, describe) {
+    return (resolveSqlConnection(connection, ctx, describe) ??
+        transaction?.getConnection() ??
+        failMissingConnection());
 }
 function failMissingConnection() {
     throw new Error("Sql: either 'connection' or 'transaction' must be set");

package/dist/sql-selection-controller.js

@@ -19,7 +19,8 @@ class SqlSelectionResource {
         const having = ctx.expandValue(m.having ?? [], expandCtx);
         const limit = m.limit != null ? ctx.expandValue(m.limit, expandCtx) : undefined;
         const offset = m.offset != null ? ctx.expandValue(m.offset, expandCtx) : undefined;
-        const connection = resolveSqlConnection(m.connection, ctx) ?? m.transaction?.getConnection();
+        const connection = resolveSqlConnection(m.connection, ctx, () => `Sql.Selection "${m.metadata.name}": 'connection'`) ??
+            m.transaction?.getConnection();
         if (!connection) {
             throw new Error("Sql.Selection: either 'connection' or 'transaction' must be set");
         }

package/dist/sql-transaction-controller.js

@@ -8,8 +8,7 @@ export class SqlTransactionResource {
         this.ctx = ctx;
     }
     getConnection() {
-        return (resolveSqlConnection(this.manifest.connection, this.ctx) ??
-            failMissingConnection(this.manifest.metadata.name));
+        return (resolveSqlConnection(this.manifest.connection, this.ctx, () => `Sql.Transaction "${this.manifest.metadata.name}": 'connection'`) ?? failMissingConnection(this.manifest.metadata.name));
     }
     assertActive() {
         if (!currentTxId()) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telorun/sql",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Telo SQL module - SQL database resource kinds for Telo manifests.",
   "keywords": [
     "telo",
@@ -70,7 +70,7 @@
   "devDependencies": {
     "@types/node": "^20.0.0",
     "typescript": "^5.0.0",
-    "@telorun/sdk": "0.34.0"
+    "@telorun/sdk": "0.54.0"
   },
   "peerDependencies": {
     "@telorun/sdk": "*"

package/src/index.ts

@@ -4,5 +4,5 @@ export {
   type SqlDriver,
   type PlaceholderStyle,
 } from "./sql-connection-controller.js";
-export { resolveSqlConnection } from "./sql-connection-ref.js";
+export { isSqlConnection, resolveSqlConnection } from "./sql-connection-ref.js";
 export type { SqliteDb, SqliteStatement } from "./sqlite-driver-interface.js";

package/src/sql-command-controller.ts

@@ -25,7 +25,9 @@ class SqlCommandResource implements ResourceInstance {
     const m = this.manifest;
     const ctx = this.ctx;
 
-    const connection = resolveSqlConnection(m.connection, ctx) ?? m.transaction?.getConnection();
+    const connection =
+      resolveSqlConnection(m.connection, ctx, () => `Sql.Command "${m.metadata.name}": 'connection'`) ??
+      m.transaction?.getConnection();
     if (!connection) {
       throw new Error("Sql: either 'connection' or 'transaction' must be set");
     }

package/src/sql-connection-ref.ts

@@ -1,41 +1,22 @@
-import type { ResourceContext } from "@telorun/sdk";
+import type { KindRef, ResourceContext } from "@telorun/sdk";
 import type { SqlConnectionResource } from "./sql-connection-controller.js";
 
-interface ConnectionRef {
-  name: string;
-  alias?: string;
+/** True when a value already exposes the connection contract (Phase-5 injected). */
+export function isSqlConnection(value: unknown): value is SqlConnectionResource {
+  return typeof (value as SqlConnectionResource | undefined)?.execute === "function";
 }
 
+/**
+ * Resolve a `connection` `!ref` field to a live connection. The slot is optional
+ * — an unset one yields `undefined` so the caller can fall back to a `transaction`
+ * — but a slot that IS set must resolve. `describe` names the owning resource and
+ * slot, so the failure points at a concrete manifest location.
+ */
 export function resolveSqlConnection(
-  value: SqlConnectionResource | ConnectionRef | undefined,
+  value: SqlConnectionResource | KindRef<SqlConnectionResource> | undefined,
   ctx: ResourceContext,
+  describe: () => string,
 ): SqlConnectionResource | undefined {
-  if (!value) {
-    return undefined;
-  }
-
-  if (typeof (value as SqlConnectionResource).execute === "function") {
-    return value as SqlConnectionResource;
-  }
-
-  const ref = value as ConnectionRef;
-  if (typeof ref.name !== "string") {
-    throw new Error("Sql: invalid connection reference");
-  }
-
-  // Cross-module reference (`!ref Alias.Connection`): a connection resolved
-  // inside a nested library is not Phase-5-injected, so the controller receives
-  // the raw `{name, alias}` ref and must route through the import's exported
-  // scope rather than a bare local lookup.
-  if (ref.alias && ref.alias !== "Self") {
-    const instance = ctx.moduleContext.resolveImportedInstance(ref.alias, ref.name);
-    if (typeof (instance as SqlConnectionResource | undefined)?.execute !== "function") {
-      throw new Error(
-        `Sql: connection reference '${ref.alias}.${ref.name}' did not resolve to an exported connection instance.`,
-      );
-    }
-    return instance as unknown as SqlConnectionResource;
-  }
-
-  return ctx.moduleContext.getInstance(ref.name) as SqlConnectionResource;
+  if (!value) return undefined;
+  return ctx.resolveRef(value, isSqlConnection, describe, "std/sql#Connection");
 }

package/src/sql-migrations-controller.ts

@@ -56,7 +56,11 @@ class SqlMigrationsResource implements ResourceInstance {
 
   async run(): Promise<void> {
     const conn =
-      resolveSqlConnection(this.manifest.connection, this.ctx) ?? failMissingConnection();
+      resolveSqlConnection(
+        this.manifest.connection,
+        this.ctx,
+        () => `Sql.Migrations "${this.manifest.metadata.name}": 'connection'`,
+      ) ?? failMissingConnection();
 
     const migrations: Record<string, string[]> = {};
     // Legacy: standalone `Sql.Migration` resources in the same module scope.

package/src/sql-query-controller.ts

@@ -28,7 +28,12 @@ class SqlQueryResource implements ResourceInstance {
   async invoke(input: unknown): Promise<SqlResult> {
     const m = this.manifest;
     const ctx = this.ctx;
-    const connection = resolveConnection(m.connection, m.transaction, ctx);
+    const connection = resolveConnection(
+      m.connection,
+      m.transaction,
+      ctx,
+      () => `Sql.Query "${m.metadata.name}": 'connection'`,
+    );
     const result = await runSql(connection, m.transaction, input, ctx);
     return { rows: result.rows, rowCount: result.rows.length };
   }
@@ -38,9 +43,12 @@ function resolveConnection(
   connection: SqlConnectionResource | undefined,
   transaction: SqlTransactionResource | undefined,
   ctx: ResourceContext,
+  describe: () => string,
 ): SqlConnectionResource {
   return (
-    resolveSqlConnection(connection, ctx) ?? transaction?.getConnection() ?? failMissingConnection()
+    resolveSqlConnection(connection, ctx, describe) ??
+    transaction?.getConnection() ??
+    failMissingConnection()
   );
 }
 

package/src/sql-selection-controller.ts

@@ -96,7 +96,9 @@ class SqlSelectionResource implements ResourceInstance {
     const limit = m.limit != null ? ctx.expandValue(m.limit, expandCtx) : undefined;
     const offset = m.offset != null ? ctx.expandValue(m.offset, expandCtx) : undefined;
 
-    const connection = resolveSqlConnection(m.connection, ctx) ?? m.transaction?.getConnection();
+    const connection =
+      resolveSqlConnection(m.connection, ctx, () => `Sql.Selection "${m.metadata.name}": 'connection'`) ??
+      m.transaction?.getConnection();
     if (!connection) {
       throw new Error("Sql.Selection: either 'connection' or 'transaction' must be set");
     }

package/src/sql-transaction-controller.ts

@@ -18,8 +18,11 @@ export class SqlTransactionResource implements ResourceInstance {
 
   getConnection(): SqlConnectionResource {
     return (
-      resolveSqlConnection(this.manifest.connection, this.ctx) ??
-      failMissingConnection(this.manifest.metadata.name)
+      resolveSqlConnection(
+        this.manifest.connection,
+        this.ctx,
+        () => `Sql.Transaction "${this.manifest.metadata.name}": 'connection'`,
+      ) ?? failMissingConnection(this.manifest.metadata.name)
     );
   }