@clisma/config 0.2.1 → 0.3.0

package/dist/config.d.ts

@@ -1,7 +1,11 @@
 export type MigrationConfig = {
     dir: string;
-    table_name?: string;
-    replication_path?: string;
+    table?: {
+        name: string;
+        is_replicated: boolean;
+        cluster_name?: string;
+        replication_path?: string;
+    };
     vars?: Record<string, unknown>;
 };
 export type TlsConfig = {
@@ -12,7 +16,6 @@ export type TlsConfig = {
 export type EnvConfig = {
     url: string;
     exclude?: string[];
-    cluster_name?: string;
     tls?: TlsConfig;
     migrations: MigrationConfig;
 };

package/dist/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAUA,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE,eAAe,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CAC3C,CAAC;AAgCF;;GAEG;AACH,eAAO,MAAM,WAAW,GACtB,SAAS,MAAM,EACf,MAAK,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAM,EAC5C,OAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EACjC,UAAU,MAAM,EAChB,aAAY,MAAqB,KAChC,OAAO,CAAC,SAAS,CAiJnB,CAAC;AAEF,eAAO,MAAM,eAAe,GAC1B,YAAY,MAAM,EAClB,UAAU,MAAM,EAChB,OAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EACjC,MAAK,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAe,KACpD,OAAO,CAAC,SAAS,CAInB,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAC3B,SAAS,MAAM,EACf,aAAY,MAAqB,KAChC,OAAO,CAAC,MAAM,EAAE,CAMlB,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAC/B,YAAY,MAAM,KACjB,OAAO,CAAC,MAAM,EAAE,CAGlB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,GACzB,WAAU,MAAsB,EAChC,WAAU,MAAqB,KAC9B,OAAO,CAAC,MAAM,GAAG,IAAI,CAmBvB,CAAC"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAUA,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,aAAa,EAAE,OAAO,CAAC;QACvB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,UAAU,EAAE,eAAe,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CAC3C,CAAC;AAmCF;;GAEG;AACH,eAAO,MAAM,WAAW,GACtB,SAAS,MAAM,EACf,MAAK,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAM,EAC5C,OAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EACjC,UAAU,MAAM,EAChB,aAAY,MAAqB,KAChC,OAAO,CAAC,SAAS,CAuJnB,CAAC;AAEF,eAAO,MAAM,eAAe,GAC1B,YAAY,MAAM,EAClB,UAAU,MAAM,EAChB,OAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EACjC,MAAK,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAe,KACpD,OAAO,CAAC,SAAS,CAInB,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAC3B,SAAS,MAAM,EACf,aAAY,MAAqB,KAChC,OAAO,CAAC,MAAM,EAAE,CAMlB,CAAC;AAEF,eAAO,MAAM,oBAAoB,GAC/B,YAAY,MAAM,KACjB,OAAO,CAAC,MAAM,EAAE,CAGlB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,GACzB,WAAU,MAAsB,EAChC,WAAU,MAAqB,KAC9B,OAAO,CAAC,MAAM,GAAG,IAAI,CAmBvB,CAAC"}

package/dist/config.js

@@ -52,22 +52,26 @@ export const parseConfig = async (content, env = {}, vars = {}, envName, sourceN
             resolvedVars[key] = value;
         }
     }
-    // Parse optional table_name
-    const tableName = migrationBlock.table_name
-        ? extractValue(migrationBlock.table_name, "schema_migrations")
+    const tableBlock = migrationBlock.table?.[0];
+    const tableName = tableBlock?.name
+        ? extractValue(tableBlock.name, "schema_migrations")
         : "schema_migrations";
-    const replicationPath = migrationBlock.replication_path
-        ? resolveValue(extractValue(migrationBlock.replication_path, ""), env, variables) || undefined
+    const clusterName = tableBlock?.cluster_name
+        ? resolveValue(extractValue(tableBlock.cluster_name, ""), env, variables) ||
+            undefined
         : undefined;
+    const replicationPath = tableBlock?.replication_path
+        ? resolveValue(extractValue(tableBlock.replication_path, ""), env, variables) || undefined
+        : undefined;
+    const hasIsReplicated = tableBlock?.is_replicated !== undefined;
+    const isReplicated = hasIsReplicated
+        ? extractValue(tableBlock?.is_replicated, false)
+        : Boolean(replicationPath || clusterName);
     // Parse URL
     const url = extractValue(envBlock.url, "");
     if (!url) {
         throw new Error(`Database URL not specified for environment "${targetEnv}"`);
     }
-    const clusterNameValue = envBlock.cluster_name
-        ? resolveValue(extractValue(envBlock.cluster_name, ""), env, variables)
-        : "";
-    const clusterName = clusterNameValue || undefined;
     const tlsBlock = envBlock.tls?.[0];
     let tls;
     if (tlsBlock) {
@@ -97,12 +101,15 @@ export const parseConfig = async (content, env = {}, vars = {}, envName, sourceN
     return {
         url: resolveValue(url, env, variables),
         exclude: excludePatterns,
-        cluster_name: clusterName,
         tls,
         migrations: {
             dir: resolveValue(migrationDir, env, variables),
-            table_name: tableName,
-            replication_path: replicationPath,
+            table: {
+                name: tableName,
+                is_replicated: isReplicated,
+                cluster_name: clusterName,
+                replication_path: replicationPath,
+            },
             vars: resolvedVars,
         },
     };

package/dist/hcl-schema.d.ts

@@ -33,10 +33,6 @@ export declare const clismaSchema: {
                     readonly type: "string";
                     readonly description: "ClickHouse connection string.";
                 };
-                readonly cluster_name: {
-                    readonly type: "string";
-                    readonly description: "Optional cluster name. When set, migrations use replicated tracking and templating.";
-                };
                 readonly exclude: {
                     readonly type: "array";
                     readonly items: {
@@ -68,13 +64,12 @@ export declare const clismaSchema: {
                     readonly type: "string";
                     readonly description: "Path to migrations directory.";
                 };
-                readonly table_name: {
-                    readonly type: "string";
-                    readonly description: "Custom table name for migration tracking.";
-                };
-                readonly replication_path: {
-                    readonly type: "string";
-                    readonly description: "Optional replication path for the migrations table in clustered setups.";
+                readonly table: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/tableBlock";
+                    };
+                    readonly description: "Migrations tracking table configuration.";
                 };
                 readonly vars: {
                     readonly type: "object";
@@ -85,6 +80,28 @@ export declare const clismaSchema: {
                 };
             };
         };
+        readonly tableBlock: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly name: {
+                    readonly type: "string";
+                    readonly description: "Custom table name for migration tracking.";
+                };
+                readonly is_replicated: {
+                    readonly type: "boolean";
+                    readonly description: "Whether tracking table should use ReplicatedReplacingMergeTree and ON CLUSTER.";
+                };
+                readonly cluster_name: {
+                    readonly type: "string";
+                    readonly description: "Optional cluster name override for ON CLUSTER when replicated mode is enabled.";
+                };
+                readonly replication_path: {
+                    readonly type: "string";
+                    readonly description: "Optional replication path for the migrations table in replicated setups.";
+                };
+            };
+        };
         readonly tlsBlock: {
             readonly type: "object";
             readonly additionalProperties: false;

package/dist/hcl-schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hcl-schema.d.ts","sourceRoot":"","sources":["../src/hcl-schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqIf,CAAC;AAEX,eAAO,MAAM,cAAc,QAAO,OAAO,YAExC,CAAC"}
+{"version":3,"file":"hcl-schema.d.ts","sourceRoot":"","sources":["../src/hcl-schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuJf,CAAC;AAEX,eAAO,MAAM,cAAc,QAAO,OAAO,YAExC,CAAC"}

package/dist/hcl-schema.js

@@ -33,10 +33,6 @@ export const clismaSchema = {
                     type: "string",
                     description: "ClickHouse connection string.",
                 },
-                cluster_name: {
-                    type: "string",
-                    description: "Optional cluster name. When set, migrations use replicated tracking and templating.",
-                },
                 exclude: {
                     type: "array",
                     items: {
@@ -68,13 +64,12 @@ export const clismaSchema = {
                     type: "string",
                     description: "Path to migrations directory.",
                 },
-                table_name: {
-                    type: "string",
-                    description: "Custom table name for migration tracking.",
-                },
-                replication_path: {
-                    type: "string",
-                    description: "Optional replication path for the migrations table in clustered setups.",
+                table: {
+                    type: "array",
+                    items: {
+                        $ref: "#/$defs/tableBlock",
+                    },
+                    description: "Migrations tracking table configuration.",
                 },
                 vars: {
                     type: "object",
@@ -85,6 +80,28 @@ export const clismaSchema = {
                 },
             },
         },
+        tableBlock: {
+            type: "object",
+            additionalProperties: false,
+            properties: {
+                name: {
+                    type: "string",
+                    description: "Custom table name for migration tracking.",
+                },
+                is_replicated: {
+                    type: "boolean",
+                    description: "Whether tracking table should use ReplicatedReplacingMergeTree and ON CLUSTER.",
+                },
+                cluster_name: {
+                    type: "string",
+                    description: "Optional cluster name override for ON CLUSTER when replicated mode is enabled.",
+                },
+                replication_path: {
+                    type: "string",
+                    description: "Optional replication path for the migrations table in replicated setups.",
+                },
+            },
+        },
         tlsBlock: {
             type: "object",
             additionalProperties: false,

package/dist/tests/parse-config.test.js

@@ -36,6 +36,47 @@ env "prod" {
   }
 }
 `;
+const SAMPLE_HCL_WITH_TABLE = `
+env "prod" {
+  url = "http://default:password@localhost:8123/default"
+
+  migrations {
+    dir = "migrations"
+
+    table {
+      name = "custom_migrations"
+      is_replicated = true
+      replication_path = "/clickhouse/some/path"
+    }
+  }
+}
+`;
+const SAMPLE_HCL_WITH_ONLY_REPLICATION_PATH = `
+env "prod" {
+  url = "http://default:password@localhost:8123/default"
+
+  migrations {
+    dir = "migrations"
+
+    table {
+      replication_path = "/clickhouse/some/path"
+    }
+  }
+}
+`;
+const SAMPLE_HCL_WITH_CLUSTER_NAME = `
+env "prod" {
+  url = "http://default:password@localhost:8123/default"
+
+  migrations {
+    dir = "migrations"
+
+    table {
+      cluster_name = "prod-cluster"
+    }
+  }
+}
+`;
 test("parseConfig resolves env() and var.* values", async () => {
     const config = await parseConfig(SAMPLE_HCL, {
         CLICKHOUSE_URL: "lol",
@@ -54,6 +95,22 @@ test("parseConfig resolves TLS block and validates mTLS fields", async () => {
     assert.equal(config.tls?.cert_file, "certs/client.pem");
     assert.equal(config.tls?.key_file, "certs/client.key");
 });
+test("parseConfig parses migrations.table block", async () => {
+    const config = await parseConfig(SAMPLE_HCL_WITH_TABLE, {}, {}, "prod");
+    assert.equal(config.migrations.table?.name, "custom_migrations");
+    assert.equal(config.migrations.table?.is_replicated, true);
+    assert.equal(config.migrations.table?.replication_path, "/clickhouse/some/path");
+});
+test("parseConfig enables replication when replication_path is set", async () => {
+    const config = await parseConfig(SAMPLE_HCL_WITH_ONLY_REPLICATION_PATH, {}, {}, "prod");
+    assert.equal(config.migrations.table?.is_replicated, true);
+    assert.equal(config.migrations.table?.replication_path, "/clickhouse/some/path");
+});
+test("parseConfig enables replication when cluster_name is set", async () => {
+    const config = await parseConfig(SAMPLE_HCL_WITH_CLUSTER_NAME, {}, {}, "prod");
+    assert.equal(config.migrations.table?.is_replicated, true);
+    assert.equal(config.migrations.table?.cluster_name, "prod-cluster");
+});
 test("parseConfig throws when only one mTLS file is provided", async () => {
     await assert.rejects(() => parseConfig(`
 env "prod" {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clisma/config",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Configuration parsing and schema generation for clisma",
   "type": "module",
   "main": "dist/config.js",