@powersync/nuxt 0.0.0-dev-20260128023420

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README

@@ -0,0 +1,374 @@
+<div align="center">
+  <img src="./src/runtime/assets/powersync-icon.svg" alt="PowerSync Logo" width="64" height="64" />
+  <h1>PowerSync Nuxt</h1>
+  <p>Local-first apps made simple</p>
+  <p>Effortless offline-first development with PowerSync integration for Nuxt applications.</p>
+</div>
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+[![Nuxt][nuxt-src]][nuxt-href]
+
+PowerSync Nuxt module integrated with the [Nuxt Devtools](https://github.com/nuxt/devtools).
+
+- [✨ &nbsp;Release Notes](/CHANGELOG.md)
+
+## Features
+
+- 🔍 **Built-in Diagnostics** - Direct access to PowerSync instance monitoring and real-time connection insights
+- 🗄️ **Data Inspection** - Seamless local data browsing with powerful debugging and troubleshooting tools
+- ⚡ **Useful Composables** - Ready-to-use Vue composables for rapid offline-first application development
+- 📦 **All-in-One** - Exposes all `@powersync/vue` composables, making this the only required dependency
+
+## Installation
+
+This module exposes all `@powersync/vue` composables, so you only need to install `@powersync/nuxt`:
+
+```bash
+# Using pnpm
+pnpm add -D @powersync/nuxt vite-plugin-top-level-await vite-plugin-wasm
+
+# Using yarn
+yarn add --dev @powersync/nuxt vite-plugin-top-level-await vite-plugin-wasm
+
+# Using npm
+npm install --save-dev @powersync/nuxt vite-plugin-top-level-await vite-plugin-wasm
+```
+> [!NOTE]
+> This module works with `Nuxt 4` and should work with `Nuxt 3` but has not been tested. Support for Nuxt 2 is not guaranteed or planned.
+
+## Quick Start
+
+1. Add `@powersync/nuxt` to the `modules` section of `nuxt.config.ts`:
+
+```typescript
+import wasm from 'vite-plugin-wasm'
+
+export default defineNuxtConfig({
+  modules: ['@powersync/nuxt'],
+  vite: {
+    optimizeDeps: {
+      exclude: ['@journeyapps/wa-sqlite', '@powersync/web'],
+      include: ['@powersync/web > js-logger'], // <-- Include `js-logger` when it isn't installed and imported.
+    },
+    worker: {
+      format: 'es',
+      plugins: () => [wasm()],
+    },
+  },
+})
+```
+
+> [!WARNING]  
+> If you are using Tailwind in your project see [Known Issues section](#known-issues)
+
+2. Create a PowerSync plugin (e.g., `plugins/powersync.client.ts`):
+
+```typescript
+import { NuxtPowerSyncDatabase } from '@powersync/nuxt'
+import { createPowerSyncPlugin } from '@powersync/nuxt'
+import { AppSchema } from '~/powersync/AppSchema'
+import { PowerSyncConnector } from '~/powersync/PowerSyncConnector'
+
+export default defineNuxtPlugin({
+  async setup(nuxtApp) {
+    const db = new NuxtPowerSyncDatabase({
+      database: {
+        dbFilename: 'your-db-filename.sqlite',
+      },
+      schema: AppSchema,
+    })
+
+    const connector = new PowerSyncConnector()
+
+    await db.init()
+    await db.connect(connector)
+
+    const plugin = createPowerSyncPlugin({ database: db })
+    nuxtApp.vueApp.use(plugin)
+  },
+})
+```
+
+At this point, you're all set to use the module composables. The module automatically exposes all `@powersync/vue` composables, so you can use them directly:
+
+- `usePowerSync()` - Access the PowerSync database instance
+- `useQuery()` - Query the database reactively
+- And more... (see [API Reference](#api-reference))
+
+## Setting up PowerSync
+
+This guide will walk you through the steps to set up PowerSync in your Nuxt project.
+
+### Create your Schema
+
+Create a file called `AppSchema.ts` and add your schema to it.
+
+```typescript
+import { column, Schema, Table } from '@powersync/web'
+
+const lists = new Table({
+  created_at: column.text,
+  name: column.text,
+  owner_id: column.text,
+})
+
+const todos = new Table(
+  {
+    list_id: column.text,
+    created_at: column.text,
+    completed_at: column.text,
+    description: column.text,
+    created_by: column.text,
+    completed_by: column.text,
+    completed: column.integer,
+  },
+  { indexes: { list: ['list_id'] } },
+)
+
+export const AppSchema = new Schema({
+  todos,
+  lists,
+})
+
+// For types
+export type Database = (typeof AppSchema)['types']
+export type TodoRecord = Database['todos']
+export type ListRecord = Database['lists']
+```
+
+> **Tip**: Learn more about how to create your schema [here](https://docs.powersync.com/client-sdk-references/javascript-web#1-define-the-schema).
+
+### Create your Connector
+
+Create a file called `PowerSyncConnector.ts` and add your connector to it.
+
+```typescript
+import { UpdateType, type PowerSyncBackendConnector } from '@powersync/web'
+
+export class PowerSyncConnector implements PowerSyncBackendConnector {
+  async fetchCredentials() {
+    // Implement fetchCredentials to obtain a JWT from your authentication service.
+    // See https://docs.powersync.com/installation/authentication-setup
+    // If you're using Supabase or Firebase, you can re-use the JWT from those clients, see
+    // - https://docs.powersync.com/installation/authentication-setup/supabase-auth
+    // - https://docs.powersync.com/installation/authentication-setup/firebase-auth
+    return {
+      endpoint: '[Your PowerSync instance URL or self-hosted endpoint]',
+      // Use a development token (see Authentication Setup https://docs.powersync.com/installation/authentication-setup/development-tokens) to get up and running quickly
+      token: 'An authentication token',
+    }
+  }
+
+  async uploadData(db: any) {
+    // Implement uploadData to send local changes to your backend service.
+    // You can omit this method if you only want to sync data from the database to the client
+
+    // See example implementation here: https://docs.powersync.com/client-sdk-references/javascript-web#3-integrate-with-your-backend
+    // see demos here: https://github.com/powersync-ja/powersync-js/tree/main/demos
+    return
+  }
+}
+```
+
+> **Tip**: Learn more about how to create your connector [here](https://docs.powersync.com/client-sdk-references/javascript-web#3-integrate-with-your-backend).
+
+### Create your PowerSync Plugin
+
+Finally, putting everything together, create a [plugin](https://nuxt.com/docs/4.x/guide/directory-structure/app/plugins) called `powersync.client.ts` to setup PowerSync.
+
+```typescript
+import { createPowerSyncPlugin } from '@powersync/nuxt'
+import { NuxtPowerSyncDatabase } from '@powersync/nuxt'
+import { AppSchema } from '~/powersync/AppSchema'
+import { PowerSyncConnector } from '~/powersync/PowerSyncConnector'
+
+export default defineNuxtPlugin({
+  async setup(nuxtApp) {
+    const db = new NuxtPowerSyncDatabase({
+      database: {
+        dbFilename: 'a-db-name.sqlite',
+      },
+      schema: AppSchema,
+    })
+
+    const connector = new PowerSyncConnector()
+
+    await db.init()
+    await db.connect(connector)
+
+    const plugin = createPowerSyncPlugin({ database: db })
+
+    nuxtApp.vueApp.use(plugin)
+  },
+})
+```
+
+### Kysely ORM (Optional)
+
+You can use Kysely as your ORM to interact with the database. The module provides a `usePowerSyncKysely()` composable:
+
+```typescript
+import { usePowerSyncKysely } from '@powersync/nuxt'
+import { type Database } from '../powersync/AppSchema'
+
+// In your component or composable
+const db = usePowerSyncKysely<Database>()
+
+// Use the db object to interact with the database
+const users = await db.selectFrom('users').selectAll().execute()
+```
+
+### Enabling Diagnostics
+
+To enable the PowerSync Inspector with diagnostics capabilities:
+
+1. **Enable diagnostics in your config**:
+
+```typescript
+export default defineNuxtConfig({
+  modules: ['@powersync/nuxt'],
+  powersync: {
+    useDiagnostics: true, // <- Add this
+  },
+  vite: {
+    optimizeDeps: {
+      exclude: ['@journeyapps/wa-sqlite', '@powersync/web'],
+      include: ['@powersync/web > js-logger'],
+    },
+    worker: {
+      format: 'es',
+      plugins: () => [wasm()],
+    },
+  },
+})
+```
+
+When `useDiagnostics: true` is set, `NuxtPowerSyncDatabase` automatically:
+- Extend your schema with diagnostics schema
+- Sets up diagnostics recording
+- Stores the connector internally (accessible via diagnostics)
+- Configures logging for diagnostics
+
+
+2. **Accessing PowerSync Inspector**:
+
+Once diagnostics are enabled, you can access the [PowerSync Inspector](#powersync-inspector):
+
+- **Direct URL**: `http://localhost:3000/__powersync-inspector`
+- **Via Nuxt Devtools**: Open Devtools and look for the PowerSync tab (Instable until proper multitab support for diagnostics in implemented)
+
+
+
+## PowerSync Inspector
+
+PowerSync Inspector is a tool that helps inspect and diagnose the state of your PowerSync client directly from your app in real-time.
+
+### Setup
+
+To setup the PowerSync inspector, you need to follow the steps in the [Enabling Diagnostics](#enabling-diagnostics) section.
+
+Once setup, the inspector can be accessed on the `http://localhost:3000/__powersync-inspector` route or via the [Nuxt Devtools](#nuxt-devtools).
+
+### Features
+
+#### Sync Status
+
+The `Sync Status` tab provides a real-time view of the sync status of your PowerSync client, including:
+- Connection status
+- Sync progress
+- Upload queue statistics
+- Error monitoring
+
+#### Data Inspector
+
+Browse and inspect your local database tables and data with powerful filtering and search capabilities.
+
+#### Config Inspector
+
+View and inspect your PowerSync configuration, connection options, and schema information.
+
+#### Logs
+
+Real-time logging of PowerSync operations with syntax highlighting and search functionality.
+
+#### Nuxt Devtools
+
+The inspector is also available in the Nuxt Devtools as a tab, providing seamless integration with your development workflow.
+
+> [!WARNING]  
+> Multitab support is still not fully supported when diagnostics are enabled which causes the inspector to malfunction in the devtool. see [Known Issues section](#known-issues)
+
+## Known Issues
+
+1. Enabling diagnostics makes your app glitch when operating in a multi-tab environment. You can observe this issue when you open the inspector in the devtools, for example.
+
+2. PowerSync Inspector relies on `unocss` as a transitive dependency. It might clash with your existing setup, for example if you use Tailwind CSS.
+
+To fix this, you can add the following to your `nuxt.config.ts`:
+
+```typescript
+export default defineNuxtConfig({
+  unocss: {
+    icons: true,
+    blocklist: [/\$\{.*\}/],
+    content: {
+      pipeline: {
+        exclude: [
+          './layouts/*/**',
+          './pages/*/**',
+          './components/*/**',
+          './composables/*/**',
+          './utils/*/**',
+          './types/*/**',
+        ],
+      },
+    },
+  },
+})
+```
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Generate type stubs
+pnpm run dev:prepare
+
+# Run Vitest
+pnpm run test
+pnpm run test:watch
+```
+
+## Local Testing
+
+If the playground is not enough for you, you can test the module locally by cloning this repo and pointing the nuxt app you want to test to the local module.
+
+Don't forget to add a watcher for the module for hot reloading.
+
+Example (in your nuxt app):
+
+```typescript
+import { defineNuxtConfig } from 'nuxt/config'
+
+export default defineNuxtConfig({
+  modules: ['../../my-location/@powersync/nuxt/src/*'],
+  watch: ['../../my-location/@powersync/nuxt/src/*'],
+})
+```
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/@powersync/nuxt/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-version-href]: https://npmjs.com/package/@powersync/nuxt
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/@powersync/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-downloads-href]: https://npmjs.com/package/@powersync/nuxt
+
+[license-src]: https://img.shields.io/npm/l/@powersync/nuxt.svg?style=flat&colorA=18181B&colorB=28CF8D
+[license-href]: https://npmjs.com/package/@powersync/nuxt
+
+[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
+[nuxt-href]: https://nuxt.com

package/dist/module.d.mts

@@ -0,0 +1,39 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+/**
+ * Configuration options for the PowerSync Nuxt module.
+ *
+ * @example
+ * ```typescript
+ * export default defineNuxtConfig({
+ *   modules: ['@powersync/nuxt'],
+ *   powersync: {
+ *     useDiagnostics: true,
+ *   },
+ * })
+ * ```
+ */
+interface PowerSyncNuxtModuleOptions {
+    /**
+     * Enable diagnostics and the PowerSync Inspector.
+     *
+     * When set to `true`, enables diagnostics recording and makes the PowerSync Inspector available.
+     * The inspector provides real-time monitoring, data inspection, and debugging tools.
+     *
+     * @default false
+     */
+    useDiagnostics?: boolean;
+    /**
+     * Enable Kysely integration.
+     *
+     * When set to `true`, enables the `usePowerSyncKysely` composable for type-safe database queries.
+     * Requires `@powersync/kysely-driver` to be installed.
+     *
+     * @default false
+     */
+    kysely?: boolean;
+}
+declare const _default: _nuxt_schema.NuxtModule<PowerSyncNuxtModuleOptions, PowerSyncNuxtModuleOptions, false>;
+
+export { _default as default };
+export type { PowerSyncNuxtModuleOptions };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "powersync-nuxt",
+  "configKey": "powersync",
+  "version": "0.1.0",
+  "builder": {
+    "@nuxt/module-builder": "1.0.2",
+    "unbuild": "3.6.1"
+  }
+}