@clivly/core 0.1.0 → 0.2.0

package/dist/view-compiler.cjs

@@ -0,0 +1,188 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/view-compiler.ts
+/**
+* View compiler (Phase 2) — turns a validated entity config into read-only
+* Postgres view DDL.
+*
+* Each entity compiles to `crm_src_<entity>`: a projection over the host table
+* that (a) selects the source primary key as `id` (the sync engine's
+* `source_ref`), (b) aliases mapped columns to their Clivly field names,
+* (c) resolves each relationship to a `<relationship>_ref` column carrying the
+* host-side key, and (d) applies the entity's filter as a WHERE clause.
+*
+* The view is the security boundary: it exposes only allow-listed columns, and
+* the sync engine (Phase 3) reads exclusively from it — never the raw table.
+* Relationship refs stay host-side keys here; Phase 3 maps `<rel>_ref` onto the
+* corresponding `crm_companies.id` mirror row.
+*
+* Pure string generation — no DB access. Config is developer-authored, but all
+* identifiers and literals are still escaped so output is deterministic and
+* injection-safe.
+*/
+/** The source primary-key column. Assumed `id`; the sync engine reads it as `source_ref`. */
+const SOURCE_KEY = "id";
+const DEFAULT_VIEW_PREFIX = "crm_src_";
+const DEFAULT_ROLE = "primary";
+/** Quote a single identifier part, escaping embedded double-quotes. */
+function quoteIdent(name) {
+	return `"${name.replace(/"/g, "\"\"")}"`;
+}
+/** Emit a SQL literal for a scalar filter value. */
+function quoteLiteral(value) {
+	if (typeof value === "number") return String(value);
+	if (typeof value === "boolean") return value ? "TRUE" : "FALSE";
+	return `'${value.replace(/'/g, "''")}'`;
+}
+function quoteList(values) {
+	return `(${values.map((v) => quoteLiteral(v)).join(", ")})`;
+}
+/** Compile one column predicate into a SQL boolean expression. */
+function compilePredicate(table, column, value) {
+	const col = `${quoteIdent(table)}.${quoteIdent(column)}`;
+	if (value === null || typeof value !== "object") return `${col} = ${quoteLiteral(value)}`;
+	if ("eq" in value) return `${col} = ${quoteLiteral(value.eq)}`;
+	if ("ne" in value) return `${col} <> ${quoteLiteral(value.ne)}`;
+	if ("in" in value) return `${col} IN ${quoteList(value.in)}`;
+	if ("notIn" in value) return `${col} NOT IN ${quoteList(value.notIn)}`;
+	if ("isNull" in value) return `${col} IS NULL`;
+	if ("isNotNull" in value) return `${col} IS NOT NULL`;
+	throw new Error(`unsupported filter predicate on ${table}.${column}`);
+}
+/**
+* Build the WHERE conditions for an entity. Returns an array of SQL fragments
+* (ANDed by the caller). `$raw` filters pass through verbatim.
+*/
+function compileFilterConditions(table, filter) {
+	if (!filter) return [];
+	if ("$raw" in filter) return [`(${filter.$raw})`];
+	return Object.entries(filter).map(([column, value]) => compilePredicate(table, column, value));
+}
+/** Split a `table.column` ref, defaulting the table when unqualified. */
+function refParts(ref, defaultTable) {
+	const dot = ref.indexOf(".");
+	if (dot === -1) return {
+		table: defaultTable,
+		column: ref
+	};
+	return {
+		table: ref.slice(0, dot),
+		column: ref.slice(dot + 1)
+	};
+}
+function compileRelationship(relName, rel, source, related) {
+	const refCol = `${relName}_ref`;
+	const refAlias = quoteIdent(refCol);
+	const { via } = rel;
+	if ("fkOn" in via) {
+		const relatedTable = related?.source ?? "";
+		if (via.fkOn === "company") {
+			const { table, column } = refParts(via.column, relatedTable);
+			const relatedFilter = compileFilterConditions(table, related?.filter);
+			const on = [`${quoteIdent(table)}.${quoteIdent(column)} = ${quoteIdent(source.source)}.${quoteIdent(SOURCE_KEY)}`, ...relatedFilter].join(" AND ");
+			return {
+				clause: `LEFT JOIN ${quoteIdent(table)} ON ${on}`,
+				refSelect: `${quoteIdent(table)}.${quoteIdent(SOURCE_KEY)} AS ${refAlias}`,
+				refColumn: refCol
+			};
+		}
+		const { table, column } = refParts(via.column, source.source);
+		const on = [`${quoteIdent(relatedTable)}.${quoteIdent(SOURCE_KEY)} = ${quoteIdent(table)}.${quoteIdent(column)}`, ...compileFilterConditions(relatedTable, related?.filter)].join(" AND ");
+		return {
+			clause: `LEFT JOIN ${quoteIdent(relatedTable)} ON ${on}`,
+			refSelect: `${quoteIdent(relatedTable)}.${quoteIdent(SOURCE_KEY)} AS ${refAlias}`,
+			refColumn: refCol
+		};
+	}
+	if ("through" in via) {
+		const on = `${quoteIdent(via.through)}.${quoteIdent(via.localKey)} = ${quoteIdent(source.source)}.${quoteIdent(SOURCE_KEY)}`;
+		return {
+			clause: `LEFT JOIN ${quoteIdent(via.through)} ON ${on}`,
+			refSelect: `${quoteIdent(via.through)}.${quoteIdent(via.foreignKey)} AS ${refAlias}`,
+			refColumn: refCol
+		};
+	}
+	return {
+		clause: via.$raw,
+		refSelect: null,
+		refColumn: refCol
+	};
+}
+function compileEntityView(config, entityKey, options = {}) {
+	const entity = config.entities[entityKey];
+	if (!entity) throw new Error(`entity "${entityKey}" is not defined`);
+	const viewName = `${options.viewPrefix ?? DEFAULT_VIEW_PREFIX}${entityKey}`;
+	const src = entity.source;
+	const selectItems = [`${quoteIdent(src)}.${quoteIdent(SOURCE_KEY)} AS ${quoteIdent("id")}`];
+	const columns = ["id"];
+	for (const [field, column] of Object.entries(entity.fields)) {
+		selectItems.push(`${quoteIdent(src)}.${quoteIdent(column)} AS ${quoteIdent(field)}`);
+		columns.push(field);
+	}
+	const joins = [];
+	for (const [relName, rel] of Object.entries(entity.relationships ?? {})) {
+		const compiled = compileRelationship(relName, rel, entity, config.entities[rel.entity]);
+		joins.push(compiled.clause);
+		if (compiled.refSelect) {
+			selectItems.push(compiled.refSelect);
+			columns.push(compiled.refColumn);
+		}
+	}
+	const conditions = compileFilterConditions(src, entity.filter);
+	if (options.orgScope) conditions.push(`${quoteIdent(src)}.${quoteIdent(options.orgScope.column)} = ${quoteLiteral(options.orgScope.value)}`);
+	const lines = [
+		options.securityInvoker ?? true ? `CREATE OR REPLACE VIEW ${quoteIdent(viewName)} WITH (security_invoker = true) AS` : `CREATE OR REPLACE VIEW ${quoteIdent(viewName)} AS`,
+		`SELECT ${selectItems.join(", ")}`,
+		`FROM ${quoteIdent(src)}`,
+		...joins
+	];
+	if (conditions.length > 0) lines.push(`WHERE ${conditions.join(" AND ")}`);
+	const sql = `${lines.join("\n")};`;
+	return {
+		entityKey,
+		viewName,
+		concept: entity.concept,
+		role: entity.role ?? DEFAULT_ROLE,
+		sourceTable: src,
+		columns,
+		sql,
+		dropSql: `DROP VIEW IF EXISTS ${quoteIdent(viewName)};`
+	};
+}
+/** Compile every entity in the config into its view, in declaration order. */
+function compileEntityViews(config, options = {}) {
+	return Object.keys(config.entities).map((key) => compileEntityView(config, key, options));
+}
+/**
+* Dry-run each entity's compiled view against the host DB via a caller-provided
+* `run` function, so `$raw` filter/join fragments — which skip schema validation
+* (see `validateEntitiesConfig`) — fail loudly *before* the first sync instead of
+* at sync time. Never throws: each view's outcome is collected into an
+* `ExplainResult`, so a mapping UI or CLI can show every problem at once.
+*
+* `run` should execute the SQL somewhere side-effect-free — e.g. inside a
+* transaction it rolls back, or by `EXPLAIN`-ing the statement — since the
+* compiled SQL is a `CREATE OR REPLACE VIEW`.
+*/
+async function explainEntitiesConfig(config, run, options = {}) {
+	const results = [];
+	for (const view of compileEntityViews(config, options)) try {
+		await run(view.sql);
+		results.push({
+			entityKey: view.entityKey,
+			ok: true,
+			sql: view.sql
+		});
+	} catch (error) {
+		results.push({
+			entityKey: view.entityKey,
+			ok: false,
+			sql: view.sql,
+			error: error instanceof Error ? error.message : String(error)
+		});
+	}
+	return results;
+}
+//#endregion
+exports.compileEntityView = compileEntityView;
+exports.compileEntityViews = compileEntityViews;
+exports.explainEntitiesConfig = explainEntitiesConfig;

package/dist/view-compiler.d.cts

@@ -0,0 +1,64 @@
+import { ClivlyEntitiesConfig } from "./entity-config.cjs";
+
+//#region src/view-compiler.d.ts
+interface CompileOptions {
+  /**
+   * Optional tenant-scoping predicate ANDed into every view's WHERE, e.g.
+   * `{ column: "workspace_id", value: "ws_123" }`. Column must exist on the
+   * entity's source table (the compiler does not verify that — validate first).
+   */
+  orgScope?: {
+    column: string;
+    value: string | number;
+  };
+  /**
+   * Emit views `WITH (security_invoker = true)` so they run with the querying
+   * role's privileges instead of the (owner's) definer privileges — the
+   * default Postgres behaviour, which bypasses the caller's RLS. Defaults to
+   * `true`: the security boundary the product promises. Set `false` only for
+   * hosts on Postgres < 15, which lacks the option.
+   */
+  securityInvoker?: boolean;
+  /** View name prefix. Defaults to `crm_src_`. */
+  viewPrefix?: string;
+}
+interface CompiledView {
+  /** Output column names in SELECT order (`id`, mapped fields, then `<rel>_ref`s). */
+  columns: string[];
+  concept: string;
+  /** `DROP VIEW IF EXISTS …` statement (for teardown / reconfiguration). */
+  dropSql: string;
+  entityKey: string;
+  /** Resolved role — the entity's `role` or `"primary"`. */
+  role: string;
+  sourceTable: string;
+  /** `CREATE OR REPLACE VIEW … AS …` statement. */
+  sql: string;
+  viewName: string;
+}
+declare function compileEntityView(config: ClivlyEntitiesConfig, entityKey: string, options?: CompileOptions): CompiledView;
+/** Compile every entity in the config into its view, in declaration order. */
+declare function compileEntityViews(config: ClivlyEntitiesConfig, options?: CompileOptions): CompiledView[];
+/** The outcome of dry-running one entity's compiled view against the host. */
+interface ExplainResult {
+  entityKey: string;
+  /** The runner's error message when `ok` is false. */
+  error?: string;
+  ok: boolean;
+  /** The compiled view SQL that was run. */
+  sql: string;
+}
+/**
+ * Dry-run each entity's compiled view against the host DB via a caller-provided
+ * `run` function, so `$raw` filter/join fragments — which skip schema validation
+ * (see `validateEntitiesConfig`) — fail loudly *before* the first sync instead of
+ * at sync time. Never throws: each view's outcome is collected into an
+ * `ExplainResult`, so a mapping UI or CLI can show every problem at once.
+ *
+ * `run` should execute the SQL somewhere side-effect-free — e.g. inside a
+ * transaction it rolls back, or by `EXPLAIN`-ing the statement — since the
+ * compiled SQL is a `CREATE OR REPLACE VIEW`.
+ */
+declare function explainEntitiesConfig(config: ClivlyEntitiesConfig, run: (sql: string) => Promise<unknown>, options?: CompileOptions): Promise<ExplainResult[]>;
+//#endregion
+export { CompileOptions, CompiledView, ExplainResult, compileEntityView, compileEntityViews, explainEntitiesConfig };

package/dist/view-compiler.d.mts

@@ -39,5 +39,26 @@ interface CompiledView {
 declare function compileEntityView(config: ClivlyEntitiesConfig, entityKey: string, options?: CompileOptions): CompiledView;
 /** Compile every entity in the config into its view, in declaration order. */
 declare function compileEntityViews(config: ClivlyEntitiesConfig, options?: CompileOptions): CompiledView[];
+/** The outcome of dry-running one entity's compiled view against the host. */
+interface ExplainResult {
+  entityKey: string;
+  /** The runner's error message when `ok` is false. */
+  error?: string;
+  ok: boolean;
+  /** The compiled view SQL that was run. */
+  sql: string;
+}
+/**
+ * Dry-run each entity's compiled view against the host DB via a caller-provided
+ * `run` function, so `$raw` filter/join fragments — which skip schema validation
+ * (see `validateEntitiesConfig`) — fail loudly *before* the first sync instead of
+ * at sync time. Never throws: each view's outcome is collected into an
+ * `ExplainResult`, so a mapping UI or CLI can show every problem at once.
+ *
+ * `run` should execute the SQL somewhere side-effect-free — e.g. inside a
+ * transaction it rolls back, or by `EXPLAIN`-ing the statement — since the
+ * compiled SQL is a `CREATE OR REPLACE VIEW`.
+ */
+declare function explainEntitiesConfig(config: ClivlyEntitiesConfig, run: (sql: string) => Promise<unknown>, options?: CompileOptions): Promise<ExplainResult[]>;
 //#endregion
-export { CompileOptions, CompiledView, compileEntityView, compileEntityViews };
+export { CompileOptions, CompiledView, ExplainResult, compileEntityView, compileEntityViews, explainEntitiesConfig };

package/dist/view-compiler.mjs

@@ -151,5 +151,35 @@ function compileEntityView(config, entityKey, options = {}) {
 function compileEntityViews(config, options = {}) {
 	return Object.keys(config.entities).map((key) => compileEntityView(config, key, options));
 }
+/**
+* Dry-run each entity's compiled view against the host DB via a caller-provided
+* `run` function, so `$raw` filter/join fragments — which skip schema validation
+* (see `validateEntitiesConfig`) — fail loudly *before* the first sync instead of
+* at sync time. Never throws: each view's outcome is collected into an
+* `ExplainResult`, so a mapping UI or CLI can show every problem at once.
+*
+* `run` should execute the SQL somewhere side-effect-free — e.g. inside a
+* transaction it rolls back, or by `EXPLAIN`-ing the statement — since the
+* compiled SQL is a `CREATE OR REPLACE VIEW`.
+*/
+async function explainEntitiesConfig(config, run, options = {}) {
+	const results = [];
+	for (const view of compileEntityViews(config, options)) try {
+		await run(view.sql);
+		results.push({
+			entityKey: view.entityKey,
+			ok: true,
+			sql: view.sql
+		});
+	} catch (error) {
+		results.push({
+			entityKey: view.entityKey,
+			ok: false,
+			sql: view.sql,
+			error: error instanceof Error ? error.message : String(error)
+		});
+	}
+	return results;
+}
 //#endregion
-export { compileEntityView, compileEntityViews };
+export { compileEntityView, compileEntityViews, explainEntitiesConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clivly/core",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "private": false,
   "type": "module",
   "description": "ORM/auth-agnostic CRM adapter contracts and shared domain types for Clivly.",
@@ -8,40 +8,114 @@
   "sideEffects": false,
   "exports": {
     ".": {
-      "types": "./dist/index.d.mts",
-      "import": "./dist/index.mjs"
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     },
     "./adapter": {
-      "types": "./dist/adapter.d.mts",
-      "import": "./dist/adapter.mjs"
+      "import": {
+        "types": "./dist/adapter.d.mts",
+        "default": "./dist/adapter.mjs"
+      },
+      "require": {
+        "types": "./dist/adapter.d.cts",
+        "default": "./dist/adapter.cjs"
+      }
+    },
+    "./entity-heuristics": {
+      "import": {
+        "types": "./dist/entity-heuristics.d.mts",
+        "default": "./dist/entity-heuristics.mjs"
+      },
+      "require": {
+        "types": "./dist/entity-heuristics.d.cts",
+        "default": "./dist/entity-heuristics.cjs"
+      }
     },
     "./auth-adapter": {
-      "types": "./dist/auth-adapter.d.mts",
-      "import": "./dist/auth-adapter.mjs"
+      "import": {
+        "types": "./dist/auth-adapter.d.mts",
+        "default": "./dist/auth-adapter.mjs"
+      },
+      "require": {
+        "types": "./dist/auth-adapter.d.cts",
+        "default": "./dist/auth-adapter.cjs"
+      }
     },
     "./entity-config": {
-      "types": "./dist/entity-config.d.mts",
-      "import": "./dist/entity-config.mjs"
+      "import": {
+        "types": "./dist/entity-config.d.mts",
+        "default": "./dist/entity-config.mjs"
+      },
+      "require": {
+        "types": "./dist/entity-config.d.cts",
+        "default": "./dist/entity-config.cjs"
+      }
     },
     "./mappings-config": {
-      "types": "./dist/mappings-config.d.mts",
-      "import": "./dist/mappings-config.mjs"
+      "import": {
+        "types": "./dist/mappings-config.d.mts",
+        "default": "./dist/mappings-config.mjs"
+      },
+      "require": {
+        "types": "./dist/mappings-config.d.cts",
+        "default": "./dist/mappings-config.cjs"
+      }
     },
     "./mapping-form": {
-      "types": "./dist/mapping-form.d.mts",
-      "import": "./dist/mapping-form.mjs"
+      "import": {
+        "types": "./dist/mapping-form.d.mts",
+        "default": "./dist/mapping-form.mjs"
+      },
+      "require": {
+        "types": "./dist/mapping-form.d.cts",
+        "default": "./dist/mapping-form.cjs"
+      }
     },
     "./view-compiler": {
-      "types": "./dist/view-compiler.d.mts",
-      "import": "./dist/view-compiler.mjs"
+      "import": {
+        "types": "./dist/view-compiler.d.mts",
+        "default": "./dist/view-compiler.mjs"
+      },
+      "require": {
+        "types": "./dist/view-compiler.d.cts",
+        "default": "./dist/view-compiler.cjs"
+      }
     },
     "./sync-engine": {
-      "types": "./dist/sync-engine.d.mts",
-      "import": "./dist/sync-engine.mjs"
+      "import": {
+        "types": "./dist/sync-engine.d.mts",
+        "default": "./dist/sync-engine.mjs"
+      },
+      "require": {
+        "types": "./dist/sync-engine.d.cts",
+        "default": "./dist/sync-engine.cjs"
+      }
+    },
+    "./drizzle": {
+      "import": {
+        "types": "./dist/drizzle.d.mts",
+        "default": "./dist/drizzle.mjs"
+      },
+      "require": {
+        "types": "./dist/drizzle.d.cts",
+        "default": "./dist/drizzle.cjs"
+      }
     },
     "./types": {
-      "types": "./dist/types.d.mts",
-      "import": "./dist/types.mjs"
+      "import": {
+        "types": "./dist/types.d.mts",
+        "default": "./dist/types.mjs"
+      },
+      "require": {
+        "types": "./dist/types.d.cts",
+        "default": "./dist/types.cjs"
+      }
     }
   },
   "files": [
@@ -53,17 +127,26 @@
   "dependencies": {
     "zod": "^4.1.13"
   },
+  "peerDependencies": {
+    "drizzle-orm": ">=0.30"
+  },
+  "peerDependenciesMeta": {
+    "drizzle-orm": {
+      "optional": true
+    }
+  },
   "devDependencies": {
+    "drizzle-orm": "^0.45.1",
     "tsdown": "^0.21.9",
     "typescript": "^6",
-    "vitest": "^3.2.4",
-    "@clivly.com/config": "0.0.0"
+    "vitest": "^3.2.4"
   },
   "scripts": {
     "build": "tsdown",
     "check-types": "tsc --noEmit",
     "test": "vitest run"
   },
-  "main": "./dist/index.mjs",
-  "types": "./dist/index.d.mts"
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "module": "./dist/index.mjs"
 }