@sqlanvil/cli 1.24.0 → 1.25.1

package/README.md

@@ -4,7 +4,7 @@
 
 SQLAnvil is an open-source fork of [Dataform OSS](https://github.com/dataform-co/dataform) (Apache 2.0), extended with first-class PostgreSQL, Supabase, and MySQL/MariaDB support. Define your data transformations in SQLX, have SQLAnvil compile them to idiomatic SQL for your warehouse, and run, validate, and document the whole DAG from one CLI.
 
-> **SQLAnvil is not affiliated with or endorsed by Google.** The Dataform name and related marks are trademarks of Google LLC. See [NOTICE](NOTICE) for attribution.
+> **SQLAnvil is not affiliated with or endorsed by Google.** The Dataform name and related marks are trademarks of Google LLC. See [NOTICE](https://github.com/SQLAnvil/sqlanvil/blob/main/NOTICE) for attribution.
 
 ---
 
@@ -86,7 +86,7 @@ Full documentation at **[sqlanvil.com/docs](https://sqlanvil.com/docs/)**.
 - [Validate](https://sqlanvil.com/docs/guides/validate/) · [Named Environments](https://sqlanvil.com/docs/guides/environments/) · [Artifacts & Catalog](https://sqlanvil.com/docs/guides/artifacts/)
 - [Configs Reference](https://sqlanvil.com/docs/reference/configs/) · [What's New](https://sqlanvil.com/docs/whats-new/)
 
-Writing sqlanvil projects with an AI agent? Point it at [`AGENTS.md`](AGENTS.md) — it corrects
+Writing sqlanvil projects with an AI agent? Point it at [`AGENTS.md`](https://github.com/SQLAnvil/sqlanvil/blob/main/AGENTS.md) — it corrects
 the Dataform/BigQuery priors that otherwise produce broken sqlanvil code. Contributor/design
 docs live in the separate [`sqlanvil/docs`](https://github.com/sqlanvil/docs) repo.
 
@@ -123,12 +123,12 @@ bazel test //core/... //cli/...
 ```
 
 A Docker-based build container (`./scripts/docker-bazel`) remains available as an optional
-hermetic environment. See [contributing.md](contributing.md) for full instructions.
+hermetic environment. See [contributing.md](https://github.com/SQLAnvil/sqlanvil/blob/main/contributing.md) for full instructions.
 
 ---
 
 ## License
 
-Apache License 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
+Apache License 2.0. See [LICENSE](https://github.com/SQLAnvil/sqlanvil/blob/main/LICENSE) and [NOTICE](https://github.com/SQLAnvil/sqlanvil/blob/main/NOTICE).
 
 SQLAnvil is a derivative of Dataform OSS (originally developed by Dataform Co and contributed to by Google LLC). It has been fully renamed and extended with first-class PostgreSQL/Supabase/MySQL support. Licensed under Apache License 2.0.

package/bundle.js

@@ -49219,7 +49219,15 @@ function verifyObjectMatchesProto(protoType, object, errorBehaviour = VerifyProt
     if (Array.isArray(object)) {
         throw ReferenceError(`Expected a top-level object, but found an array`);
     }
-    protoType.verify(object);
+    const verificationError = protoType.verify(object);
+    if (verificationError && verifyErrorIsNonPrimitiveInScalarField(verificationError, object)) {
+        if (errorBehaviour === VerifyProtoErrorBehaviour.SUGGEST_REPORTING_TO_DATAFORM_TEAM) {
+            throw ReferenceError(`Invalid property value: ${verificationError}, please report this to the sqlanvil team ` +
+                `at ${REPORT_ISSUE_URL}.`);
+        }
+        throw ReferenceError(`Invalid property value: ${verificationError}.` +
+            maybeGetDocsLinkPrefix(errorBehaviour, protoType));
+    }
     const proto = protoType.create(object);
     const protoCastObject = protoType.toObject(proto);
     function checkFields(present, desired) {
@@ -49254,6 +49262,23 @@ function verifyObjectMatchesProto(protoType, object, errorBehaviour = VerifyProt
     checkFields(object, protoCastObject);
     return proto;
 }
+function verifyErrorIsNonPrimitiveInScalarField(message, root) {
+    if (/object expected|array expected|\{k:/.test(message)) {
+        return false;
+    }
+    const path = message.split(":")[0].trim().split(".");
+    let value = root;
+    for (const segment of path) {
+        if (Array.isArray(value)) {
+            value = value.find(element => element !== null && typeof element === "object" && segment in element);
+        }
+        if (value === null || typeof value !== "object" || !(segment in value)) {
+            return false;
+        }
+        value = value[segment];
+    }
+    return value !== null && typeof value === "object";
+}
 function maybeGetDocsLinkPrefix(errorBehaviour, protoType) {
     return errorBehaviour === VerifyProtoErrorBehaviour.SHOW_DOCS_LINK
         ? ` See ${CONFIGS_PROTO_DOCUMENTATION_URL}#${protoType
@@ -50621,7 +50646,7 @@ function collectEvaluationQueries(queryOrAction, concatenate, queryModifier = (q
         .filter(validationQuery => !!validationQuery.query);
 }
 
-const version = "1.24.0";
+const version = "1.25.1";
 const dataformVersion = "3.0.61";
 
 async function build(compiledGraph, runConfig, dbadapter) {
@@ -51102,6 +51127,25 @@ it gitignored.`);
 - A mysql warehouse cannot read cross-warehouse \`connections:\` (single write warehouse;
   MySQL works as a SOURCE for a Postgres/Supabase project, not the other way).`);
     }
+    const commentMechanics = isPostgresLike
+        ? "`COMMENT ON TABLE|VIEW|MATERIALIZED VIEW|COLUMN`"
+        : isMysql
+            ? "table/column comments (tables + incrementals only — MySQL views can't carry comments)"
+            : "table + column descriptions (nested fields included)";
+    const constraintNote = warehouse === "bigquery"
+        ? "append `NOT ENFORCED` (BigQuery stores them as catalog metadata for query engines)"
+        : "real enforced constraints";
+    sections.push(`## Metadata for AI/BI engines
+
+- \`description:\` + \`columns: {}\` persist into the warehouse catalog on every run as
+  ${commentMechanics} — BI copilots and text-to-SQL agents read them back from there. Name
+  join targets in column descriptions (\`customer_id: "Foreign key to
+  public.customers.customer_id."\`).
+- PK/FK constraints go in \`post_operations\` (no config field for them) — ${constraintNote};
+  on an incremental, wrap the \`ALTER\` in \`\${when(!incremental(), \\\`…\\\`)}\`.
+- \`assertions: { uniqueKey | uniqueKeys: [[…],[…]], nonNull, rowConditions }\` make key
+  claims TESTED on every run (\`uniqueKey\` and \`uniqueKeys\` are mutually exclusive).
+- Guide: https://sqlanvil.com/docs/guides/metadata/`);
     if (converted) {
         sections.push(`## This project was converted from Dataform
 

package/package.json

@@ -46,7 +46,14 @@
         "**/wrap-ansi": "7.0.0",
         "**/string-width": "4.1.0"
     },
-    "homepage": "https://github.com/sqlanvil/sqlanvil",
+    "homepage": "https://sqlanvil.com",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/sqlanvil/sqlanvil.git"
+    },
+    "bugs": {
+        "url": "https://github.com/sqlanvil/sqlanvil/issues"
+    },
     "license": "Apache-2.0",
     "keywords": [
         "sqlanvil",
@@ -64,7 +71,7 @@
     "bin": {
         "sqlanvil": "bundle.js"
     },
-    "version": "1.24.0",
+    "version": "1.25.1",
     "name": "@sqlanvil/cli",
     "description": "sqlanvil command line interface.",
     "main": "bundle.js"