@skalfa/skalfa-da 1.0.0 → 1.0.1

package/.github/workflows/publish.yml

@@ -0,0 +1,40 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - main
+      - master
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
+      - name: Publish if version bumped
+        run: |
+          LOCAL_VER=$(node -p "require('./package.json').version")
+          NPM_VER=$(npm view @skalfa/skalfa-da version 2>/dev/null || echo "0.0.0")
+          if [ "$LOCAL_VER" != "$NPM_VER" ]; then
+            echo "Publishing @skalfa/skalfa-da $LOCAL_VER (Registry version: $NPM_VER)"
+            bun install
+            npm run build
+            npm publish --access public
+          else
+            echo "@skalfa/skalfa-da is up to date ($LOCAL_VER)"
+          fi
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CONTRIBUTING.md

@@ -0,0 +1,45 @@
+# Contributing to @skalfa/skalfa-da
+
+Thank you for your interest in contributing to Skalfa! We welcome contributions from the community to help make Skalfa the premier development framework.
+
+## How to Contribute
+
+To contribute to this package, please follow these standard open-source steps:
+
+### 1. Fork the Repository
+Fork the official Skalfa repository on GitHub to your personal account.
+
+### 2. Clone Your Fork
+Clone your personal fork to your local machine:
+```bash
+git clone https://github.com/your-username/skalfa.git
+cd skalfa
+```
+
+### 3. Create a Feature Branch
+Create a new branch for your feature or bugfix:
+```bash
+git checkout -b feature/amazing-new-feature
+```
+*(Use `bugfix/issue-description` for bugfixes).*
+
+### 4. Implement and Commit Your Changes
+Make your changes in the codebase. Write clean, formatted code and ensure all tests and typechecks pass. Commit your changes using semantic commit messages:
+```bash
+git commit -m "feat: add amazing new feature"
+```
+*(Use `fix: description` for bugfixes, and `docs: description` for documentation updates).*
+
+### 5. Push to GitHub
+Push your branch to your personal fork on GitHub:
+```bash
+git push origin feature/amazing-new-feature
+```
+
+### 6. Submit a Pull Request (PR)
+Go to the official Skalfa repository on GitHub. You will see a prompt to submit a pull request. Click "New Pull Request", describe your changes in detail, link any related issues, and submit it for review by the maintainers.
+
+## Guidelines
+* **Code Style**: Ensure your code conforms to the project's ESLint rules and formatting guidelines.
+* **Type Safety**: Write strict, type-safe TypeScript. Do not bypass the compiler.
+* **Testing**: Run local tests and verify that the build compiles with 0 errors before submitting a PR.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Skalfa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,54 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/skalfa-framework/skalfa/main/logo/logo-skalfa-full.png" alt="Skalfa Logo" width="300" />
+</p>
+
+# @skalfa/skalfa-da
+
+> Data Analytics OLAP ClickHouse client and database migration utility extension for Skalfa backend services.
+
+---
+
+## About this Package
+
+This package is part of the **Skalfa Framework**, a premium development ecosystem designed to build high-performance, modular web applications and APIs.
+
+### Usage Scope & Standalone Status
+> 💡 **Standalone Capability:** This package is **fully standalone**! You can install and use it in **any external Node.js, Bun, or TypeScript project**, completely independent of the Skalfa ecosystem.
+
+---
+
+## Documentation
+
+See the usage documentation at [Documentation](https://skalfa.sejedigital.com).
+
+---
+
+## Installation
+
+You can install this package using your preferred package manager:
+
+```bash
+# Using npm
+npm install @skalfa/skalfa-da
+
+# Using bun
+bun add @skalfa/skalfa-da
+```
+
+---
+
+## Pre-installed Dependencies
+
+The following key dependencies are packaged and managed within this project:
+
+| Dependency | Scope | Version |
+| :--- | :--- | :--- |
+| `@clickhouse/client` | runtime | `^1.6.0` |
+| `@types/node` | development | `^26.0.0` |
+| `typescript` | development | `^6.0.3` |
+
+---
+
+## License
+
+This package is licensed under the **MIT License**. For full license text, see the [LICENSE](LICENSE) file.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@skalfa/skalfa-da",
-  "version": "1.0.0",
-  "description": "Data Analytics / ClickHouse utility package for Skalfa API framework.",
+  "version": "1.0.1",
+  "description": "Data Analytics OLAP ClickHouse client and database migration utility extension for Skalfa backend services.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -22,4 +22,4 @@
     "@types/node": "^26.0.0",
     "typescript": "^6.0.3"
   }
-}
+}

package/bun.lock

@@ -1,26 +0,0 @@
-{
-  "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=="],
-  }
-}