initial commit 🎉

.editorconfig

@@ -0,0 +1,15 @@
+# http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 80
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = false

.eslintrc.json

@@ -0,0 +1,29 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": { "project": "./tsconfig.json" },
+  "env": { "es6": true },
+  "ignorePatterns": ["node_modules", "build", "coverage"],
+  "plugins": ["import", "eslint-comments"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:eslint-comments/recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:import/typescript",
+        "prettier",
+    "prettier/@typescript-eslint"
+  ],
+  "globals": { "BigInt": true, "console": true, "WebAssembly": true },
+  "rules": {
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "eslint-comments/disable-enable-pair": [
+      "error",
+      { "allowWholeFile": true }
+    ],
+    "eslint-comments/no-unused-disable": "error",
+    "import/order": [
+      "error",
+      { "newlines-between": "always" }
+    ]
+  }
+}

.gitignore

@@ -0,0 +1,5 @@
+.idea/*
+dist
+node_modules
+test
+yarn.lock

.prettierignore

@@ -0,0 +1,2 @@
+# package.json is formatted by package managers, so we ignore it here
+package.json

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright © 2023 Dawid Wetzler <[email protected]>
+
+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.

README.md

@@ -0,0 +1,87 @@
+# Kysely - Capacitor SQLite
+
+Custom dialect for [kysely] to use together with [capacitor sqlite][capacitor-sqlite].
+
+## Installation
+Ensure that you have [kysely][kysely], [@capacitor-community/sqlite][capacitor-sqlite] with `capacitor-sqlite-kysely` installed. 
+
+```
+npm install --save kysely @capacitor-community/sqlite capacitor-sqlite-kysely
+```
+
+```
+yarn add kysely @capacitor-community/sqlite capacitor-sqlite-kysely
+```
+
+```
+pnpm install --save kysely
+pnpm install --save @capacitor-community/sqlite
+pnpm install --save capacitor-sqlite-kysely
+```
+
+Please refer to [`@capacitor-community/sqlite`][capacitor-sqlite] as there is manual configuration necessary to run on the web for example.
+
+## Usage
+
+```typescript
+import { Kysely } from 'kysely';
+import CapacitorSQLiteKyselyDialect from 'capacitor-sqlite-kysely';
+import { CapacitorSQLite, SQLiteConnection } from '@capacitor-community/sqlite';
+
+export default new Kysely({
+  dialect: new CapacitorSQLiteKyselyDialect(
+    new SQLiteConnection(CapacitorSQLite),
+    { name: 'database' }
+  ),
+});
+```
+
+## Configuration
+
+```typescript
+interface CapacitorSQLiteKyselyConfig {
+  /**
+   * name of database
+   *
+   * @default database
+   */
+  name: string;
+
+  /**
+   * whether the database should be encrypted
+   *
+   * @default false
+   */
+  encryption: boolean;
+
+  /**
+   * whether the database should be encrypted
+   *
+   * @default 'no-encryption'
+   * @modes "no-encryption", "encryption", "secret", "decryption", "newsecret", "wrongsecret"
+   */
+  mode: string;
+
+  /**
+   * @default 1
+   */
+  version: number;
+
+  /**
+   * whether use the database in read only mode
+   *
+   * @default false
+   */
+  readonly: boolean;
+}
+
+```
+
+For further readings please refer to [@capacitor-community/sqlite][capacitor-sqlite].
+
+## License
+
+MIT License, see `LICENSE`.
+
+[capacitor-sqlite]: https://github.com/capacitor-community/sqlite
+[kysely]: https://kysely.dev