@skalfa/skalfa-da 1.0.0

package/bun.lock

@@ -0,0 +1,26 @@
+{
+  "lockfileVersion": 1,
+  "workspaces": {
+    "": {
+      "name": "@skalfa/skalfa-da",
+      "dependencies": {
+        "@clickhouse/client": "^1.6.0",
+      },
+      "devDependencies": {
+        "@types/node": "^26.0.0",
+        "typescript": "^6.0.3",
+      },
+    },
+  },
+  "packages": {
+    "@clickhouse/client": ["@clickhouse/client@1.22.0", "", { "dependencies": { "@clickhouse/client-common": "1.22.0" } }, "sha512-iQAAM4VT9fO7mYVOkGB/Ul9Xxuf0atKn+GFceZqfE8xFakV8KOAQxR3tfNrXFMlJ8T+Q3gbrpfLFyj7/TbOwyA=="],
+
+    "@clickhouse/client-common": ["@clickhouse/client-common@1.22.0", "", {}, "sha512-MQgXRhoYXut6GhRrTJlub42bnPX7+5Vm+5gHNR0zZXU5+EwZKsBgMXiWXPOerAmQd3weGKm8hzoeZJCfU3Cw2w=="],
+
+    "@types/node": ["@types/node@26.0.0", "", { "dependencies": { "undici-types": "~8.3.0" } }, "sha512-vf2YFi1iY9lHGwNJMs01biZFbKJkrZR1T6/MlzjhJLPdntOHLhTrDSnSVcdtvjihi4VQNlrFRIxLsDBlQpAipA=="],
+
+    "typescript": ["typescript@6.0.3", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-y2TvuxSZPDyQakkFRPZHKFm+KKVqIisdg9/CZwm9ftvKXLP8NRWj38/ODjNbr43SsoXqNuAisEf1GdCxqWcdBw=="],
+
+    "undici-types": ["undici-types@8.3.0", "", {}, "sha512-j375ScV60dom+YkPFIfTLcOiPxkN/buHz5GobjLhixFuANaNs3C9l4GmrWqejgXWJ7BbJcFYpTEUkS1Ge8bpZQ=="],
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+export declare const daClient: import("@clickhouse/client").ClickHouseClient;
+type WhereValue = string | number | boolean | null;
+declare class QueryBuilder {
+    private selectCols;
+    private fromTable;
+    private whereClauses;
+    private orderClauses;
+    private limitValue?;
+    private offsetValue?;
+    select(...cols: string[]): this;
+    from(table: string): this;
+    where(col: string, op: string, value: WhereValue): this;
+    orderBy(col: string, dir?: "asc" | "desc"): this;
+    limit(n: number): this;
+    offset(n: number): this;
+    toSQL(): string;
+    get<T = any>(): Promise<T[]>;
+    first<T = any>(): Promise<NonNullable<T> | null>;
+}
+export declare const da: {
+    select(...cols: string[]): QueryBuilder;
+    from(table: string): QueryBuilder;
+    insert<T extends Record<string, any>>(table: string, rows: T | T[]): Promise<import("@clickhouse/client").InsertResult>;
+    exec(sql: string): Promise<import("@clickhouse/client").CommandResult>;
+};
+export {};

package/dist/index.js

@@ -0,0 +1,101 @@
+import { createClient } from '@clickhouse/client';
+// ==============================>
+// ## DA / OLAP : ClickHouse Init
+// ==============================>
+export const daClient = createClient({
+    url: "http://" + (process.env.DA_HOST || '127.0.0.1') + ':' + (process.env.DA_PORT || '8123'),
+    username: process.env.DA_USERNAME || 'default',
+    password: process.env.DA_PASSWORD || '',
+    database: process.env.DA_DATABASE || 'default',
+});
+class QueryBuilder {
+    constructor() {
+        this.selectCols = ["*"];
+        this.fromTable = "";
+        this.whereClauses = [];
+        this.orderClauses = [];
+    }
+    select(...cols) {
+        if (cols.length)
+            this.selectCols = cols;
+        return this;
+    }
+    from(table) {
+        this.fromTable = table;
+        return this;
+    }
+    where(col, op, value) {
+        const v = value === null ? "NULL" : typeof value === "string" ? `'${value.replace(/'/g, "''")}'` : value;
+        this.whereClauses.push(`${col} ${op} ${v}`);
+        return this;
+    }
+    orderBy(col, dir = "asc") {
+        this.orderClauses.push(`${col} ${dir.toUpperCase()}`);
+        return this;
+    }
+    limit(n) {
+        this.limitValue = n;
+        return this;
+    }
+    offset(n) {
+        this.offsetValue = n;
+        return this;
+    }
+    toSQL() {
+        if (!this.fromTable)
+            throw new Error("FROM table is required");
+        let sql = `SELECT ${this.selectCols.join(", ")} FROM ${this.fromTable}`;
+        if (this.whereClauses.length)
+            sql += ` WHERE ${this.whereClauses.join(" AND ")}`;
+        if (this.orderClauses.length)
+            sql += ` ORDER BY ${this.orderClauses.join(", ")}`;
+        if (this.limitValue !== undefined)
+            sql += ` LIMIT ${this.limitValue}`;
+        if (this.offsetValue !== undefined)
+            sql += ` OFFSET ${this.offsetValue}`;
+        return sql;
+    }
+    async get() {
+        const rs = await daClient.query({
+            query: this.toSQL(),
+            format: "JSONEachRow",
+        });
+        const text = await rs.text();
+        if (!text.trim())
+            return [];
+        return text.trim().split("\n").map(line => JSON.parse(line));
+    }
+    async first() {
+        const rows = await this.limit(1).get();
+        return rows[0] ?? null;
+    }
+}
+export const da = {
+    // =========================
+    // ## Select
+    // =========================
+    select(...cols) {
+        return new QueryBuilder().select(...cols);
+    },
+    from(table) {
+        return new QueryBuilder().from(table);
+    },
+    // =========================
+    // ## Insert
+    // =========================
+    insert(table, rows) {
+        const data = Array.isArray(rows) ? rows : [rows];
+        return daClient.insert({
+            table,
+            values: data,
+            format: "JSONEachRow",
+        });
+    },
+    // =========================
+    // ## Exec query raw
+    // =========================
+    exec(sql) {
+        return daClient.command({ query: sql });
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEjD,kCAAkC;AAClC,iCAAiC;AACjC,kCAAkC;AAClC,MAAM,CAAC,MAAM,QAAQ,GAAG,YAAY,CAAC;IACnC,GAAG,EAAU,SAAS,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,IAAS,WAAW,CAAC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,MAAM,CAAC;IAC1G,QAAQ,EAAK,OAAO,CAAC,GAAG,CAAC,WAAW,IAAM,SAAS;IACnD,QAAQ,EAAK,OAAO,CAAC,GAAG,CAAC,WAAW,IAAM,EAAE;IAC5C,QAAQ,EAAK,OAAO,CAAC,GAAG,CAAC,WAAW,IAAM,SAAS;CACpD,CAAC,CAAA;AAQF,MAAM,YAAY;IAAlB;QACU,eAAU,GAAa,CAAC,GAAG,CAAC,CAAA;QAC5B,cAAS,GAAG,EAAE,CAAA;QACd,iBAAY,GAAa,EAAE,CAAA;QAC3B,iBAAY,GAAa,EAAE,CAAA;IAiErC,CAAC;IA7DC,MAAM,CAAC,GAAG,IAAc;QACtB,IAAI,IAAI,CAAC,MAAM;YAAE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;QACvC,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,CAAC,KAAa;QAChB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAA;QACtB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,GAAW,EAAE,EAAU,EAAE,KAAiB;QAC9C,MAAM,CAAC,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAA;QAExG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QAC3C,OAAO,IAAI,CAAA;IACb,CAAC;IAED,OAAO,CAAC,GAAW,EAAE,MAAsB,KAAK;QAC9C,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;QACrD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK,CAAC,CAAS;QACb,IAAI,CAAC,UAAU,GAAG,CAAC,CAAA;QACnB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,CAAC,CAAS;QACd,IAAI,CAAC,WAAW,GAAG,CAAC,CAAA;QACpB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,KAAK;QACH,IAAI,CAAC,IAAI,CAAC,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;QAE9D,IAAI,GAAG,GAAG,UAAU,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,EAAE,CAAA;QAEvE,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM;YAAE,GAAG,IAAI,UAAU,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAA;QAChF,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM;YAAE,GAAG,IAAI,aAAa,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAA;QAChF,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;YAAE,GAAG,IAAI,UAAU,IAAI,CAAC,UAAU,EAAE,CAAA;QACrE,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS;YAAE,GAAG,IAAI,WAAW,IAAI,CAAC,WAAW,EAAE,CAAA;QAExE,OAAO,GAAG,CAAA;IACZ,CAAC;IAED,KAAK,CAAC,GAAG;QACP,MAAM,EAAE,GAAG,MAAM,QAAQ,CAAC,KAAK,CAAC;YAC9B,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE;YACnB,MAAM,EAAE,aAAa;SACtB,CAAC,CAAA;QAEF,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,IAAI,EAAE,CAAA;QAC5B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YAAE,OAAO,EAAE,CAAA;QAE3B,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAQ,CAAA;IACrE,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,EAAK,CAAA;QACzC,OAAO,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAA;IACxB,CAAC;CACF;AAED,MAAM,CAAC,MAAM,EAAE,GAAG;IAChB,4BAA4B;IAC5B,YAAY;IACZ,4BAA4B;IAC5B,MAAM,CAAC,GAAG,IAAc;QACtB,OAAO,IAAI,YAAY,EAAE,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAA;IAC3C,CAAC;IAED,IAAI,CAAC,KAAa;QAChB,OAAO,IAAI,YAAY,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACvC,CAAC;IAGD,4BAA4B;IAC5B,YAAY;IACZ,4BAA4B;IAC5B,MAAM,CAAgC,KAAa,EAAE,IAAa;QAChE,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QAEhD,OAAO,QAAQ,CAAC,MAAM,CAAC;YACrB,KAAK;YACL,MAAM,EAAE,IAAI;YACZ,MAAM,EAAE,aAAa;SACtB,CAAC,CAAA;IACJ,CAAC;IAGD,4BAA4B;IAC5B,oBAAoB;IACpB,4BAA4B;IAC5B,IAAI,CAAC,GAAW;QACd,OAAO,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAA;IACzC,CAAC;CACF,CAAA"}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@skalfa/skalfa-da",
+  "version": "1.0.0",
+  "description": "Data Analytics / ClickHouse utility package for Skalfa API framework.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc --ignoreDeprecations 6.0"
+  },
+  "keywords": [
+    "aluna",
+    "clickhouse",
+    "da",
+    "skalfa"
+  ],
+  "author": "",
+  "license": "UNLICENSED",
+  "dependencies": {
+    "@clickhouse/client": "^1.6.0"
+  },
+  "devDependencies": {
+    "@types/node": "^26.0.0",
+    "typescript": "^6.0.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,123 @@
+import { createClient } from '@clickhouse/client'
+
+// ==============================>
+// ## DA / OLAP : ClickHouse Init
+// ==============================>
+export const daClient = createClient({
+  url        : "http://" + (process.env.DA_HOST      || '127.0.0.1') + ':' + (process.env.DA_PORT || '8123'),
+  username   : process.env.DA_USERNAME   || 'default',
+  password   : process.env.DA_PASSWORD   || '',
+  database   : process.env.DA_DATABASE   || 'default',
+})
+
+
+// ==============================>
+// ## DA / OLAP : Query Builder
+// ==============================>
+type WhereValue = string | number | boolean | null
+
+class QueryBuilder {
+  private selectCols: string[] = ["*"]
+  private fromTable = ""
+  private whereClauses: string[] = []
+  private orderClauses: string[] = []
+  private limitValue?: number
+  private offsetValue?: number
+
+  select(...cols: string[]) {
+    if (cols.length) this.selectCols = cols
+    return this
+  }
+
+  from(table: string) {
+    this.fromTable = table
+    return this
+  }
+
+  where(col: string, op: string, value: WhereValue) {
+    const v = value === null ? "NULL" : typeof value === "string" ? `'${value.replace(/'/g, "''")}'` : value
+
+    this.whereClauses.push(`${col} ${op} ${v}`)
+    return this
+  }
+
+  orderBy(col: string, dir: "asc" | "desc" = "asc") {
+    this.orderClauses.push(`${col} ${dir.toUpperCase()}`)
+    return this
+  }
+
+  limit(n: number) {
+    this.limitValue = n
+    return this
+  }
+
+  offset(n: number) {
+    this.offsetValue = n
+    return this
+  }
+
+  toSQL() {
+    if (!this.fromTable) throw new Error("FROM table is required")
+
+    let sql = `SELECT ${this.selectCols.join(", ")} FROM ${this.fromTable}`
+
+    if (this.whereClauses.length) sql += ` WHERE ${this.whereClauses.join(" AND ")}`
+    if (this.orderClauses.length) sql += ` ORDER BY ${this.orderClauses.join(", ")}`
+    if (this.limitValue !== undefined) sql += ` LIMIT ${this.limitValue}`
+    if (this.offsetValue !== undefined) sql += ` OFFSET ${this.offsetValue}`
+
+    return sql
+  }
+
+  async get<T = any>() {
+    const rs = await daClient.query({
+      query: this.toSQL(),
+      format: "JSONEachRow",
+    })
+
+    const text = await rs.text()
+    if (!text.trim()) return []
+
+    return text.trim().split("\n").map(line => JSON.parse(line)) as T[]
+  }
+
+  async first<T = any>() {
+    const rows = await this.limit(1).get<T>()
+    return rows[0] ?? null
+  }
+}
+
+export const da = {
+  // =========================
+  // ## Select
+  // =========================
+  select(...cols: string[]) {
+    return new QueryBuilder().select(...cols)
+  },
+
+  from(table: string) {
+    return new QueryBuilder().from(table)
+  },
+
+
+  // =========================
+  // ## Insert
+  // =========================
+  insert<T extends Record<string, any>>(table: string, rows: T | T[]) {
+    const data = Array.isArray(rows) ? rows : [rows]
+
+    return daClient.insert({
+      table,
+      values: data,
+      format: "JSONEachRow",
+    })
+  },
+
+
+  // =========================
+  // ## Exec query raw
+  // =========================
+  exec(sql: string) {
+    return daClient.command({ query: sql })
+  },
+}

package/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "ignoreDeprecations": "5.0",
+    "target": "ES2021",
+    "module": "ES2022",
+    "moduleResolution": "node",
+    "declaration": true,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "baseUrl": ".",
+    "types": ["node"]
+  },
+  "include": ["src/**/*"]
+}