vue3-pouch 0.0.1

package/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["Vue.volar"]
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Loseq
+
+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,62 @@
+# pouch-db-vue
+
+A Vue 3 composable for reactive PouchDB integration.
+
+## Features
+
+- Reactive PouchDB queries using Vue 3 composition API
+- Real-time updates through PouchDB change events
+- Type-safe database operations
+- Supports find queries, document retrieval and allDocs
+
+## Installation
+
+```sh
+npm install vue3-pouch pouchdb pouchdb-find
+```
+
+## Usage
+
+```ts
+import { usePouchRef } from 'vue3-pouch'
+import PouchDB from 'pouchdb-browser'
+import find from 'pouchdb-find'
+
+// Register PouchDB plugins
+PouchDB.plugin(find)
+
+// Initialize database
+const db = new PouchDB<YourDocType>('my-database')
+
+// Use in component
+
+  // Query by selector
+  const { content: posts } = usePouchRef({
+    selector: { type: 'post' }
+  }, db)
+
+  // Get single document
+  const { content: singleDoc } = usePouchRef('doc-id', db)
+
+  // Get all documents
+  const { content: allDocs } = usePouchRef('all', db)
+
+```
+
+## API
+
+### usePouchRef(findParams, db)
+
+Creates a reactive reference to PouchDB query results.
+
+Parameters:
+- `findParams`: PouchDB find query object, document ID string, or "all" 
+- `db`: PouchDB database instance
+
+Returns:
+- `content`: Readonly ref containing query results
+
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "vue3-pouch",
+  "version": "0.0.1",
+  "type": "module",
+  "scripts": {
+    "build": "tsdown"
+  },
+  "peerDependencies": {
+    "pouchdb": "9.0.0",
+    "pouchdb-find": "9.0.0",
+    "vue": "^3.5.17"
+  },
+  "devDependencies": {
+    "@tsconfig/node22": "^22.0.2",
+    "@types/pouchdb": "^6.4.2",
+    "@types/pouchdb-find": "^7.3.3",
+    "@vitejs/plugin-vue": "^6.0.0",
+    "@vue/tsconfig": "^0.7.0",
+    "npm-run-all2": "^8.0.4",
+    "tsdown": "^0.14.2",
+    "typescript": "~5.8.0",
+    "unplugin-vue": "^7.0.1",
+    "vite": "npm:rolldown-vite@latest",
+    "vite-plugin-vue-devtools": "^7.7.7",
+    "vue-tsc": "^2.2.10"
+  }
+}

package/src/composable/usePouchRef.ts

@@ -0,0 +1,41 @@
+import { ref, onMounted, onUnmounted, readonly } from 'vue'
+import type { PouchDatabase, PouchExistingDocument, PouchFindParams, PouchFindResponse, PouchObserver } from '../types';
+
+
+export function usePouchRef<C extends {}>(findParams: PouchFindParams<C> | "all" | string, db: PouchDatabase<C>) {
+    const contentWrite = ref<PouchFindResponse<C> | PouchExistingDocument<C> | null>(null)
+
+    const content = readonly(contentWrite)
+
+    let observer: PouchObserver | undefined;
+    onMounted(async () => {
+        if (findParams === "all") {
+            contentWrite.value = await db.allDocs()
+        }
+        else if (typeof findParams === 'string') {
+            contentWrite.value = await db.get(findParams)
+        }
+        else {
+            contentWrite.value = await db.find(findParams)
+        }
+        observer = db.changes({
+            since: 'now',
+            live: true
+        }).on('change', async () => {
+            if (findParams === "all") {
+                contentWrite.value = await db.allDocs()
+            }
+            else if (typeof findParams === 'string') {
+                contentWrite.value = await db.get(findParams)
+            }
+            else {
+                contentWrite.value = await db.find(findParams)
+            }
+        })
+    })
+    onUnmounted(() => {
+        observer?.cancel()
+    })
+
+    return { content }
+}

package/src/plugin/index.ts

@@ -0,0 +1 @@
+export { usePouchRef } from '../composable/usePouchRef'

package/src/types/index.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="pouchdb-core" />
+/// <reference types="pouchdb-adapter-idb" />
+/// <reference types="pouchdb-adapter-websql" />
+/// <reference types="pouchdb-adapter-http" />
+/// <reference types="pouchdb-mapreduce" />
+/// <reference types="pouchdb-replication" />
+/// <reference types="pouchdb-find" />
+
+
+export type PouchDatabase<T extends {}> = PouchDB.Database<T>
+
+export type PouchFindParams<T extends {}> = PouchDB.Find.FindRequest<T>
+
+export type PouchFindResponse<T extends {}> = PouchDB.Find.FindResponse<T>
+
+export type PouchObserver = PouchDB.Core.Changes<{}>
+
+export type PouchExistingDocument<T extends {}> = PouchDB.Core.ExistingDocument<T>
+
+export type PouchExistingDocumentArray<T extends {}> = Array<{
+    docs: PouchDB.Core.ExistingDocument<T>
+}>

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "extends": "@tsconfig/node22/tsconfig.json",
+  "include": [
+    "vite.config.*",
+    "vitest.config.*",
+    "cypress.config.*",
+    "nightwatch.conf.*",
+    "playwright.config.*",
+    "eslint.config.*",
+    "test/vite.config.ts"
+  ],
+  "compilerOptions": {
+    "noEmit": true,
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+    "allowSyntheticDefaultImports": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "types": [
+      "node"
+    ]
+  }
+}

package/tsdown.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from 'tsdown'
+import Vue from 'unplugin-vue/rolldown'
+export default defineConfig([
+    {
+        entry: ['./src/plugin/index.ts'],
+        target: 'node20',
+        platform: 'neutral',
+        plugins: [Vue({ isProduction: true })],
+        dts: true,
+
+    },
+])