@clisma/config 0.1.0 → 0.1.1

package/dist/config.d.ts

@@ -4,10 +4,16 @@ export type MigrationConfig = {
     replication_path?: string;
     vars?: Record<string, unknown>;
 };
+export type TlsConfig = {
+    ca_file: string;
+    cert_file?: string;
+    key_file?: string;
+};
 export type EnvConfig = {
     url: string;
     exclude?: string[];
     cluster_name?: string;
+    tls?: TlsConfig;
     migrations: MigrationConfig;
 };
 export type VariableConfig = {

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,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,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;AA2BF;;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,CA4GnB,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,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"}

package/dist/config.js

@@ -68,12 +68,37 @@ export const parseConfig = async (content, env = {}, vars = {}, envName, sourceN
         ? resolveValue(extractValue(envBlock.cluster_name, ""), env, variables)
         : "";
     const clusterName = clusterNameValue || undefined;
+    const tlsBlock = envBlock.tls?.[0];
+    let tls;
+    if (tlsBlock) {
+        const caFile = tlsBlock.ca_file
+            ? resolveValue(extractValue(tlsBlock.ca_file, ""), env, variables)
+            : "";
+        const certFile = tlsBlock.cert_file
+            ? resolveValue(extractValue(tlsBlock.cert_file, ""), env, variables)
+            : "";
+        const keyFile = tlsBlock.key_file
+            ? resolveValue(extractValue(tlsBlock.key_file, ""), env, variables)
+            : "";
+        if (!caFile) {
+            throw new Error(`TLS block in environment "${targetEnv}" requires ca_file`);
+        }
+        if ((certFile && !keyFile) || (!certFile && keyFile)) {
+            throw new Error(`TLS block in environment "${targetEnv}" requires both cert_file and key_file for mTLS`);
+        }
+        tls = {
+            ca_file: caFile,
+            cert_file: certFile || undefined,
+            key_file: keyFile || undefined,
+        };
+    }
     // Parse exclude patterns (optional)
     const excludePatterns = extractList(envBlock.exclude, []);
     return {
         url: resolveValue(url, env, variables),
         exclude: excludePatterns,
         cluster_name: clusterName,
+        tls,
         migrations: {
             dir: resolveValue(migrationDir, env, variables),
             table_name: tableName,

package/dist/hcl-schema.d.ts

@@ -44,6 +44,13 @@ export declare const clismaSchema: {
                     };
                     readonly description: "Optional glob patterns to exclude tables.";
                 };
+                readonly tls: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly $ref: "#/$defs/tlsBlock";
+                    };
+                    readonly description: "Optional TLS settings for custom CA and mutual TLS client certificates.";
+                };
                 readonly migrations: {
                     readonly type: "array";
                     readonly items: {
@@ -78,6 +85,25 @@ export declare const clismaSchema: {
                 };
             };
         };
+        readonly tlsBlock: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["ca_file"];
+            readonly properties: {
+                readonly ca_file: {
+                    readonly type: "string";
+                    readonly description: "Path to CA certificate file (PEM) used to verify the server certificate.";
+                };
+                readonly cert_file: {
+                    readonly type: "string";
+                    readonly description: "Path to client certificate file (PEM) for mutual TLS.";
+                };
+                readonly key_file: {
+                    readonly type: "string";
+                    readonly description: "Path to client private key file (PEM) for mutual TLS.";
+                };
+            };
+        };
         readonly variableBlock: {
             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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwGf,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqIf,CAAC;AAEX,eAAO,MAAM,cAAc,QAAO,OAAO,YAExC,CAAC"}

package/dist/hcl-schema.js

@@ -44,6 +44,13 @@ export const clismaSchema = {
                     },
                     description: "Optional glob patterns to exclude tables.",
                 },
+                tls: {
+                    type: "array",
+                    items: {
+                        $ref: "#/$defs/tlsBlock",
+                    },
+                    description: "Optional TLS settings for custom CA and mutual TLS client certificates.",
+                },
                 migrations: {
                     type: "array",
                     items: {
@@ -78,6 +85,25 @@ export const clismaSchema = {
                 },
             },
         },
+        tlsBlock: {
+            type: "object",
+            additionalProperties: false,
+            required: ["ca_file"],
+            properties: {
+                ca_file: {
+                    type: "string",
+                    description: "Path to CA certificate file (PEM) used to verify the server certificate.",
+                },
+                cert_file: {
+                    type: "string",
+                    description: "Path to client certificate file (PEM) for mutual TLS.",
+                },
+                key_file: {
+                    type: "string",
+                    description: "Path to client private key file (PEM) for mutual TLS.",
+                },
+            },
+        },
         variableBlock: {
             type: "object",
             additionalProperties: false,

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

@@ -21,6 +21,21 @@ variable "ttl_days" {
   default = "30"
 }
 `;
+const SAMPLE_HCL_WITH_TLS = `
+env "prod" {
+  url = "https://default:password@localhost:8443/default"
+
+  tls {
+    ca_file = env("TLS_CA_FILE")
+    cert_file = "certs/client.pem"
+    key_file = "certs/client.key"
+  }
+
+  migrations {
+    dir = "migrations"
+  }
+}
+`;
 test("parseConfig resolves env() and var.* values", async () => {
     const config = await parseConfig(SAMPLE_HCL, {
         CLICKHOUSE_URL: "lol",
@@ -31,3 +46,27 @@ test("parseConfig resolves env() and var.* values", async () => {
     assert.equal(config.migrations.vars?.ttl_static, "var.ttl_days");
     assert.equal(config.migrations.vars?.ttl_unexisting, "");
 });
+test("parseConfig resolves TLS block and validates mTLS fields", async () => {
+    const config = await parseConfig(SAMPLE_HCL_WITH_TLS, {
+        TLS_CA_FILE: "certs/ca.pem",
+    }, {}, "prod");
+    assert.equal(config.tls?.ca_file, "certs/ca.pem");
+    assert.equal(config.tls?.cert_file, "certs/client.pem");
+    assert.equal(config.tls?.key_file, "certs/client.key");
+});
+test("parseConfig throws when only one mTLS file is provided", async () => {
+    await assert.rejects(() => parseConfig(`
+env "prod" {
+  url = "https://default:password@localhost:8443/default"
+
+  tls {
+    ca_file = "certs/ca.pem"
+    cert_file = "certs/client.pem"
+  }
+
+  migrations {
+    dir = "migrations"
+  }
+}
+`, {}, {}, "prod"), /requires both cert_file and key_file/);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clisma/config",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Configuration parsing and schema generation for clisma",
   "type": "module",
   "main": "dist/config.js",
@@ -8,6 +8,10 @@
   "files": [
     "dist"
   ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/StopMakingThatBigFace/clisma.git"
+  },
   "dependencies": {
     "@cdktf/hcl2json": "^0.21.0"
   },

package/dist/schema.d.ts

@@ -1,96 +0,0 @@
-export declare const clismaSchema: {
-    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
-    readonly title: "clisma.hcl";
-    readonly type: "object";
-    readonly additionalProperties: false;
-    readonly properties: {
-        readonly env: {
-            readonly type: "object";
-            readonly additionalProperties: {
-                readonly type: "array";
-                readonly items: {
-                    readonly $ref: "#/$defs/envBlock";
-                };
-            };
-        };
-        readonly variable: {
-            readonly type: "object";
-            readonly additionalProperties: {
-                readonly type: "array";
-                readonly items: {
-                    readonly $ref: "#/$defs/variableBlock";
-                };
-            };
-        };
-    };
-    readonly $defs: {
-        readonly envBlock: {
-            readonly type: "object";
-            readonly additionalProperties: false;
-            readonly required: readonly ["url", "migration"];
-            readonly properties: {
-                readonly url: {
-                    readonly type: "string";
-                    readonly description: "ClickHouse connection string.";
-                };
-                readonly exclude: {
-                    readonly type: "array";
-                    readonly items: {
-                        readonly type: "string";
-                    };
-                    readonly description: "Optional glob patterns to exclude tables.";
-                };
-                readonly migration: {
-                    readonly type: "array";
-                    readonly items: {
-                        readonly $ref: "#/$defs/migrationBlock";
-                    };
-                };
-            };
-        };
-        readonly migrationBlock: {
-            readonly type: "object";
-            readonly additionalProperties: false;
-            readonly required: readonly ["dir"];
-            readonly properties: {
-                readonly dir: {
-                    readonly type: "string";
-                    readonly description: "Path to migrations directory.";
-                };
-                readonly table_name: {
-                    readonly type: "string";
-                    readonly description: "Custom table name for migration tracking.";
-                };
-                readonly vars: {
-                    readonly type: "object";
-                    readonly description: "Variables for Handlebars templates.";
-                    readonly additionalProperties: {
-                        readonly $ref: "#/$defs/variableValue";
-                    };
-                };
-            };
-        };
-        readonly variableBlock: {
-            readonly type: "object";
-            readonly additionalProperties: false;
-            readonly required: readonly ["type"];
-            readonly properties: {
-                readonly type: {
-                    readonly type: "string";
-                    readonly description: "Variable type.";
-                    readonly enum: readonly ["string", "number", "bool", "any"];
-                };
-                readonly default: {
-                    readonly $ref: "#/$defs/variableValue";
-                };
-                readonly description: {
-                    readonly type: "string";
-                };
-            };
-        };
-        readonly variableValue: {
-            readonly type: readonly ["string", "number", "boolean", "object", "array", "null"];
-        };
-    };
-};
-//# sourceMappingURL=schema.d.ts.map

package/dist/schema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8Ff,CAAC"}

package/dist/schema.js

@@ -1,95 +0,0 @@
-export const clismaSchema = {
-    $schema: "https://json-schema.org/draft/2020-12/schema",
-    title: "clisma.hcl",
-    type: "object",
-    additionalProperties: false,
-    properties: {
-        env: {
-            type: "object",
-            additionalProperties: {
-                type: "array",
-                items: {
-                    $ref: "#/$defs/envBlock",
-                },
-            },
-        },
-        variable: {
-            type: "object",
-            additionalProperties: {
-                type: "array",
-                items: {
-                    $ref: "#/$defs/variableBlock",
-                },
-            },
-        },
-    },
-    $defs: {
-        envBlock: {
-            type: "object",
-            additionalProperties: false,
-            required: ["url", "migration"],
-            properties: {
-                url: {
-                    type: "string",
-                    description: "ClickHouse connection string.",
-                },
-                exclude: {
-                    type: "array",
-                    items: {
-                        type: "string",
-                    },
-                    description: "Optional glob patterns to exclude tables.",
-                },
-                migration: {
-                    type: "array",
-                    items: {
-                        $ref: "#/$defs/migrationBlock",
-                    },
-                },
-            },
-        },
-        migrationBlock: {
-            type: "object",
-            additionalProperties: false,
-            required: ["dir"],
-            properties: {
-                dir: {
-                    type: "string",
-                    description: "Path to migrations directory.",
-                },
-                table_name: {
-                    type: "string",
-                    description: "Custom table name for migration tracking.",
-                },
-                vars: {
-                    type: "object",
-                    description: "Variables for Handlebars templates.",
-                    additionalProperties: {
-                        $ref: "#/$defs/variableValue",
-                    },
-                },
-            },
-        },
-        variableBlock: {
-            type: "object",
-            additionalProperties: false,
-            required: ["type"],
-            properties: {
-                type: {
-                    type: "string",
-                    description: "Variable type.",
-                    enum: ["string", "number", "bool", "any"],
-                },
-                default: {
-                    $ref: "#/$defs/variableValue",
-                },
-                description: {
-                    type: "string",
-                },
-            },
-        },
-        variableValue: {
-            type: ["string", "number", "boolean", "object", "array", "null"],
-        },
-    },
-};