dobo-sqlite3 2.2.0

package/.github/FUNDING.yml

@@ -0,0 +1,13 @@
+github: ardhi
+patreon: bajoframework
+#open_collective: # Replace with a single Open Collective username
+#ko_fi: # Replace with a single Ko-fi username
+#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+#liberapay: # Replace with a single Liberapay username
+#issuehunt: # Replace with a single IssueHunt username
+#lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+#polar: # Replace with a single Polar username
+#buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
+#thanks_dev: # Replace with a single thanks.dev username
+custom: ["https://www.paypal.com/ncp/payment/EWLERL7SCUU64"]

package/.github/workflows/repo-lockdown.yml

@@ -0,0 +1,24 @@
+name: 'Repo Lockdown'
+
+on:
+  #issues:
+    #types: opened
+  pull_request_target:
+    types: opened
+  #schedule:
+    #- cron: '* */6 * * *'
+
+permissions:
+  #issues: write
+  pull-requests: write
+
+jobs:
+  action:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: dessant/repo-lockdown@v4
+        with:
+          pr-comment: >
+            This repository does not accept pull requests,
+            see the README.md for details.
+          skip-closed-pr-comment: true

package/.jsdoc.conf.json

@@ -0,0 +1,45 @@
+{
+  "plugins": ["plugins/markdown", "jsdoc-plugin-intersection"],
+  "opts": {
+    "encoding": "utf8",
+    "recurse": true,
+    "verbose": true,
+    "destination": "./docs",
+    "template": "node_modules/clean-jsdoc-theme",
+    "readme": "./docs/static/home.md",
+    "theme_opts": {
+      "default_theme": "light",
+      "display-module-header": true,
+      "title": "DoboKnex API",
+      "homepageTitle": "DoboKnex API",
+      "sections": ["Classes", "Events", "Modules", "Global"],
+      "menu": [{
+        "title": "NPM",
+        "link": "https://www.npmjs.com/package/dobo-knex"
+      }, {
+        "title": "Github",
+        "link": "https://github.com/ardhi/dobo-knex"
+      }, {
+        "title": "Dobo",
+        "link": "https://dobo.bajo.app/"
+      }, {
+        "title": "Bajo",
+        "link": "https://bajo.app/"
+      }]
+    }
+  },
+  "source": {
+    "include": ["."],
+    "includePattern": ".+\\.js(doc|x)?$",
+    "exclude": ["node_modules", "docs", "test"]
+  },
+  "markdown": {
+    "hardwrap": false,
+    "idInHeadings": true
+  },
+  "sourceType": "module",
+  "templates": {
+    "cleverLinks": false,
+    "monospaceLinks": false
+  }
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ardhi Lukianto
+
+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,50 @@
+# dobo-sqlite3
+
+![GitHub package.json version](https://img.shields.io/github/package-json/v/ardhi/dobo-sqlite3) ![NPM Version](https://img.shields.io/npm/v/dobo-sqlite3)
+
+> <br />**Attention**: I do NOT accept any pull request at the moment, thanks! ([Why?](wiki/CONTRIBUTING.md))<br /><br />
+
+SQLite3 driver for [Dobo](https://github.com/ardhi/dobo)
+
+## Installation
+
+Goto your ```{appDir}``` and run the following command in your terminal:
+
+```bash
+$ npm install dobo dobo-knex dobo-sqlite3
+```
+
+And enable the plugin by adding ```dobo```, ```dobo-knex``` and ```dobo-sqlite3``` to the plugin list in either the ```$dataDir/config/.plugins``` file or the ```bajo.plugins``` array within your ```package.json``` file
+
+## Documentations
+
+- [Config Object](wiki/CONFIG.md)
+- [Supported Drivers](wiki/SUPPORTED-DRIVERS.md)
+- [API](https://ardhi.github.io/dobo-sqlite3)
+- [Contributing](wiki/CONTRIBUTING.md)
+
+## Hire Me
+
+If you have a Bajo Framework-based project and need a professional service or assistance, please <a href="https://github.com/ardhi#professional-service">click here</a>. I'd be happy to work on it at a competitive price and with fast turnaround!
+
+## Support Me
+
+Please support me using the channels below. Your donation will motivate me to work faster and more diligently on future development.
+
+<a href="https://github.com/sponsors/ardhi">
+  <img src="https://img.shields.io/badge/Github-slategrey?style=flat&logo=github" height="50">
+</a>
+<a href="https://www.patreon.com/bajoframework">
+  <img src="https://img.shields.io/badge/Patreon-f2c3b2?style=flat&logo=patreon" height="50">
+</a>
+<a href="https://www.paypal.com/ncp/payment/EWLERL7SCUU64">
+  <img src="https://img.shields.io/badge/Paypal-blue?style=flat&logo=paypal" height="50">
+</a>
+
+<p>
+<div><img alt="bc1qwtv78cwp9ef8hnqaw84fxg5856l0pggqe32g6f" src="docs/static/bitcoin.jpeg" width="150" height="150" /><br>Bitcoin</div>
+</p>
+
+## License
+
+[MIT](LICENSE)

package/extend/dobo/driver/sqlite3.js

@@ -0,0 +1,145 @@
+import path from 'path'
+
+async function sqlite3DriverFactory () {
+  const { DoboKnexDriver } = this.app.baseClass
+  const { uniq } = this.app.lib._
+
+  class DoboSqlite3Driver extends DoboKnexDriver {
+    constructor (plugin, name, options) {
+      super(plugin, name, options)
+      this.dialect = 'sqlite3'
+      this.adapter = 'sqlite3'
+      this.options = {
+        useNullAsDefault: true
+      }
+    }
+
+    async sanitizeConnection (item) {
+      await super.sanitizeConnection(item)
+      const { fs } = this.app.lib
+      const { getPluginDataDir } = this.app.bajo
+      const { isString, isEmpty } = this.app.lib._
+      if (!isString(item.filename)) this.plugin.fatal('keyIsRequired%s%s%s', 'filename', this.plugin.t('connection'), item.name, { payload: item })
+      if (item.filename === ':memory:') this.memory = true
+      else {
+        let file = item.filename
+        if (file.indexOf('/') === -1) {
+          file = `${getPluginDataDir('dobo')}/db/${file}`
+          const ext = path.extname(file)
+          if (isEmpty(ext)) file += '.sqlite3'
+          fs.ensureDirSync(path.dirname(file))
+        } else {
+          if (file.indexOf('{appDir}') > -1) file = file.replace('{appDir}', this.app.dir)
+          if (file.indexOf('{dataDir}') > -1) file = file.replace('{dataDir}', this.app.bajo.dir.data)
+          if (file.indexOf('{tmpDir}') > -1) file = file.replace('{tmpDir}', this.app.bajo.dir.tmp)
+        }
+        item.filename = file
+      }
+    }
+
+    async connect (connection, noRebuild) {
+      await super.connect(connection, noRebuild)
+      if (!this.memory) return
+      const models = this.plugin.getModelsByConnection(connection.name)
+      for (const model of models) {
+        await model.build()
+        await model.loadFixtures()
+      }
+    }
+
+    async buildModel (model, options = {}) {
+      await super.buildModel(model, options)
+      const fullTexts = model.indexes.filter(idx => idx.type === 'fulltext')
+      if (fullTexts.length === 0) return
+
+      const client = model.connection.client
+      function getCols () {
+        const columns = []
+        for (const idx of fullTexts) {
+          columns.push(...idx.fields)
+        }
+        return uniq(columns)
+      }
+
+      function printCols (prefix) {
+        let cols = [...getCols()]
+        if (prefix) cols = cols.map(c => `${prefix}.${c}`)
+        return cols.join(', ')
+      }
+
+      const columns = getCols().join(', ')
+      const stmtSchema = `
+        CREATE VIRTUAL TABLE ${model.name}_fts USING fts5 (
+          ${printCols()}, content = '${model.name}', content_rowid = '${this.idField.name}'
+        );
+      `
+      const stmtTriggerInsert = `
+        CREATE TRIGGER ${model.name}_fts_insert AFTER INSERT ON ${model.name}
+        BEGIN
+          INSERT INTO ${model.name}_fts (rowid, ${columns}) VALUES (new.id, ${printCols('new')});
+        END;
+      `
+      const stmtTriggerDelete = `
+        CREATE TRIGGER ${model.name}_fts_delete AFTER DELETE ON ${model.name}
+        BEGIN
+          INSERT INTO ${model.name}_fts (${model.name}_fts, rowid, ${columns}) VALUES ('delete', old.id, ${printCols('old')});
+        END;
+      `
+
+      const stmtTriggerUpdate = `
+        CREATE TRIGGER ${model.name}_fts_update AFTER UPDATE ON ${model.name}
+        BEGIN
+          INSERT INTO ${model.name}_fts (${model.name}_fts, rowid, ${columns}) VALUES ('delete', old.id, ${printCols('old')});
+          INSERT INTO ${model.name}_fts (rowid, ${columns}) VALUES (new.id, ${printCols('new')});
+        END;
+      `
+      await client.raw(stmtSchema)
+      await client.raw(stmtTriggerInsert)
+      await client.raw(stmtTriggerDelete)
+      await client.raw(stmtTriggerUpdate)
+    }
+
+    async dropModel (model, options = {}) {
+      await super.dropModel(model, options)
+      const client = model.connection.client
+      const fulltexts = model.indexes.filter(idx => idx.type === 'fulltext')
+      if (fulltexts.length > 0) await client.schema.dropTable(`${model.name}_fts`)
+    }
+
+    _reformHistogram ({ type, item, group, aggregates, field }) {
+      const aggs = []
+      for (const agg of aggregates) {
+        aggs.push(`${agg}(${agg === 'count' ? '*' : field}) as ${agg}`)
+      }
+      switch (type) {
+        case 'daily': {
+          item.sql = item.sql.replace('*', `strftime('%Y-%m-%d', substr(${group}, 1, 10), 'auto') as date, ${aggs.join(', ')}`)
+          const start = item.sql.indexOf(' order by ')
+          const end = item.sql.indexOf(' limit ')
+          // const order = item.sql.slice(start, end)
+          item.sql = item.sql.splice(start, end - start, '')
+          // item.sql = item.sql.replace('limit ', `group by strftime('%Y', substr(${group}, 1, 10), 'auto'), strftime('%m', substr(${group}, 1, 10), 'auto'), strftime('%d', substr(${group}, 1, 10), 'auto') ${order} limit `)
+          item.sql = item.sql.replace('limit ', 'group by date limit ')
+          break
+        }
+        case 'monthly': {
+          item.sql = item.sql.replace('*', `strftime('%Y-%m', substr(${group}, 1, 10), 'auto') as month, ${aggs.join(', ')}`)
+          // item.sql = item.sql.replace('limit ', `group by strftime('%Y', substr(${group}, 1, 10), 'auto'), strftime('%m', substr(${group}, 1, 10), 'auto') limit `)
+          item.sql = item.sql.replace('limit ', 'group by month limit ')
+          break
+        }
+        case 'yearly': {
+          item.sql = item.sql.replace('*', `cast(strftime('%Y', substr(${group}, 1, 10), 'auto') as integer) as year, ${aggs.join(', ')}`)
+          // item.sql = item.sql.replace('limit ', `group by strftime('%Y', substr(${group}, 1, 10), 'auto') limit `)
+          item.sql = item.sql.replace('limit ', 'group by year limit ')
+          break
+        }
+      }
+    }
+  }
+
+  this.app.DoboSqlite3Driver = DoboSqlite3Driver
+  return DoboSqlite3Driver
+}
+
+export default sqlite3DriverFactory

package/index.js

@@ -0,0 +1,28 @@
+/**
+ * Plugin factory
+ *
+ * @param {string} pkgName - NPM package name
+ * @returns {class}
+ */
+async function factory (pkgName) {
+  const me = this
+
+  /**
+   * DoboSqlite3 class
+   *
+   * @class
+   */
+  class DoboSqlite3 extends this.app.baseClass.Base {
+    constructor () {
+      super(pkgName, me.app)
+      this.config = {
+        options: {
+          compileSqlOnError: false
+        }
+      }
+    }
+  }
+  return DoboSqlite3
+}
+
+export default factory

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "dobo-sqlite3",
+  "version": "2.2.0",
+  "description": "SQLite3 driver for Dobo",
+  "main": "index.js",
+  "scripts": {
+    "build-doc": "jsdoc -c .jsdoc.conf.json",
+    "test": "mocha"
+  },
+  "type": "module",
+  "bajo": {
+    "type": "plugin",
+    "alias": "dbsqlite3",
+    "dependencies": ["dobo", "dobo-knex"]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ardhi/dobo-sqlite3.git"
+  },
+  "keywords": [
+    "sqlite3",
+    "sql",
+    "dobo",
+    "db",
+    "driver",
+    "bajo",
+    "framework",
+    "modular"
+  ],
+  "author": "Ardhi Lukianto <ardhi@lukianto.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ardhi/dobo-sqlite3/issues"
+  },
+  "homepage": "https://github.com/ardhi/dobo-sqlite3#readme",
+  "dependencies": {
+    "sqlite3": "^5.1.7"
+  },
+  "devDependencies": {
+    "clean-jsdoc-theme": "^4.3.0",
+    "jsdoc-plugin-intersection": "^1.0.4"
+  }
+}

package/wiki/CHANGES.md

@@ -0,0 +1,5 @@
+# Changes
+
+## 2025-12-22
+
+- First port SQLite3 driver as independent plugin

package/wiki/CONFIG.md

@@ -0,0 +1,25 @@
+# Config Object
+
+
+## Dobo's connection object
+
+These SQLite3 connection objects should be used as your **Dobo connection** object's array written in your ```{dataDir}/config/dobo.json```, NOT in ```{dataDir}/config/doboSqlite3.json```.
+
+| Key Name | Type | Default | Description |
+| ------- | ---- | ----- | ----------- |
+| ```name``` | ```string``` | ```default``` | Connection name |
+| ```type``` | ```string``` || Connection's driver type. See below |
+| ```connection``` | ```object``` || Connection details |
+|     ```filename``` | ```string``` || Path to database file |
+|     ```...``` ||| See knex *connection* config |
+| ```useNullAsDefault``` | ```boolean``` | ```true``` | See knex options |
+| ```...``` ||| See knex options |
+
+Directory to database file, if not specifed, defaults to ```{dataDir}/plugins/dobo/db/{filename}```
+
+if ```{filename}``` is ```:memory:```, it turns on SQLite3 memory database
+
+Directory tokens are supported, it will be replaced by its respected values if any are found:
+- ```{appDir}```
+- ```{dataDir}```
+- ```{tmpDir}```

package/wiki/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing
+
+Thanks very much to everyone who wants to join as a contributor, but I have committed to devoting 100% of my time to this project. Therefore, I'm currently unable to accept pull requests from anyone until the project is large enough for me to manage it independently.
+
+However, I am available if you encounter any bugs that require immediate fixes. Please report your issues in a GitHub issue, and I'll try to address them promptly. I'm also open to criticism and suggestions for improvements or requests for new features.

package/wiki/SUPPORTED-DRIVERS.md

@@ -0,0 +1,73 @@
+# Supported Drivers
+
+By default, [Knex](https://knexjs.org) support the following databases:
+
+- [PostgreSQL](https://www.postgresql.org), [CockrouchDB](https://www.cockroachlabs.com) and [Amazon Redshift](https://aws.amazon.com/redshift) through [pg](https://github.com/brianc/node-postgres) adapter.
+- [MySQL](https://www.mysql.com) and [MariaDB](https://mariadb.org) through [mysql](https://github.com/felixge/node-mysql) adapter.
+- [SQLite3](https://sqlite.org) through [sqlite3](https://github.com/mapbox/node-sqlite3) adapter.
+- [MSSQL](https://www.microsoft.com/en-us/sql-server) through [tedious](https://github.com/tediousjs/tedious) adapter.
+
+In addition to those listed above, Dobo Knex also supports the following databases with some custom patches to ensure they work as smoothly as it possible:
+
+- [Manticoresearch](https://github.com/manticoresoftware/manticoresearch) through [mysql](https://github.com/felixge/node-mysql) adapter.
+
+## Example MySQL
+
+- Package install:
+
+  ```bash
+  $ npm install mysql dobo dobo-knex
+  ```
+- ```{dataDir}/config/.plugins``` file:
+
+  ```txt
+  ...
+  dobo
+  dobo-knex
+  ...
+  ```
+- ```{dataDir}/config/dobo.json``` file:
+
+  ```json
+  {
+    "connections": [{
+      "name": "default",
+      "type": "dbknex:mysql",
+      "connection": {
+        "host": "localhost",
+        "user": "myuser",
+        "password": "mypassword",
+        "database": "mydb"
+      }
+    }]
+  }
+  ```
+
+## Example SQLite3
+
+- Package install:
+
+  ```bash
+  $ npm install sqlite3 dobo dobo-knex
+  ```
+- ```{dataDir}/config/.plugins``` file:
+
+  ```txt
+  ...
+  dobo
+  dobo-knex
+  ...
+  ```
+- ```{dataDir}/config/dobo.json``` file:
+
+  ```json
+  {
+    "connections": [{
+      "name": "default",
+      "type": "dbknex:sqlite3",
+      "connection": {
+        "filename": "mydatabase.sqlite3"
+      }
+    }]
+  }
+  ```