Compare commits
72 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| eb7ad636dc | |||
| ffb1eb43c7 | |||
| f504c6b79a | |||
| 6b4d1ed0ae | |||
| 3ef0d69ded | |||
| edcf10eea1 | |||
| 89d50bd977 | |||
| 30407511a4 | |||
| 0abeb6b265 | |||
| d746f451dd | |||
| 5a7936aac4 | |||
| 64a4fa5383 | |||
| bf7f9db63d | |||
| 71837428dd | |||
| 12d62d873b | |||
| 61cc32381b | |||
| 42b3b8375a | |||
| bdab2c5395 | |||
| d6b8e91f06 | |||
| 8bb7665af5 | |||
| 644ccc237d | |||
| 84a2c821e9 | |||
| 386c7dac05 | |||
| 1bec7a703d | |||
| 0b575fa322 | |||
| 4c5a0345a8 | |||
| ea7c7b02d6 | |||
| 9296ae7d78 | |||
| 549b2f30be | |||
| 4bc07425b4 | |||
| b0fb2edc24 | |||
| 9b63877eaa | |||
| ba845931da | |||
| 3d7503e227 | |||
| c570597d06 | |||
| e7c7beb8fd | |||
| 037920620e | |||
| 0f73464afe | |||
| 5bf554fbdf | |||
| b566196c96 | |||
| 4da24986ee | |||
| ced2c77427 | |||
| 431d3784fe | |||
| 033380e051 | |||
| 0db6bddbc4 | |||
| 0dfad07399 | |||
| e6b8b7d0fa | |||
| 0cdba0d764 | |||
| 9c0e0baf95 | |||
| 925d382f2f | |||
| 3ff97569f5 | |||
| 52a5ae9180 | |||
| 4647fbda16 | |||
| 647d26db85 | |||
| 40b8ca91ee | |||
| d92a58b2ad | |||
| 5a43ebe06f | |||
| 56259adaf7 | |||
| 470f272183 | |||
| e2d37c2efe | |||
| 487cca530b | |||
| 9e867fc0b3 | |||
| 23ec1989f7 | |||
| 1c3608743e | |||
| 33bb3cc550 | |||
| fe1807fcd5 | |||
| aaef56cb29 | |||
| 32846c1e44 | |||
| 771e071005 | |||
| 2ba8bdadfc | |||
| 6c057d4cd7 | |||
| 00259fc865 |
@ -1,2 +1,5 @@
|
||||
dist
|
||||
node_modules
|
||||
docs
|
||||
.github
|
||||
.vscode
|
||||
|
||||
1
.github/FUNDING.yml
vendored
Normal file
1
.github/FUNDING.yml
vendored
Normal file
@ -0,0 +1 @@
|
||||
github: [arashsheyda]
|
||||
82
.github/workflows/studio.yml
vendored
Normal file
82
.github/workflows/studio.yml
vendored
Normal file
@ -0,0 +1,82 @@
|
||||
|
||||
name: studio-nuxt-build
|
||||
run-name: studio nuxt build
|
||||
|
||||
on:
|
||||
# Runs on pushes targeting the default branch
|
||||
push:
|
||||
branches: ["main"]
|
||||
|
||||
# Allows you to run this workflow manually from the Actions tab
|
||||
workflow_dispatch:
|
||||
|
||||
# Add write workflow permissions
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
# Allow one concurrent deployment
|
||||
concurrency:
|
||||
group: "pages"
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
# Build job
|
||||
build-and-deploy:
|
||||
if: startsWith(github.event.head_commit.message, 'docs:')
|
||||
runs-on: ${{ matrix.os }}
|
||||
defaults:
|
||||
run:
|
||||
working-directory: docs
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-latest]
|
||||
node: [18]
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Identify package manager
|
||||
id: pkgman
|
||||
run: |
|
||||
cache=`[ -f "docs/pnpm-lock.yaml" ] && echo "pnpm" || ([ -f "docs/package-lock.json" ] && echo "npm" || ([ -f "docs/yarn.lock" ] && echo "yarn" || echo ""))`
|
||||
package_manager=`[ ! -z "$cache" ] && echo "$cache" || echo "pnpm"`
|
||||
echo "cache=$cache" >> $GITHUB_OUTPUT
|
||||
echo "package_manager=$package_manager" >> $GITHUB_OUTPUT
|
||||
|
||||
- uses: pnpm/action-setup@v2.2.4
|
||||
if: ${{ steps.pkgman.outputs.package_manager == 'pnpm' }}
|
||||
name: Install pnpm
|
||||
id: pnpm-install
|
||||
with:
|
||||
version: 7
|
||||
|
||||
- uses: actions/setup-node@v3
|
||||
with:
|
||||
version: ${{ matrix.node }}
|
||||
cache: ${{ steps.pkgman.outputs.cache }}
|
||||
|
||||
- name: Install dependencies
|
||||
run: ${{ steps.pkgman.outputs.package_manager }} install --no-frozen-lockfile
|
||||
|
||||
- name: Install @nuxthq/studio
|
||||
run: ${{ steps.pkgman.outputs.package_manager }} add -D @nuxthq/studio
|
||||
|
||||
- name: Create .nuxtrc
|
||||
run: echo 'modules[]=@nuxthq/studio' > .nuxtrc
|
||||
|
||||
- name: Generate
|
||||
run: ${{ steps.pkgman.outputs.package_manager }} nuxi generate
|
||||
env:
|
||||
NUXT_PUBLIC_STUDIO_API_URL: https://api.nuxt.studio
|
||||
NUXT_PUBLIC_STUDIO_TOKENS: 6222c5e49391ad99e20e3c1b1a475c656436e8b0877c32021147d8727205c440
|
||||
|
||||
- name: Add .nojekyll file
|
||||
run: touch .output/public/.nojekyll
|
||||
|
||||
# Deployment job
|
||||
- name: Deploy 🚀
|
||||
uses: JamesIves/github-pages-deploy-action@v4
|
||||
with:
|
||||
folder: docs/.output/public
|
||||
2
.nuxtrc
Normal file
2
.nuxtrc
Normal file
@ -0,0 +1,2 @@
|
||||
# enable TypeScript bundler module resolution - https://www.typescriptlang.org/docs/handbook/modules/reference.html#bundler
|
||||
experimental.typescriptBundlerResolution=true
|
||||
3
.vscode/settings.json
vendored
3
.vscode/settings.json
vendored
@ -1,3 +0,0 @@
|
||||
{
|
||||
"editor.tabSize": 2,
|
||||
}
|
||||
227
CHANGELOG.md
227
CHANGELOG.md
@ -1,6 +1,233 @@
|
||||
# Changelog
|
||||
|
||||
|
||||
## v1.0.6
|
||||
|
||||
[compare changes](https://github.com/arashsheyda/nuxt-mongoose/compare/v1.0.4...v1.1.0)
|
||||
|
||||
### 🚀 Enhancements
|
||||
|
||||
- Add discriminator helper ([#47](https://github.com/arashsheyda/nuxt-mongoose/pull/47))
|
||||
|
||||
### 🩹 Fixes
|
||||
|
||||
- Replace consola with logger ([5a7936a](https://github.com/arashsheyda/nuxt-mongoose/commit/5a7936a))
|
||||
- Continue module setup process Without MONGODB_URI ([#54](https://github.com/arashsheyda/nuxt-mongoose/pull/54))
|
||||
|
||||
### 📖 Documentation
|
||||
|
||||
- Update examples ([0abeb6b](https://github.com/arashsheyda/nuxt-mongoose/commit/0abeb6b))
|
||||
- Fix examples list ([3040751](https://github.com/arashsheyda/nuxt-mongoose/commit/3040751))
|
||||
- Use new `nuxi module add` command in installation ([#53](https://github.com/arashsheyda/nuxt-mongoose/pull/53))
|
||||
|
||||
### 🏡 Chore
|
||||
|
||||
- **release:** V1.0.4 ([64a4fa5](https://github.com/arashsheyda/nuxt-mongoose/commit/64a4fa5))
|
||||
- **release:** V1.0.5 ([d746f45](https://github.com/arashsheyda/nuxt-mongoose/commit/d746f45))
|
||||
- Update readme with documentation redirection ([89d50bd](https://github.com/arashsheyda/nuxt-mongoose/commit/89d50bd))
|
||||
- Move docs ([f504c6b](https://github.com/arashsheyda/nuxt-mongoose/commit/f504c6b))
|
||||
- Update readme ([ffb1eb4](https://github.com/arashsheyda/nuxt-mongoose/commit/ffb1eb4))
|
||||
|
||||
### ❤️ Contributors
|
||||
|
||||
- Arash ([@arashsheyda](http://github.com/arashsheyda))
|
||||
- Justin Bellero <jpbellero@gmail.com>
|
||||
- Roryc ([@Coiggahou2002](http://github.com/Coiggahou2002))
|
||||
- Daniel Roe ([@danielroe](http://github.com/danielroe))
|
||||
|
||||
## v1.0.5
|
||||
|
||||
[compare changes](https://github.com/arashsheyda/nuxt-mongoose/compare/v1.0.4...v1.0.5)
|
||||
|
||||
### 🩹 Fixes
|
||||
|
||||
- Replace consola with logger ([5a7936a](https://github.com/arashsheyda/nuxt-mongoose/commit/5a7936a))
|
||||
|
||||
### 🏡 Chore
|
||||
|
||||
- **release:** V1.0.4 ([64a4fa5](https://github.com/arashsheyda/nuxt-mongoose/commit/64a4fa5))
|
||||
|
||||
### ❤️ Contributors
|
||||
|
||||
- Arash <arashi.sheyda@gmail.com>
|
||||
|
||||
## v1.0.4
|
||||
|
||||
[compare changes](https://github.com/arashsheyda/nuxt-mongoose/compare/v1.0.3...v1.0.5)
|
||||
|
||||
### 💅 Refactors
|
||||
|
||||
- Split services into individual files ([d6b8e91](https://github.com/arashsheyda/nuxt-mongoose/commit/d6b8e91))
|
||||
|
||||
### 📖 Documentation
|
||||
|
||||
- Update dependencies ([12d62d8](https://github.com/arashsheyda/nuxt-mongoose/commit/12d62d8))
|
||||
- Update dependencies ([7183742](https://github.com/arashsheyda/nuxt-mongoose/commit/7183742))
|
||||
|
||||
### 🏡 Chore
|
||||
|
||||
- Test bundler module resolution ([#36](https://github.com/arashsheyda/nuxt-mongoose/pull/36))
|
||||
- Update dependencies ([#38](https://github.com/arashsheyda/nuxt-mongoose/pull/38))
|
||||
- Update dependencies ([bdab2c5](https://github.com/arashsheyda/nuxt-mongoose/commit/bdab2c5))
|
||||
- Update playground ([42b3b83](https://github.com/arashsheyda/nuxt-mongoose/commit/42b3b83))
|
||||
- Update cover ([61cc323](https://github.com/arashsheyda/nuxt-mongoose/commit/61cc323))
|
||||
- Update cover ([bf7f9db](https://github.com/arashsheyda/nuxt-mongoose/commit/bf7f9db))
|
||||
|
||||
### ❤️ Contributors
|
||||
|
||||
- Arash
|
||||
- Amir H. Moayeri
|
||||
- Daniel Roe <daniel@roe.dev>
|
||||
|
||||
## v1.0.3
|
||||
|
||||
[compare changes](https://github.com/arashsheyda/nuxt-mongoose/compare/v1.0.2...v1.0.3)
|
||||
|
||||
### 🩹 Fixes
|
||||
|
||||
- Add schema type ([4bc0742](https://github.com/arashsheyda/nuxt-mongoose/commit/4bc0742))
|
||||
|
||||
### 💅 Refactors
|
||||
|
||||
- Update to DevTools v1 ([1bec7a7](https://github.com/arashsheyda/nuxt-mongoose/commit/1bec7a7))
|
||||
|
||||
### 📖 Documentation
|
||||
|
||||
- Update ui ([9296ae7](https://github.com/arashsheyda/nuxt-mongoose/commit/9296ae7))
|
||||
- Fix playground path ([ea7c7b0](https://github.com/arashsheyda/nuxt-mongoose/commit/ea7c7b0))
|
||||
- Fix install workflow ([4c5a034](https://github.com/arashsheyda/nuxt-mongoose/commit/4c5a034))
|
||||
- Update link ([0b575fa](https://github.com/arashsheyda/nuxt-mongoose/commit/0b575fa))
|
||||
|
||||
### 🏡 Chore
|
||||
|
||||
- Remove comment ([549b2f3](https://github.com/arashsheyda/nuxt-mongoose/commit/549b2f3))
|
||||
|
||||
### ❤️ Contributors
|
||||
|
||||
- Arash
|
||||
|
||||
## v1.0.2
|
||||
|
||||
[compare changes](https://github.com/arashsheyda/nuxt-mongoose/compare/v1.0.1...v1.0.2)
|
||||
|
||||
### 🩹 Fixes
|
||||
|
||||
- Resolve build stuck issue with nitro pre-render enabled ([#26](https://github.com/arashsheyda/nuxt-mongoose/pull/26))
|
||||
|
||||
### 📖 Documentation
|
||||
|
||||
- Default connection ([e7c7beb](https://github.com/arashsheyda/nuxt-mongoose/commit/e7c7beb))
|
||||
|
||||
### 🏡 Chore
|
||||
|
||||
- **release:** V1.0.2 ([ba8459](https://github.com/arashsheyda/nuxt-mongoose/commit/ba8459))
|
||||
- Lint ([3d7503e](https://github.com/arashsheyda/nuxt-mongoose/commit/3d7503e))
|
||||
|
||||
### ❤️ Contributors
|
||||
|
||||
- Arash Sheyda <sheidaeearash1999@gmail.com>
|
||||
- Arash
|
||||
|
||||
## v1.0.1
|
||||
|
||||
### 🏡 Chore
|
||||
|
||||
- **release:** V1.0.0 ([b566196](https://github.com/arashsheyda/nuxt-mongoose/commit/b566196))
|
||||
- **release:** V1.0.1 ([5bf554f](https://github.com/arashsheyda/nuxt-mongoose/commit/5bf554f))
|
||||
- Update dependencies ([0f73464](https://github.com/arashsheyda/nuxt-mongoose/commit/0f73464))
|
||||
|
||||
### ❤️ Contributors
|
||||
|
||||
- Arash Sheyda <sheidaeearash1999@gmail.com>
|
||||
|
||||
## v1.0.0
|
||||
|
||||
[compare changes](https://github.com/arashsheyda/nuxt-mongoose/compare/v0.0.9...v1.0.0)
|
||||
|
||||
### 🚀 Enhancements
|
||||
|
||||
- Version 1.0.0 ([#21](https://github.com/arashsheyda/nuxt-mongoose/pull/21))
|
||||
|
||||
### 📖 Documentation
|
||||
|
||||
- Update docus ([0db6bdd](https://github.com/arashsheyda/nuxt-mongoose/commit/0db6bdd))
|
||||
|
||||
### ❤️ Contributors
|
||||
|
||||
- Arashsheyda <sheidaeearash1999@gmail.com>
|
||||
|
||||
## v0.0.9
|
||||
|
||||
[compare changes](https://github.com/arashsheyda/nuxt-mongoose/compare/v0.0.8...v0.0.9)
|
||||
|
||||
### 🚀 Enhancements
|
||||
|
||||
- Add possibility to type mongoose model ([#8](https://github.com/arashsheyda/nuxt-mongoose/pull/8))
|
||||
- Mongoose schema hooks ([d92a58b](https://github.com/arashsheyda/nuxt-mongoose/commit/d92a58b))
|
||||
|
||||
### 🩹 Fixes
|
||||
|
||||
- Update connection message in logger ([#10](https://github.com/arashsheyda/nuxt-mongoose/pull/10))
|
||||
|
||||
### 📖 Documentation
|
||||
|
||||
- **utils:** Add hooks and improve documentation ([647d26d](https://github.com/arashsheyda/nuxt-mongoose/commit/647d26d))
|
||||
- **utils:** Fix model options type ([3ff9756](https://github.com/arashsheyda/nuxt-mongoose/commit/3ff9756))
|
||||
- Add types link ([9c0e0ba](https://github.com/arashsheyda/nuxt-mongoose/commit/9c0e0ba))
|
||||
|
||||
### 🏡 Chore
|
||||
|
||||
- Fix defineNitroPlugin patch ([#9](https://github.com/arashsheyda/nuxt-mongoose/pull/9))
|
||||
- Example env ([40b8ca9](https://github.com/arashsheyda/nuxt-mongoose/commit/40b8ca9))
|
||||
- Fix defineNitroPlugin patch " ([#9](https://github.com/arashsheyda/nuxt-mongoose/pull/9))
|
||||
- Update dependencies ([925d382](https://github.com/arashsheyda/nuxt-mongoose/commit/925d382))
|
||||
- Lint ([0cdba0d](https://github.com/arashsheyda/nuxt-mongoose/commit/0cdba0d))
|
||||
- Fix tsconfig for build time ([e6b8b7d](https://github.com/arashsheyda/nuxt-mongoose/commit/e6b8b7d))
|
||||
|
||||
### ❤️ Contributors
|
||||
|
||||
- Arash Sheyda <sheidaeearash1999@gmail.com>
|
||||
- Amir-al-mohamad111
|
||||
- Oumar Barry ([@oumarbarry](http://github.com/oumarbarry))
|
||||
|
||||
## v0.0.8
|
||||
|
||||
[compare changes](https://github.com/arashsheyda/nuxt-mongoose/compare/v0.0.7...v0.0.8)
|
||||
|
||||
|
||||
### 🚀 Enhancements
|
||||
|
||||
- Documentation ([6ca94dc](https://github.com/arashsheyda/nuxt-mongoose/commit/6ca94dc))
|
||||
|
||||
### 🩹 Fixes
|
||||
|
||||
- Module options type ([182b760](https://github.com/arashsheyda/nuxt-mongoose/commit/182b760))
|
||||
- Run studio action only for docs ([33bb3cc](https://github.com/arashsheyda/nuxt-mongoose/commit/33bb3cc))
|
||||
- Resource generator modelsDir output ([1c36087](https://github.com/arashsheyda/nuxt-mongoose/commit/1c36087))
|
||||
|
||||
### 💅 Refactors
|
||||
|
||||
- Reuse vite's websocket ([aaef56c](https://github.com/arashsheyda/nuxt-mongoose/commit/aaef56c))
|
||||
|
||||
### 📖 Documentation
|
||||
|
||||
- Remove devtools ([6c057d4](https://github.com/arashsheyda/nuxt-mongoose/commit/6c057d4))
|
||||
- **devtools:** Demo video ([2ba8bda](https://github.com/arashsheyda/nuxt-mongoose/commit/2ba8bda))
|
||||
- Style ([23ec198](https://github.com/arashsheyda/nuxt-mongoose/commit/23ec198))
|
||||
- Favicon ([9e867fc](https://github.com/arashsheyda/nuxt-mongoose/commit/9e867fc))
|
||||
|
||||
### 🏡 Chore
|
||||
|
||||
- Playground example ([3356ffd](https://github.com/arashsheyda/nuxt-mongoose/commit/3356ffd))
|
||||
- **deployment:** Add workflow file ([00259fc](https://github.com/arashsheyda/nuxt-mongoose/commit/00259fc))
|
||||
- Update cover ([487cca5](https://github.com/arashsheyda/nuxt-mongoose/commit/487cca5))
|
||||
|
||||
### ❤️ Contributors
|
||||
|
||||
- Arash
|
||||
- Arash Sheyda <sheidaeearash1999@gmail.com>
|
||||
- Arashsheyda <sheidaeearash1999@gmail.com>
|
||||
|
||||
## v0.0.7
|
||||
|
||||
[compare changes](https://github.com/arashsheyda/nuxt-mongoose/compare/v0.0.6...v0.0.7)
|
||||
|
||||
61
README.md
61
README.md
@ -1,4 +1,4 @@
|
||||

|
||||

|
||||
|
||||
<div align="center">
|
||||
<h1>Nuxt Mongoose</h1>
|
||||
@ -10,7 +10,7 @@
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
pnpm add nuxt-mongoose
|
||||
npx nuxi@latest module add nuxt-mongoose
|
||||
```
|
||||
|
||||
## Usage
|
||||
@ -29,62 +29,7 @@ export default defineNuxtConfig({
|
||||
|
||||
### Configuration
|
||||
|
||||
You can configure the module by adding a `mongoose` section to your `nuxt.config` file.
|
||||
|
||||
```ts
|
||||
export default defineNuxtConfig({
|
||||
mongoose: {
|
||||
uri: 'process.env.MONGODB_URI',
|
||||
options: {},
|
||||
modelsDir: 'models',
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
by default, `nuxt-mongoose` will auto-import your schemas from the `models` directory from `server` directory. You can change this behavior by setting the `modelsDir` option.
|
||||
|
||||
* for more information about the options, please refer to the [Mongoose documentation](https://mongoosejs.com/docs/connections.html#options). *
|
||||
|
||||
## API
|
||||
|
||||
### defineMongooseConnection
|
||||
|
||||
This function creates a new Mongoose connection. Example usage:
|
||||
|
||||
```ts
|
||||
import { defineMongooseConnection } from '#nuxt/mongoose'
|
||||
|
||||
export const connection = defineMongooseConnection('mongodb://127.0.0.1/nuxt-mongoose')
|
||||
```
|
||||
|
||||
### defineMongooseModel
|
||||
|
||||
This function creates a new Mongoose model with schema. Example usage:
|
||||
|
||||
```ts
|
||||
import { defineMongooseModel } from '#nuxt/mongoose'
|
||||
|
||||
export const User = defineMongooseModel('User', {
|
||||
name: {
|
||||
type: String,
|
||||
required: true,
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
**or you could use it like:**
|
||||
|
||||
```ts
|
||||
export const User = defineMongooseModel({
|
||||
name: 'User',
|
||||
schema: {
|
||||
name: {
|
||||
type: String,
|
||||
required: true,
|
||||
},
|
||||
},
|
||||
})
|
||||
```
|
||||
For detailed [configuration](https://docs.arashsheyda.me/nuxt-mongoose/getting-started/configuration) and usage instructions, please refer to our [documentation](https://docs.arashsheyda.me/nuxt-mongoose).
|
||||
|
||||
## License
|
||||
|
||||
|
||||
@ -1,7 +1,3 @@
|
||||
<script lang="ts" setup>
|
||||
import './styles/global.css'
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<Html>
|
||||
<Body h-screen>
|
||||
|
||||
@ -1,33 +1,53 @@
|
||||
<script lang="ts" setup>
|
||||
defineProps({
|
||||
connection: {
|
||||
import { computed } from 'vue'
|
||||
|
||||
const props = defineProps({
|
||||
code: {
|
||||
type: Number,
|
||||
default: 0,
|
||||
},
|
||||
})
|
||||
|
||||
const connections = [
|
||||
{
|
||||
color: 'text-red-5',
|
||||
border: 'border-red-5',
|
||||
status: 'Not Connected',
|
||||
description: 'Please Check Your Connection!',
|
||||
},
|
||||
{
|
||||
color: 'text-green-5',
|
||||
border: 'border-green-5',
|
||||
status: 'Connected',
|
||||
description: 'Everything is Working Perfectly!',
|
||||
},
|
||||
{
|
||||
color: 'text-yellow-5',
|
||||
border: 'border-yellow-5',
|
||||
status: 'Connecting',
|
||||
description: 'Just a Moment, We"re Getting There!',
|
||||
},
|
||||
{
|
||||
color: 'text-orange-5',
|
||||
border: 'border-orange-5',
|
||||
status: 'Disconnecting',
|
||||
description: 'Preparing to Safely Disconnect!',
|
||||
},
|
||||
]
|
||||
|
||||
const connection = computed(() => connections[props.code])
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<NPanelGrids>
|
||||
<div flex="~ gap-2" animate-pulse items-center text-yellow>
|
||||
<NIcon icon="carbon-flow-connection" />
|
||||
Please check your mongodb connection
|
||||
</div>
|
||||
<div flex="~ gap-2" items-center text-light>
|
||||
Your current connection is: {{ connection }}
|
||||
<div flex="~ gap-2" animate-pulse items-center text-lg font-bold :class="connection.color">
|
||||
({{ code }}):
|
||||
{{ connection.status }},
|
||||
{{ connection.description }}
|
||||
</div>
|
||||
<div absolute bottom-10 left-10 right-10 flex justify-around>
|
||||
<NCard p2 text-red-5>
|
||||
0: Not connected
|
||||
</NCard>
|
||||
<NCard p2 text-green-5>
|
||||
1: Connected
|
||||
</NCard>
|
||||
<NCard p2 text-yellow-5>
|
||||
2: Connecting
|
||||
</NCard>
|
||||
<NCard p2 text-orange-5>
|
||||
3: Disconnecting
|
||||
<NCard v-for="item, index of connections" :key="index" p2 :class="[item.color, item.status === connection.status ? item.border : '']">
|
||||
({{ index }}): {{ item.status }}
|
||||
</NCard>
|
||||
</div>
|
||||
</NPanelGrids>
|
||||
|
||||
@ -1,4 +1,8 @@
|
||||
<script lang="ts" setup>
|
||||
import { useRouter } from 'nuxt/app'
|
||||
import { computed, reactive, ref } from 'vue'
|
||||
import { rpc } from '../composables/rpc'
|
||||
|
||||
interface ColumnInterface {
|
||||
name: string
|
||||
type: string
|
||||
@ -115,18 +119,16 @@ const convertedBread = computed(() => {
|
||||
const formattedFields = computed(() => {
|
||||
return fields.value.map((field) => {
|
||||
for (const [key, value] of Object.entries(field)) {
|
||||
if (!value) {
|
||||
// @ts-expect-error - no need for type checking
|
||||
if (!value)
|
||||
delete field[key]
|
||||
}
|
||||
}
|
||||
|
||||
return field
|
||||
})
|
||||
})
|
||||
|
||||
async function generate() {
|
||||
await rpc.generateResource(
|
||||
await rpc.value?.generateResource(
|
||||
{
|
||||
name: collection.value,
|
||||
fields: schema.value ? formattedFields.value : undefined,
|
||||
@ -142,6 +144,7 @@ async function generate() {
|
||||
const toggleSchema = computed({
|
||||
get() {
|
||||
if (hasBread.value)
|
||||
// eslint-disable-next-line vue/no-side-effects-in-computed-properties
|
||||
return schema.value = true
|
||||
return schema.value
|
||||
},
|
||||
@ -246,8 +249,8 @@ const toggleSchema = computed({
|
||||
<NTextInput v-else v-model="column.default" n="orange" />
|
||||
</div>
|
||||
<div flex justify-center gap2>
|
||||
<NIconButton icon="carbon-add" n="cyan" @click="addField(index)" />
|
||||
<NIconButton icon="carbon-delete" n="red" @click="removeField(index)" />
|
||||
<NButton icon="carbon-add" n="cyan" @click="addField(index)" />
|
||||
<NButton icon="carbon-trash-can" n="red" @click="removeField(index)" />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@ -257,5 +260,3 @@ const toggleSchema = computed({
|
||||
</NButton>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<style></style>
|
||||
|
||||
@ -1,4 +1,9 @@
|
||||
<script lang="ts" setup>
|
||||
import { computed, reactive, ref, watch } from 'vue'
|
||||
import { computedAsync } from '@vueuse/core'
|
||||
import { rpc } from '../composables/rpc'
|
||||
import { useCopy } from '../composables/editor'
|
||||
|
||||
const props = defineProps({
|
||||
collection: {
|
||||
type: String,
|
||||
@ -10,19 +15,19 @@ const props = defineProps({
|
||||
const pagination = reactive({ limit: 20, page: 1 })
|
||||
|
||||
const countDocuments = computedAsync(async () => {
|
||||
return await rpc.countDocuments(props.collection)
|
||||
return await rpc.value?.countDocuments(props.collection)
|
||||
})
|
||||
|
||||
const documents = computedAsync(async () => {
|
||||
return await rpc.listDocuments(props.collection, pagination)
|
||||
return await rpc.value?.listDocuments(props.collection, pagination)
|
||||
})
|
||||
|
||||
watch(pagination, async () => {
|
||||
documents.value = await rpc.listDocuments(props.collection, pagination)
|
||||
documents.value = await rpc.value?.listDocuments(props.collection, pagination)
|
||||
})
|
||||
|
||||
const schema = computedAsync<any>(async () => {
|
||||
return await rpc.resourceSchema(props.collection)
|
||||
return await rpc.value?.resourceSchema(props.collection)
|
||||
})
|
||||
|
||||
const fields = computed(() => {
|
||||
@ -79,14 +84,17 @@ function editDocument(document: any) {
|
||||
}
|
||||
|
||||
async function saveDocument(document: any, create = true) {
|
||||
const method = create ? rpc.createDocument : rpc.updateDocument
|
||||
const method = create ? rpc.value?.createDocument : rpc.value?.updateDocument
|
||||
if (!method)
|
||||
return
|
||||
const newDocument = await method(props.collection, document)
|
||||
// TODO: show toast
|
||||
if (newDocument?.error)
|
||||
return alert(newDocument.error.message)
|
||||
return
|
||||
|
||||
if (create) {
|
||||
if (!documents.value.length) {
|
||||
documents.value = await rpc.listDocuments(props.collection, pagination)
|
||||
documents.value = await rpc.value?.listDocuments(props.collection, pagination)
|
||||
return discardEditing()
|
||||
}
|
||||
documents.value.push({ _id: newDocument.insertedId, ...document })
|
||||
@ -104,9 +112,10 @@ function discardEditing() {
|
||||
}
|
||||
|
||||
async function deleteDocument(document: any) {
|
||||
const newDocument = await rpc.deleteDocument(props.collection, document._id)
|
||||
const newDocument = await rpc.value?.deleteDocument(props.collection, document._id)
|
||||
// TODO: show toast
|
||||
if (newDocument.deletedCount === 0)
|
||||
return alert('Failed to delete document')
|
||||
return
|
||||
|
||||
documents.value = documents.value.filter((doc: any) => doc._id !== document._id)
|
||||
}
|
||||
@ -116,7 +125,7 @@ const copy = useCopy()
|
||||
|
||||
<template>
|
||||
<div ref="dbContainer" :class="{ 'h-full': !documents?.length }">
|
||||
<Navbar v-model:search="search" sticky top-0 px4 py2 backdrop-blur z-10>
|
||||
<NNavbar v-model:search="search" sticky top-0 px4 py2 backdrop-blur z-10>
|
||||
<template #actions>
|
||||
<NButton icon="carbon:add" n="green" @click="addDocument">
|
||||
Add Document
|
||||
@ -146,7 +155,7 @@ const copy = useCopy()
|
||||
</NSelect>
|
||||
</div>
|
||||
</div>
|
||||
</Navbar>
|
||||
</NNavbar>
|
||||
<table v-if="documents?.length || selectedDocument" w-full mb10 :class="{ 'editing-mode': editing }">
|
||||
<thead>
|
||||
<tr>
|
||||
@ -168,17 +177,17 @@ const copy = useCopy()
|
||||
{{ document[field] }}
|
||||
</span>
|
||||
</td>
|
||||
<td class="actions">
|
||||
<td>
|
||||
<div flex justify-center gap2 class="group">
|
||||
<template v-if="editing && selectedDocument._id === document._id">
|
||||
<NIconButton icon="carbon-save" @click="saveDocument(selectedDocument, false)" />
|
||||
<NIconButton icon="carbon-close" @click="discardEditing" />
|
||||
<NButton title="Save" icon="carbon-save" n="blue" @click="saveDocument(selectedDocument, false)" />
|
||||
<NButton title="Cancel" icon="carbon-close" n="red" @click="discardEditing" />
|
||||
</template>
|
||||
<template v-else>
|
||||
<NIconButton icon="carbon-edit" @click="editDocument(document)" />
|
||||
<NIconButton icon="carbon-delete" @click="deleteDocument(document)" />
|
||||
<NIconButton icon="carbon-document-multiple-02" @click="saveDocument(document)" />
|
||||
<NIconButton absolute right-4 opacity-0 group-hover="opacity-100" transition-all icon="carbon-copy" @click="copy(JSON.stringify(document))" />
|
||||
<NButton title="Edit" icon="carbon-edit" n="blue" @click="editDocument(document)" />
|
||||
<NButton title="Delete" icon="carbon-trash-can" n="red" @click="deleteDocument(document)" />
|
||||
<NButton title="Duplicate" icon="carbon-document-multiple-02" n="cyan" @click="saveDocument(document)" />
|
||||
<NButton title="Copy" n="xs purple" absolute right-4 opacity-0 group-hover="opacity-100" transition-all icon="carbon-copy" @click="copy(JSON.stringify(document))" />
|
||||
</template>
|
||||
</div>
|
||||
</td>
|
||||
@ -188,14 +197,14 @@ const copy = useCopy()
|
||||
<input v-if="field !== '_id'" v-model="selectedDocument[field]" :placeholder="field">
|
||||
<input v-else placeholder="ObjectId(_id)" disabled>
|
||||
</td>
|
||||
<td flex justify-center gap2 class="actions">
|
||||
<NIconButton icon="carbon-save" @click="saveDocument(selectedDocument)" />
|
||||
<NIconButton icon="carbon-close" @click="discardEditing" />
|
||||
<td flex="~ justify-center gap2">
|
||||
<NButton title="Save" icon="carbon-save" n="green" @click="saveDocument(selectedDocument)" />
|
||||
<NButton title="Cancel" icon="carbon-close" n="red" @click="discardEditing" />
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<div v-else flex justify-center items-center h-full text-2xl>
|
||||
<div v-else flex="~ justify-center items-center" h-full text-2xl>
|
||||
<NIcon icon="carbon-document" mr1 />
|
||||
No documents found
|
||||
</div>
|
||||
@ -203,11 +212,6 @@ const copy = useCopy()
|
||||
</template>
|
||||
|
||||
<style lang="scss">
|
||||
// TODO:
|
||||
.actions .n-icon {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
table {
|
||||
table-layout: fixed;
|
||||
tr {
|
||||
|
||||
@ -1,54 +0,0 @@
|
||||
<script setup lang="ts">
|
||||
const props = defineProps<{
|
||||
modelValue?: boolean
|
||||
navbar?: HTMLElement
|
||||
autoClose?: boolean
|
||||
}>()
|
||||
|
||||
const emit = defineEmits<{
|
||||
(e: 'close'): void
|
||||
}>()
|
||||
|
||||
const el = ref<HTMLElement>()
|
||||
|
||||
const { height: top } = useElementSize(() => props.navbar, undefined, { box: 'border-box' })
|
||||
|
||||
onClickOutside(el, () => {
|
||||
if (props.modelValue && props.autoClose)
|
||||
emit('close')
|
||||
}, {
|
||||
ignore: ['#open-drawer-right'],
|
||||
})
|
||||
</script>
|
||||
|
||||
<script lang="ts">
|
||||
export default {
|
||||
inheritAttrs: false,
|
||||
}
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<Transition
|
||||
enter-active-class="duration-200 ease-in"
|
||||
enter-from-class="transform translate-x-1/1"
|
||||
enter-to-class="opacity-100"
|
||||
leave-active-class="duration-200 ease-out"
|
||||
leave-from-class="opacity-100"
|
||||
leave-to-class="transform translate-x-1/1"
|
||||
>
|
||||
<div
|
||||
v-if="modelValue"
|
||||
ref="el"
|
||||
border="l base"
|
||||
flex="~ col gap-1"
|
||||
fixed bottom-0 right-0 z-10 z-20 of-auto text-sm backdrop-blur-lg
|
||||
:style="{ top: `${top}px` }"
|
||||
v-bind="$attrs"
|
||||
>
|
||||
<NIconButton absolute right-2 top-2 z-20 text-xl icon="carbon-close" @click="$emit('close')" />
|
||||
<div relative h-full w-full of-auto>
|
||||
<slot />
|
||||
</div>
|
||||
</div>
|
||||
</Transition>
|
||||
</template>
|
||||
@ -1,43 +0,0 @@
|
||||
<script setup lang="ts">
|
||||
defineProps({
|
||||
search: {
|
||||
type: String,
|
||||
default: undefined,
|
||||
},
|
||||
noPadding: {
|
||||
type: Boolean,
|
||||
default: true,
|
||||
},
|
||||
placeholder: {
|
||||
type: String,
|
||||
default: 'Search...',
|
||||
},
|
||||
})
|
||||
|
||||
const emit = defineEmits<{
|
||||
(event: 'update:search', value: string): void
|
||||
}>()
|
||||
|
||||
function update(event: any) {
|
||||
emit('update:search', event.target.value)
|
||||
}
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div flex="~ col gap2" border="b base" flex-1 navbar-glass :class="[{ p4: !noPadding }]">
|
||||
<div flex="~ gap4">
|
||||
<slot name="search">
|
||||
<NTextInput
|
||||
:placeholder="placeholder"
|
||||
icon="carbon-search"
|
||||
n="primary" flex-auto
|
||||
:class="{ 'px-5 py-2': !noPadding }"
|
||||
:value="search"
|
||||
@input="update"
|
||||
/>
|
||||
</slot>
|
||||
<slot name="actions" />
|
||||
</div>
|
||||
<slot />
|
||||
</div>
|
||||
</template>
|
||||
@ -1,36 +0,0 @@
|
||||
<script lang="ts" setup>
|
||||
import { Pane, Splitpanes } from 'splitpanes'
|
||||
import 'splitpanes/dist/splitpanes.css'
|
||||
|
||||
const props = defineProps({
|
||||
minLeft: {
|
||||
type: Number,
|
||||
default: 10,
|
||||
},
|
||||
minRight: {
|
||||
type: Number,
|
||||
default: 10,
|
||||
},
|
||||
maxLeft: {
|
||||
type: Number,
|
||||
default: 90,
|
||||
},
|
||||
maxRight: {
|
||||
type: Number,
|
||||
default: 90,
|
||||
},
|
||||
})
|
||||
|
||||
const size = ref(props.maxLeft)
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<Splitpanes h-full of-hidden @resize="size = $event[0].size">
|
||||
<Pane border="r base" h-full class="of-auto!" :size="size" :min-size="minLeft" :max-size="maxLeft">
|
||||
<slot name="left" />
|
||||
</Pane>
|
||||
<Pane relative h-full class="of-auto!" :min-size="minRight">
|
||||
<slot name="right" />
|
||||
</Pane>
|
||||
</Splitpanes>
|
||||
</template>
|
||||
@ -1,10 +1,14 @@
|
||||
import { useClipboard } from '@vueuse/core'
|
||||
// import { } from '@nuxt/devtools-ui-kit'
|
||||
|
||||
export function useCopy() {
|
||||
const clipboard = useClipboard()
|
||||
|
||||
return (text: string) => {
|
||||
clipboard.copy(text)
|
||||
// TODO: show toast
|
||||
// devtoolsUiShowNotification({
|
||||
// message: 'Copied to clipboard',
|
||||
// icon: 'carbon-copy',
|
||||
// })
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,69 +1,18 @@
|
||||
import { createBirpc } from 'birpc'
|
||||
import { parse, stringify } from 'flatted'
|
||||
import { onDevtoolsClientConnected } from '@nuxt/devtools-kit/iframe-client'
|
||||
import type { BirpcReturn } from 'birpc'
|
||||
import { ref } from 'vue'
|
||||
import type { NuxtDevtoolsClient } from '@nuxt/devtools-kit/dist/types'
|
||||
import type { ClientFunctions, ServerFunctions } from '../../src/types'
|
||||
import { PATH_ENTRY } from '../../src/constants'
|
||||
import { RPC_NAMESPACE } from '../../src/constants'
|
||||
|
||||
const RECONNECT_INTERVAL = 2000
|
||||
export const devtools = ref<NuxtDevtoolsClient>()
|
||||
export const devtoolsRpc = ref<NuxtDevtoolsClient['rpc']>()
|
||||
export const rpc = ref<BirpcReturn<ServerFunctions, ClientFunctions>>()
|
||||
|
||||
export const wsConnecting = ref(true)
|
||||
export const wsError = ref<any>()
|
||||
onDevtoolsClientConnected(async (client) => {
|
||||
devtoolsRpc.value = client.devtools.rpc
|
||||
devtools.value = client.devtools
|
||||
|
||||
let connectPromise = connectWS()
|
||||
let onMessage: Function = () => {}
|
||||
|
||||
export const clientFunctions = {
|
||||
// will be added in app.vue
|
||||
} as ClientFunctions
|
||||
|
||||
export const extendedRpcMap = new Map<string, any>()
|
||||
|
||||
export const rpc = createBirpc<ServerFunctions>(clientFunctions, {
|
||||
post: async (d) => {
|
||||
(await connectPromise).send(d)
|
||||
},
|
||||
on: (fn) => { onMessage = fn },
|
||||
serialize: stringify,
|
||||
deserialize: parse,
|
||||
resolver(name, fn) {
|
||||
if (fn)
|
||||
return fn
|
||||
if (!name.includes(':'))
|
||||
return
|
||||
const [namespace, fnName] = name.split(':')
|
||||
return extendedRpcMap.get(namespace)?.[fnName]
|
||||
},
|
||||
onError(error, name) {
|
||||
console.error(`[nuxt-devtools] RPC error on executing "${name}":`, error)
|
||||
},
|
||||
rpc.value = client.devtools.extendClientRpc<ServerFunctions, ClientFunctions>(RPC_NAMESPACE, {
|
||||
})
|
||||
})
|
||||
|
||||
async function connectWS() {
|
||||
const wsUrl = new URL(`ws://host${PATH_ENTRY}`)
|
||||
wsUrl.protocol = location.protocol === 'https:' ? 'wss:' : 'ws:'
|
||||
wsUrl.host = 'localhost:3000'
|
||||
|
||||
const ws = new WebSocket(wsUrl.toString())
|
||||
ws.addEventListener('message', e => onMessage(String(e.data)))
|
||||
ws.addEventListener('error', (e) => {
|
||||
console.error(e)
|
||||
wsError.value = e
|
||||
})
|
||||
ws.addEventListener('close', () => {
|
||||
// eslint-disable-next-line no-console
|
||||
console.log('[nuxt-devtools] WebSocket closed, reconnecting...')
|
||||
wsConnecting.value = true
|
||||
setTimeout(async () => {
|
||||
connectPromise = connectWS()
|
||||
}, RECONNECT_INTERVAL)
|
||||
})
|
||||
wsConnecting.value = true
|
||||
if (ws.readyState !== WebSocket.OPEN)
|
||||
await new Promise(resolve => ws.addEventListener('open', resolve))
|
||||
|
||||
// eslint-disable-next-line no-console
|
||||
console.log('[nuxt-devtools] WebSocket connected.')
|
||||
wsConnecting.value = false
|
||||
wsError.value = null
|
||||
|
||||
return ws
|
||||
}
|
||||
|
||||
1
client/composables/state.ts
Normal file
1
client/composables/state.ts
Normal file
@ -0,0 +1 @@
|
||||
export const selectedCollection = useState('mongo:collection', () => '')
|
||||
@ -1,10 +1,13 @@
|
||||
<script lang="ts" setup>
|
||||
const readyState = computedAsync(async () => await rpc.readyState())
|
||||
import { computedAsync } from '@vueuse/core'
|
||||
import { rpc } from '../composables/rpc'
|
||||
|
||||
const readyState = computedAsync(async () => await rpc.value?.readyState())
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div h-full of-auto>
|
||||
<slot v-if="readyState === 1" />
|
||||
<Connection v-else :connection="readyState" />
|
||||
<Connection v-else :code="readyState" />
|
||||
</div>
|
||||
</template>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
import { resolve } from 'pathe'
|
||||
import { PATH_CLIENT } from '../src/constants'
|
||||
import { CLIENT_PATH } from '../src/constants'
|
||||
|
||||
export default defineNuxtConfig({
|
||||
ssr: false,
|
||||
@ -22,6 +22,6 @@ export default defineNuxtConfig({
|
||||
},
|
||||
},
|
||||
app: {
|
||||
baseURL: PATH_CLIENT,
|
||||
baseURL: CLIENT_PATH,
|
||||
},
|
||||
})
|
||||
|
||||
@ -1,13 +1,17 @@
|
||||
<script lang="ts" setup>
|
||||
const route = useRoute()
|
||||
import { computed, ref } from 'vue'
|
||||
import { computedAsync } from '@vueuse/core'
|
||||
import { useRouter } from 'nuxt/app'
|
||||
import { rpc } from '../composables/rpc'
|
||||
import { selectedCollection } from '../composables/state'
|
||||
|
||||
const router = useRouter()
|
||||
|
||||
const selectedCollection = ref()
|
||||
const drawer = ref(false)
|
||||
const search = ref('')
|
||||
|
||||
const collections = computedAsync(async () => {
|
||||
return await rpc.listCollections()
|
||||
return await rpc.value?.listCollections()
|
||||
})
|
||||
|
||||
const filtered = computed(() => {
|
||||
@ -16,46 +20,48 @@ const filtered = computed(() => {
|
||||
return collections.value.filter((c: any) => c.name.toLowerCase().includes(search.value.toLowerCase()))
|
||||
})
|
||||
|
||||
onMounted(() => {
|
||||
if (route.query.table)
|
||||
selectedCollection.value = route.query.table
|
||||
})
|
||||
|
||||
async function dropCollection(table: any) {
|
||||
await rpc.dropCollection(table.name)
|
||||
collections.value = await rpc.listCollections()
|
||||
await rpc.value?.dropCollection(table.name)
|
||||
collections.value = await rpc.value?.listCollections()
|
||||
if (selectedCollection.value === table.name) {
|
||||
selectedCollection.value = undefined
|
||||
selectedCollection.value = ''
|
||||
router.push({ name: 'index' })
|
||||
}
|
||||
}
|
||||
|
||||
async function refresh() {
|
||||
collections.value = await rpc.listCollections()
|
||||
collections.value = await rpc.value?.listCollections()
|
||||
drawer.value = false
|
||||
}
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<PanelLeftRight :min-left="13" :max-left="20">
|
||||
<NSplitPane :min-left="13" :max-left="20">
|
||||
<template #left>
|
||||
<div px4>
|
||||
<Navbar v-model:search="search" :placeholder="`${collections?.length ?? '-'} collection in total`" mt2>
|
||||
<NNavbar v-model:search="search" :placeholder="`${collections?.length ?? '-'} collection in total`" mt2 no-padding>
|
||||
<div flex items-center gap2>
|
||||
<NIconButton w-full mb1.5 icon="carbon-reset" title="Refresh" @click="refresh" />
|
||||
<NIconButton w-full mb1.5 icon="carbon-data-base" title="Default" text-green-5 />
|
||||
<NIconButton id="open-drawer-right" w-full mb1.5 icon="carbon-add" title="Create Collection" @click="drawer = true" />
|
||||
<NButton n="blue" w-full mb1.5 icon="carbon-reset" title="Refresh" @click="refresh" />
|
||||
<!-- <NButton w-full mb1.5 icon="carbon-data-base" title="Default" n="green" /> -->
|
||||
<NButton n="green" w-full mb1.5 icon="carbon-add" title="Create Collection" @click="drawer = true" />
|
||||
</div>
|
||||
</Navbar>
|
||||
</NNavbar>
|
||||
<div grid gird-cols-1 my2 mx1>
|
||||
<NuxtLink v-for="table in filtered" :key="table.name" :to="{ name: 'index', query: { table: table.name } }" flex justify-between p2 my1 hover-bg-green hover-bg-opacity-5 hover-text-green rounded-lg :class="{ 'bg-green bg-opacity-5 text-green': selectedCollection === table.name }" @click="selectedCollection = table.name">
|
||||
<NuxtLink
|
||||
v-for="table in filtered"
|
||||
:key="table.name"
|
||||
:to="{ name: 'index', query: { table: table.name } }"
|
||||
flex items-center justify-between p2 my1 hover-bg-green hover-bg-opacity-5 hover-text-green rounded-lg
|
||||
:class="{ 'bg-green bg-opacity-5 text-green': selectedCollection === table.name }"
|
||||
@click="selectedCollection = table.name"
|
||||
>
|
||||
<span>
|
||||
<NIcon icon="carbon-db2-database" />
|
||||
{{ table.name }}
|
||||
</span>
|
||||
<div flex gap2>
|
||||
<NIconButton block n="red" icon="carbon-delete" @click="dropCollection(table)" />
|
||||
<!-- <NIconButton icon="carbon-overflow-menu-horizontal" /> -->
|
||||
<div flex="~ items-center gap-2">
|
||||
<NButton :border="false" n="red" icon="carbon-trash-can" @click="dropCollection(table)" />
|
||||
<!-- <NButton :border="false" icon="carbon-overflow-menu-horizontal" /> -->
|
||||
</div>
|
||||
</NuxtLink>
|
||||
</div>
|
||||
@ -72,8 +78,8 @@ async function refresh() {
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
</PanelLeftRight>
|
||||
<DrawerRight v-model="drawer" style="width: calc(80.5%);" auto-close @close="drawer = false">
|
||||
</NSplitPane>
|
||||
<NDrawer v-model="drawer" style="width: calc(80.5%);" auto-close @close="drawer = false" z-20>
|
||||
<CreateResource @refresh="refresh" />
|
||||
</DrawerRight>
|
||||
</NDrawer>
|
||||
</template>
|
||||
|
||||
21
client/splitpanes.d.ts
vendored
21
client/splitpanes.d.ts
vendored
@ -1,21 +0,0 @@
|
||||
// TODO install @types/splitpanes once updated
|
||||
declare module 'splitpanes' {
|
||||
import { Component } from 'vue'
|
||||
|
||||
export interface SplitpaneProps {
|
||||
horizontal: boolean
|
||||
pushOtherPanes: boolean
|
||||
dblClickSplitter: boolean
|
||||
firstSplitter: boolean
|
||||
}
|
||||
|
||||
export interface PaneProps {
|
||||
size: number | string
|
||||
minSize: number | string
|
||||
maxSize: number | string
|
||||
}
|
||||
|
||||
export type Pane = Component<PaneProps>
|
||||
export const Pane: Pane
|
||||
export const Splitpanes: Component<SplitpaneProps>
|
||||
}
|
||||
@ -1,35 +0,0 @@
|
||||
/* Splitpanes */
|
||||
.splitpanes__splitter {
|
||||
position: relative;
|
||||
}
|
||||
.splitpanes__splitter:before {
|
||||
position: absolute;
|
||||
left: 0;
|
||||
top: 0;
|
||||
transition: .2s ease;
|
||||
content: '';
|
||||
transition: opacity 0.4s;
|
||||
z-index: 1;
|
||||
}
|
||||
.splitpanes__splitter:hover:before {
|
||||
background: #8881;
|
||||
opacity: 1;
|
||||
}
|
||||
.splitpanes--vertical>.splitpanes__splitter {
|
||||
min-width: 0 !important;
|
||||
width: 0 !important;
|
||||
}
|
||||
.splitpanes--horizontal>.splitpanes__splitter {
|
||||
min-height: 0 !important;
|
||||
height: 0 !important;
|
||||
}
|
||||
.splitpanes--vertical>.splitpanes__splitter:before {
|
||||
left: -5px;
|
||||
right: -4px;
|
||||
height: 100%;
|
||||
}
|
||||
.splitpanes--horizontal>.splitpanes__splitter:before {
|
||||
top: -5px;
|
||||
bottom: -4px;
|
||||
width: 100%;
|
||||
}
|
||||
12
docs/.gitignore
vendored
12
docs/.gitignore
vendored
@ -1,12 +0,0 @@
|
||||
node_modules
|
||||
*.iml
|
||||
.idea
|
||||
*.log*
|
||||
.nuxt
|
||||
.vscode
|
||||
.DS_Store
|
||||
coverage
|
||||
dist
|
||||
sw.*
|
||||
.env
|
||||
.output
|
||||
@ -1,2 +0,0 @@
|
||||
shamefully-hoist=true
|
||||
strict-peer-dependencies=false
|
||||
1
docs/README.md
Normal file
1
docs/README.md
Normal file
@ -0,0 +1 @@
|
||||
# the docs has been moved to [arashsheyda/docs](https://github.com/arashsheyda/docs/tree/main/content/1.nuxt-mongoose)
|
||||
@ -1,41 +0,0 @@
|
||||
export default defineAppConfig({
|
||||
docus: {
|
||||
title: 'Nuxt Mongoose',
|
||||
description: 'A Nuxt module for simplifying the use of Mongoose in your project.',
|
||||
image: 'https://user-images.githubusercontent.com/904724/185365452-87b7ca7b-6030-4813-a2db-5e65c785bf88.png',
|
||||
socials: {
|
||||
github: 'arashsheyda/nuxt-mongoose',
|
||||
},
|
||||
github: {
|
||||
dir: 'docs/content',
|
||||
branch: 'main',
|
||||
repo: 'nuxt-mongoose',
|
||||
owner: 'arashsheyda',
|
||||
edit: true,
|
||||
},
|
||||
aside: {
|
||||
level: 0,
|
||||
collapsed: false,
|
||||
exclude: [],
|
||||
},
|
||||
main: {
|
||||
padded: true,
|
||||
fluid: true,
|
||||
},
|
||||
header: {
|
||||
logo: true,
|
||||
showLinkIcon: true,
|
||||
exclude: [],
|
||||
fluid: true,
|
||||
},
|
||||
footer: {
|
||||
fluid: true,
|
||||
iconLinks: [
|
||||
{
|
||||
href: 'https://nuxt.com',
|
||||
icon: 'simple-icons:nuxtdotjs',
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
})
|
||||
@ -1,12 +0,0 @@
|
||||
<template>
|
||||
<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 235.5 33.2">
|
||||
<rect width="32" height="32" rx="7.5" style="fill:#023430" />
|
||||
<path d="M21.4,13.4C20.1,7.6,17.3,6.1,16.6,5a10.1,10.1,0,0,1-.7-1.5,1.6,1.6,0,0,1-.6,1.2,14.1,14.1,0,0,0-4.9,10.5c-.3,6.1,4.5,9.9,5.1,10.3a1.4,1.4,0,0,0,1.4-.2,12.1,12.1,0,0,0,4.5-11.9" style="fill:#10aa50" />
|
||||
<path d="M16.1,22.2a17.8,17.8,0,0,1-.5,3.3s.2,1.5.3,3h.5a30.6,30.6,0,0,1,.5-3.2C16.3,25,16.1,23.6,16.1,22.2Z" style="fill:#b8c4c2" />
|
||||
<path d="M16.9,25.3c-.6-.3-.8-1.7-.8-3.1s.2-4.3.1-6.5,0-10.7-.3-12.1L16.6,5c.7,1.1,3.5,2.6,4.8,8.4A12,12,0,0,1,16.9,25.3Z" style="fill:#12924f" />
|
||||
<text transform="translate(32.8 25.6)" style="font-size:25.818214416503906px;font-family:OpenSans-Bold, Open Sans;font-weight:700">
|
||||
<tspan fill="currentColor" x="4" y="0">Nuxt</tspan>
|
||||
<tspan x="70.8" y="0" style="fill:#10aa50">Mongoose</tspan>
|
||||
</text>
|
||||
</svg>
|
||||
</template>
|
||||
@ -1,36 +0,0 @@
|
||||
---
|
||||
title: Home
|
||||
navigation: false
|
||||
layout: page
|
||||
main:
|
||||
fluid: false
|
||||
---
|
||||
|
||||
:ellipsis{right=0px width=75% blur=150px}
|
||||
|
||||
::block-hero
|
||||
---
|
||||
cta:
|
||||
- Get started
|
||||
- /getting-started/setup
|
||||
secondary:
|
||||
- Open on GitHub →
|
||||
- https://github.com/arashsheyda/nuxt-mongoose
|
||||
---
|
||||
|
||||
#title
|
||||
Nuxt Mongoose
|
||||
|
||||
#description
|
||||
A Nuxt module for simplifying the use of [Mongoose](https://mongoosejs.com/) in your project.
|
||||
|
||||
#support
|
||||
::terminal
|
||||
---
|
||||
content:
|
||||
- npm i nuxt-mongoose -D
|
||||
---
|
||||
::
|
||||
::
|
||||
|
||||
<!-- TODO: features -->
|
||||
@ -1,51 +0,0 @@
|
||||
# Setup
|
||||
|
||||
A Nuxt module for simplifying the use of Mongoose in your project.
|
||||
|
||||
## Installation
|
||||
|
||||
1. Install `nuxt-mongoose` to your dependencies.
|
||||
|
||||
::code-group
|
||||
|
||||
```bash [pnpm]
|
||||
pnpm add nuxt-mongoose -D
|
||||
```
|
||||
|
||||
```bash [npm]
|
||||
npm install nuxt-mongoose -D
|
||||
```
|
||||
|
||||
```bash [yarn]
|
||||
yarn add nuxt-mongoose -D
|
||||
```
|
||||
|
||||
::
|
||||
|
||||
2. Add `nuxt-mongoose` to the `modules` section of your `nuxt.config` file.
|
||||
|
||||
```ts [nuxt.config]
|
||||
export default defineNuxtConfig({
|
||||
modules: [
|
||||
'nuxt-mongoose',
|
||||
],
|
||||
})
|
||||
```
|
||||
|
||||
::alert{ type=success }
|
||||
That's it! You can now use Mongoose in your Nuxt app ✨
|
||||
::
|
||||
|
||||
|
||||
## Options
|
||||
|
||||
You can configure the module by adding a `mongoose` section to your `nuxt.config` file.
|
||||
read more about [Mongoose options](/getting-started/configuration).
|
||||
|
||||
```ts [nuxt.config]
|
||||
export default defineNuxtConfig({
|
||||
mongoose: {
|
||||
// Options
|
||||
},
|
||||
})
|
||||
```
|
||||
@ -1,21 +0,0 @@
|
||||
# Configuration
|
||||
|
||||
Configure Nuxt Mongoose with the `mongoose` property.
|
||||
|
||||
```ts [nuxt.config]
|
||||
export default defineNuxtConfig({
|
||||
mongoose: {
|
||||
uri: 'process.env.MONGODB_URI',
|
||||
options: {},
|
||||
modelsDir: 'models',
|
||||
devtools: true,
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
| **Key** | **Type** | **Default** | **Description** |
|
||||
| ---------------------------- | ---------- | ----------------------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `uri` | `string` | process.env.MONGODB_URI | Connection Uri String |
|
||||
| `options` | `ConnectOptions` | { } | Connection Options |
|
||||
| `modelsDir` | `string` | models | The models(schema) directory located in `server` for auto-import |
|
||||
| `devtools` | `boolean` | true | Enable Mongoose module in [`Nuxt Devtools`](https://github.com/nuxt/devtools) |
|
||||
@ -1,2 +0,0 @@
|
||||
icon: tabler:brand-mongodb
|
||||
navigation.redirect: /getting-started/setup
|
||||
@ -1,52 +0,0 @@
|
||||
# Utils
|
||||
|
||||
Discover all available utils.
|
||||
|
||||
## `defineMongooseModel`
|
||||
|
||||
This function creates a new Mongoose model with schema. Example usage:
|
||||
|
||||
::code-group
|
||||
|
||||
```ts [named parameters]
|
||||
export const User = defineMongooseModel({
|
||||
name: 'User',
|
||||
schema: {
|
||||
name: {
|
||||
type: String,
|
||||
required: true,
|
||||
},
|
||||
},
|
||||
options: {
|
||||
|
||||
},
|
||||
})
|
||||
```
|
||||
|
||||
```ts [positional parameters]
|
||||
import { defineMongooseModel } from '#nuxt/mongoose'
|
||||
|
||||
export const User = defineMongooseModel('User', {
|
||||
name: {
|
||||
type: String,
|
||||
required: true,
|
||||
},
|
||||
}, {
|
||||
|
||||
})
|
||||
```
|
||||
|
||||
::
|
||||
|
||||
|
||||
## `defineMongooseConnection`
|
||||
This function creates a new Mongoose connection.
|
||||
- `nuxt-mongoose` provides a default connection for you, it auto-register a plugin in nitro, so you don't need to use this function unless you want to create a new connection. more info [here](https://github.com/arashsheyda/nuxt-mongoose/blob/main/src/runtime/server/plugins/mongoose.db.ts).
|
||||
|
||||
Example usage:
|
||||
|
||||
```ts
|
||||
import { defineMongooseConnection } from '#nuxt/mongoose'
|
||||
|
||||
export const connection = defineMongooseConnection('mongodb://127.0.0.1/nuxt-mongoose')
|
||||
```
|
||||
@ -1,3 +0,0 @@
|
||||
# Devtools (beta)
|
||||
|
||||
`nuxt-mongoose` comes with a [Nuxt Devtools](https://github.com/nuxt/devtools) module that allows you to manage your collections and generate api-endpoints & schemas...
|
||||
@ -1,2 +0,0 @@
|
||||
title: API
|
||||
icon: tabler:book
|
||||
@ -1,8 +0,0 @@
|
||||
export default defineNuxtConfig({
|
||||
extends: '@nuxt-themes/docus',
|
||||
|
||||
modules: [
|
||||
'@nuxthq/studio',
|
||||
'@nuxt/devtools',
|
||||
],
|
||||
})
|
||||
@ -1,17 +0,0 @@
|
||||
{
|
||||
"name": "docus-starter",
|
||||
"version": "0.1.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"dev": "nuxi dev",
|
||||
"build": "nuxi build",
|
||||
"generate": "nuxi generate",
|
||||
"preview": "nuxi preview",
|
||||
"lint": "eslint ."
|
||||
},
|
||||
"devDependencies": {
|
||||
"@nuxt-themes/docus": "^1.12.0",
|
||||
"@nuxthq/studio": "^0.13.2",
|
||||
"nuxt": "^3.5.0"
|
||||
}
|
||||
}
|
||||
6655
docs/pnpm-lock.yaml
generated
6655
docs/pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 214 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 15 KiB |
@ -1 +0,0 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" viewBox="0 0 256 256"><g fill="none"><rect width="256" height="256" fill="#023430" rx="60"/><path fill="#10AA50" d="M171.173 107.591c-10.537-46.481-32.497-58.855-38.099-67.602A99.398 99.398 0 0 1 126.949 28c-.296 4.13-.84 6.73-4.35 9.862c-7.047 6.283-36.977 30.673-39.496 83.486c-2.347 49.242 36.2 79.605 41.292 82.744c3.916 1.927 8.685.041 11.012-1.728c18.581-12.752 43.969-46.75 35.786-94.773"/><path fill="#B8C4C2" d="M128.545 177.871c-.97 12.188-1.665 19.27-4.129 26.235c0 0 1.617 11.603 2.753 23.894h4.019a223.446 223.446 0 0 1 4.384-25.732c-5.203-2.56-6.827-13.702-7.027-24.397Z"/><path fill="#12924F" d="M135.565 202.275c-5.258-2.429-6.779-13.806-7.013-24.404a499.824 499.824 0 0 0 1.136-52.545c-.276-9.194.13-85.158-2.265-96.28a92.425 92.425 0 0 0 5.651 10.936c5.602 8.754 27.569 21.128 38.099 67.609c8.203 47.941-17.047 81.849-35.608 94.684Z"/></g></svg>
|
||||
|
Before Width: | Height: | Size: 926 B |
@ -1 +0,0 @@
|
||||
<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 235.5 33.2"><rect width="32" height="32" rx="7.5" style="fill:#023430"/><path d="M21.4,13.4C20.1,7.6,17.3,6.1,16.6,5a10.1,10.1,0,0,1-.7-1.5,1.6,1.6,0,0,1-.6,1.2,14.1,14.1,0,0,0-4.9,10.5c-.3,6.1,4.5,9.9,5.1,10.3a1.4,1.4,0,0,0,1.4-.2,12.1,12.1,0,0,0,4.5-11.9" style="fill:#10aa50"/><path d="M16.1,22.2a17.8,17.8,0,0,1-.5,3.3s.2,1.5.3,3h.5a30.6,30.6,0,0,1,.5-3.2C16.3,25,16.1,23.6,16.1,22.2Z" style="fill:#b8c4c2"/><path d="M16.9,25.3c-.6-.3-.8-1.7-.8-3.1s.2-4.3.1-6.5,0-10.7-.3-12.1L16.6,5c.7,1.1,3.5,2.6,4.8,8.4A12,12,0,0,1,16.9,25.3Z" style="fill:#12924f"/><text transform="translate(32.8 25.6)" style="font-size:25.818214416503906px;font-family:OpenSans-Bold, Open Sans;font-weight:700">Nuxt <tspan x="70.8" y="0" style="fill:#10aa50">Mongoose</tspan></text></svg>
|
||||
|
Before Width: | Height: | Size: 851 B |
@ -1,8 +0,0 @@
|
||||
{
|
||||
"extends": [
|
||||
"@nuxtjs"
|
||||
],
|
||||
"lockFileMaintenance": {
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
@ -1,18 +0,0 @@
|
||||
import { defineTheme } from 'pinceau'
|
||||
|
||||
export default defineTheme({
|
||||
color: {
|
||||
primary: {
|
||||
50: '#e8f5e9',
|
||||
100: '#c8e6c9',
|
||||
200: '#a5d6a7',
|
||||
300: '#81c784',
|
||||
400: '#66bb6a',
|
||||
500: '#10a74f',
|
||||
600: '#10a74f',
|
||||
700: '#388e3c',
|
||||
800: '#2e7d32',
|
||||
900: '#1b5e20',
|
||||
},
|
||||
},
|
||||
})
|
||||
@ -1,3 +0,0 @@
|
||||
{
|
||||
"extends": "./.nuxt/tsconfig.json"
|
||||
}
|
||||
15
module.cjs
15
module.cjs
@ -1,15 +0,0 @@
|
||||
/* eslint-disable eslint-comments/no-unlimited-disable */
|
||||
/* eslint-disable */
|
||||
module.exports = function (...args) {
|
||||
const nuxt = this.nuxt || args[1]
|
||||
let _a
|
||||
let version = (nuxt == null ? void 0 : nuxt._version) || (nuxt == null ? void 0 : nuxt.version) || ((_a = nuxt == null ? void 0 : nuxt.constructor) == null ? void 0 : _a.version) || ''
|
||||
version = version.replace(/^v/g, '')
|
||||
// Nuxt DevTools is not compatible with Nuxt 2, disabled
|
||||
if (version.startsWith('2.')) {
|
||||
return
|
||||
}
|
||||
return import('./dist/module.mjs').then(m => m.default.call(this, ...args))
|
||||
}
|
||||
const _meta = module.exports.meta = require('./dist/module.json')
|
||||
module.exports.getMeta = () => Promise.resolve(_meta)
|
||||
92
package.json
92
package.json
@ -1,72 +1,74 @@
|
||||
{
|
||||
"name": "nuxt-mongoose",
|
||||
"type": "module",
|
||||
"version": "0.0.7",
|
||||
"version": "1.0.6",
|
||||
"private": false,
|
||||
"packageManager": "pnpm@8.7.4",
|
||||
"description": "Nuxt 3 module for MongoDB with Mongoose",
|
||||
"license": "MIT",
|
||||
"funding": "https://github.com/sponsors/arashsheyda",
|
||||
"homepage": "https://docs.arashsheyda.me/nuxt-mongoose",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/arashsheyda/nuxt-mongoose"
|
||||
"url": "git+https://github.com/arashsheyda/nuxt-mongoose"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/arashsheyda/nuxt-mongoose/issues"
|
||||
},
|
||||
"keywords": [
|
||||
"nuxt",
|
||||
"mongoose",
|
||||
"mongodb",
|
||||
"devtools"
|
||||
],
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist/types.d.ts",
|
||||
"require": "./module.cjs",
|
||||
"import": "./dist/module.mjs"
|
||||
"import": "./dist/module.mjs",
|
||||
"require": "./dist/module.cjs"
|
||||
}
|
||||
},
|
||||
"./types": {
|
||||
"types": "./dist/types.d.ts",
|
||||
"import": "./dist/types.mjs"
|
||||
"build": {
|
||||
"externals": [
|
||||
"ofetch"
|
||||
]
|
||||
},
|
||||
"./*": "./*"
|
||||
},
|
||||
"main": "./module.cjs",
|
||||
"main": "./dist/module.cjs",
|
||||
"types": "./dist/types.d.ts",
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "pnpm dev:prepare && pnpm build:module && pnpm build:client",
|
||||
"build": "nuxt-module-build && npm run build:client",
|
||||
"build:client": "nuxi generate client",
|
||||
"build:module": "nuxt-build-module",
|
||||
"dev": "nuxi dev playground",
|
||||
"dev:prepare": "nuxi prepare client",
|
||||
"dev:prod": "npm run build && pnpm dev",
|
||||
"release": "npm run lint && npm run build && changelogen --release && npm publish && git push --follow-tags",
|
||||
"lint": "eslint .",
|
||||
"test": "vitest run",
|
||||
"test:watch": "vitest watch"
|
||||
"dev:prepare": "nuxt-module-build && nuxi prepare client",
|
||||
"dev:client": "nuxi dev client --port 3300",
|
||||
"dev:prod": "npm run build && npm run dev",
|
||||
"release": "npm run lint && npm run build && changelogen --release && npm publish",
|
||||
"lint": "eslint . --fix"
|
||||
},
|
||||
"dependencies": {
|
||||
"@nuxt/devtools-kit": "^0.5.5",
|
||||
"@nuxt/kit": "^3.5.2",
|
||||
"@types/fs-extra": "^11.0.1",
|
||||
"birpc": "^0.2.11",
|
||||
"defu": "^6.1.2",
|
||||
"flatted": "^3.2.7",
|
||||
"fs-extra": "^11.1.1",
|
||||
"mongoose": "^7.2.2",
|
||||
"pathe": "^1.1.0",
|
||||
"@nuxt/devtools-kit": "1.0.8",
|
||||
"@nuxt/devtools-ui-kit": "1.0.8",
|
||||
"@nuxt/kit": "^3.9.3",
|
||||
"@vueuse/core": "^10.7.2",
|
||||
"defu": "^6.1.4",
|
||||
"fs-extra": "^11.2.0",
|
||||
"mongoose": "^8.1.0",
|
||||
"ofetch": "^1.3.3",
|
||||
"pathe": "^1.1.2",
|
||||
"pluralize": "^8.0.0",
|
||||
"sirv": "^2.0.3",
|
||||
"tinyws": "^0.1.0",
|
||||
"ws": "^8.13.0"
|
||||
"sirv": "^2.0.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@antfu/eslint-config": "^0.38.5",
|
||||
"@nuxt/devtools": "^0.5.5",
|
||||
"@nuxt/devtools-ui-kit": "^0.5.5",
|
||||
"@nuxt/module-builder": "^0.4.0",
|
||||
"@nuxt/schema": "^3.5.2",
|
||||
"@nuxt/test-utils": "^3.5.2",
|
||||
"@types/pluralize": "^0.0.29",
|
||||
"@types/ws": "^8.5.4",
|
||||
"changelogen": "^0.5.3",
|
||||
"eslint": "^8.39.0",
|
||||
"nuxt": "^3.5.2",
|
||||
"sass": "^1.62.1",
|
||||
"sass-loader": "^13.3.1",
|
||||
"splitpanes": "^3.1.5",
|
||||
"vitest": "^0.31.2"
|
||||
"@antfu/eslint-config": "2.6.3",
|
||||
"@nuxt/module-builder": "^0.5.5",
|
||||
"@types/fs-extra": "^11.0.4",
|
||||
"@types/pluralize": "^0.0.33",
|
||||
"changelogen": "^0.5.5",
|
||||
"eslint": "8.56.0",
|
||||
"nuxt": "^3.9.3",
|
||||
"sass": "^1.69.7"
|
||||
}
|
||||
}
|
||||
1
playground/.env.example
Normal file
1
playground/.env.example
Normal file
@ -0,0 +1 @@
|
||||
MONGODB_URI="mongodb://localhost:27017/nuxt-mongoose"
|
||||
@ -1,8 +1,14 @@
|
||||
<script setup>
|
||||
<script setup lang="ts">
|
||||
const { data } = await useFetch('/api/users')
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div>
|
||||
Nuxt module playground!
|
||||
<br>
|
||||
<pre
|
||||
v-html="JSON.stringify(data, null, 2)"
|
||||
style="background: #131313;color: #4EA65A;padding: 20px;border-radius: 7px;text-shadow: 0px 0px 10px #00ff22;"
|
||||
/>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
@ -1,6 +1,33 @@
|
||||
import { resolve } from 'node:path'
|
||||
import { defineNuxtConfig } from 'nuxt/config'
|
||||
import { defineNuxtModule } from '@nuxt/kit'
|
||||
import { startSubprocess } from '@nuxt/devtools-kit'
|
||||
import { CLIENT_PORT } from '../src/constants'
|
||||
|
||||
export default defineNuxtConfig({
|
||||
devtools: {
|
||||
enabled: true,
|
||||
},
|
||||
|
||||
modules: [
|
||||
'@nuxt/devtools',
|
||||
'../src/module',
|
||||
defineNuxtModule({
|
||||
setup(_, nuxt) {
|
||||
if (!nuxt.options.dev)
|
||||
return
|
||||
|
||||
startSubprocess(
|
||||
{
|
||||
command: 'npx',
|
||||
args: ['nuxi', 'dev', '--port', CLIENT_PORT.toString()],
|
||||
cwd: resolve(__dirname, '../client'),
|
||||
},
|
||||
{
|
||||
id: 'nuxt-mongoose:client',
|
||||
name: 'Nuxt Mongoose Client Dev',
|
||||
},
|
||||
)
|
||||
},
|
||||
}),
|
||||
],
|
||||
})
|
||||
|
||||
5
playground/server/api/hi.get.ts
Normal file
5
playground/server/api/hi.get.ts
Normal file
@ -0,0 +1,5 @@
|
||||
export default defineEventHandler(async () => {
|
||||
return {
|
||||
message: 'hi',
|
||||
}
|
||||
})
|
||||
@ -7,10 +7,20 @@ export const UserSchema = defineMongooseModel({
|
||||
type: 'string',
|
||||
required: true,
|
||||
},
|
||||
slug: {
|
||||
email: {
|
||||
type: 'string',
|
||||
required: true,
|
||||
unique: true,
|
||||
unique: false,
|
||||
},
|
||||
password: {
|
||||
type: 'string',
|
||||
required: true,
|
||||
},
|
||||
},
|
||||
hooks(schema) {
|
||||
schema.pre('save', function (this, next) {
|
||||
this.password = `hash.${this.password}.${Math.random()}`
|
||||
next()
|
||||
})
|
||||
},
|
||||
})
|
||||
|
||||
3
playground/server/tsconfig.json
Normal file
3
playground/server/tsconfig.json
Normal file
@ -0,0 +1,3 @@
|
||||
{
|
||||
"extends": "../.nuxt/tsconfig.server.json"
|
||||
}
|
||||
11335
pnpm-lock.yaml
generated
11335
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@ -1,3 +1,3 @@
|
||||
export const PATH = '/__nuxt_mongoose__'
|
||||
export const PATH_ENTRY = `${PATH}/entry`
|
||||
export const PATH_CLIENT = `${PATH}/client`
|
||||
export const CLIENT_PATH = '/__nuxt-mongoose'
|
||||
export const CLIENT_PORT = 3300
|
||||
export const RPC_NAMESPACE = 'nuxt-mongoose-rpc'
|
||||
|
||||
56
src/devtools.ts
Normal file
56
src/devtools.ts
Normal file
@ -0,0 +1,56 @@
|
||||
import { existsSync } from 'node:fs'
|
||||
import type { Nuxt } from 'nuxt/schema'
|
||||
import type { Resolver } from '@nuxt/kit'
|
||||
import { extendServerRpc, onDevToolsInitialized } from '@nuxt/devtools-kit'
|
||||
import type { ClientFunctions, ServerFunctions } from './types'
|
||||
import type { ModuleOptions } from './module'
|
||||
import { useViteWebSocket } from './utils'
|
||||
|
||||
import { setupRPC } from './rpc'
|
||||
import { CLIENT_PATH, CLIENT_PORT, RPC_NAMESPACE } from './constants'
|
||||
|
||||
export function setupDevToolsUI(options: ModuleOptions, resolve: Resolver['resolve'], nuxt: Nuxt) {
|
||||
const clientPath = resolve('./client')
|
||||
const isProductionBuild = existsSync(clientPath)
|
||||
|
||||
if (isProductionBuild) {
|
||||
nuxt.hook('vite:serverCreated', async (server) => {
|
||||
const sirv = await import('sirv').then(r => r.default || r)
|
||||
server.middlewares.use(
|
||||
CLIENT_PATH,
|
||||
sirv(clientPath, { dev: true, single: true }),
|
||||
)
|
||||
})
|
||||
}
|
||||
else {
|
||||
nuxt.hook('vite:extendConfig', (config) => {
|
||||
config.server = config.server || {}
|
||||
config.server.proxy = config.server.proxy || {}
|
||||
config.server.proxy[CLIENT_PATH] = {
|
||||
target: `http://localhost:${CLIENT_PORT}${CLIENT_PATH}`,
|
||||
changeOrigin: true,
|
||||
followRedirects: true,
|
||||
rewrite: path => path.replace(CLIENT_PATH, ''),
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
nuxt.hook('devtools:customTabs', (tabs) => {
|
||||
tabs.push({
|
||||
name: 'nuxt-mongoose',
|
||||
title: 'Mongoose',
|
||||
icon: 'skill-icons:mongodb',
|
||||
view: {
|
||||
type: 'iframe',
|
||||
src: CLIENT_PATH,
|
||||
},
|
||||
})
|
||||
})
|
||||
|
||||
const wsServer = useViteWebSocket(nuxt)
|
||||
onDevToolsInitialized(async () => {
|
||||
const rpcFunctions = setupRPC({ options, wsServer, nuxt })
|
||||
|
||||
extendServerRpc<ClientFunctions, ServerFunctions>(RPC_NAMESPACE, rpcFunctions)
|
||||
})
|
||||
}
|
||||
136
src/module.ts
136
src/module.ts
@ -1,23 +1,47 @@
|
||||
import {
|
||||
addImportsDir,
|
||||
addServerPlugin,
|
||||
addTemplate,
|
||||
createResolver,
|
||||
defineNuxtModule,
|
||||
logger,
|
||||
} from '@nuxt/kit'
|
||||
import { pathExists } from 'fs-extra'
|
||||
import { tinyws } from 'tinyws'
|
||||
import type { ConnectOptions } from 'mongoose'
|
||||
import defu from 'defu'
|
||||
import { join } from 'pathe'
|
||||
import { defu } from 'defu'
|
||||
import sirv from 'sirv'
|
||||
import mongoose from 'mongoose'
|
||||
import { $fetch } from 'ofetch'
|
||||
import { version } from '../package.json'
|
||||
import { setupDevToolsUI } from './devtools'
|
||||
|
||||
import { PATH_CLIENT, PATH_ENTRY } from './constants'
|
||||
import type { ModuleOptions } from './types'
|
||||
|
||||
import { setupRPC } from './server-rpc'
|
||||
|
||||
export type { ModuleOptions }
|
||||
export interface ModuleOptions {
|
||||
/**
|
||||
* The MongoDB URI connection
|
||||
*
|
||||
* @default process.env.MONGODB_URI
|
||||
*
|
||||
*/
|
||||
uri: string | undefined
|
||||
/**
|
||||
* Nuxt DevTools
|
||||
*
|
||||
* @default true
|
||||
*
|
||||
*/
|
||||
devtools: boolean
|
||||
/**
|
||||
* Mongoose Connections
|
||||
*
|
||||
* @default {}
|
||||
*/
|
||||
options?: ConnectOptions
|
||||
/**
|
||||
* Models Directory for auto-import
|
||||
*
|
||||
* @default 'models'
|
||||
*
|
||||
*/
|
||||
modelsDir?: string
|
||||
}
|
||||
|
||||
export default defineNuxtModule<ModuleOptions>({
|
||||
meta: {
|
||||
@ -25,71 +49,53 @@ export default defineNuxtModule<ModuleOptions>({
|
||||
configKey: 'mongoose',
|
||||
},
|
||||
defaults: {
|
||||
// eslint-disable-next-line n/prefer-global/process
|
||||
uri: process.env.MONGODB_URI as string,
|
||||
devtools: true,
|
||||
options: {},
|
||||
modelsDir: 'models',
|
||||
},
|
||||
setup(options, nuxt) {
|
||||
const { resolve } = createResolver(import.meta.url)
|
||||
const runtimeConfig = nuxt.options.runtimeConfig
|
||||
|
||||
addImportsDir(resolve('./runtime/composables'))
|
||||
|
||||
if (!options.uri) {
|
||||
logger.warn('Missing `MONGODB_URI` in `.env`')
|
||||
return
|
||||
hooks: {
|
||||
close: () => {
|
||||
mongoose.disconnect()
|
||||
},
|
||||
},
|
||||
async setup(options, nuxt) {
|
||||
if (nuxt.options.dev) {
|
||||
$fetch('https://registry.npmjs.org/nuxt-mongoose/latest').then((release) => {
|
||||
if (release.version > version)
|
||||
logger.info(`A new version of Nuxt Mongoose (v${release.version}) is available: https://github.com/arashsheyda/nuxt-mongoose/releases/latest`)
|
||||
}).catch(() => {})
|
||||
}
|
||||
|
||||
// Runtime Config
|
||||
runtimeConfig.mongoose = defu(runtimeConfig.mongoose || {}, {
|
||||
if (!options.uri) {
|
||||
logger.warn('Missing MongoDB URI. You can set it in your `nuxt.config` or in your `.env` as `MONGODB_URI`')
|
||||
}
|
||||
|
||||
const { resolve } = createResolver(import.meta.url)
|
||||
const config = nuxt.options.runtimeConfig as any
|
||||
|
||||
config.mongoose = defu(config.mongoose || {}, {
|
||||
uri: options.uri,
|
||||
options: options.options,
|
||||
devtools: options.devtools,
|
||||
modelsDir: options.modelsDir,
|
||||
})
|
||||
|
||||
// Setup devtools UI
|
||||
const distResolve = (p: string) => {
|
||||
const cwd = resolve('.')
|
||||
if (cwd.endsWith('/dist'))
|
||||
return resolve(p)
|
||||
return resolve(`../dist/${p}`)
|
||||
}
|
||||
|
||||
const clientPath = distResolve('./client')
|
||||
const { middleware: rpcMiddleware } = setupRPC(nuxt, options)
|
||||
|
||||
nuxt.hook('vite:serverCreated', async (server) => {
|
||||
server.middlewares.use(PATH_ENTRY, tinyws() as any)
|
||||
server.middlewares.use(PATH_ENTRY, rpcMiddleware as any)
|
||||
if (await pathExists(clientPath))
|
||||
server.middlewares.use(PATH_CLIENT, sirv(clientPath, { dev: true, single: true }))
|
||||
})
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/prefer-ts-expect-error
|
||||
// @ts-ignore runtime type
|
||||
nuxt.hook('devtools:customTabs', (iframeTabs) => {
|
||||
iframeTabs.push({
|
||||
name: 'mongoose',
|
||||
title: 'Mongoose',
|
||||
icon: 'skill-icons:mongodb',
|
||||
view: {
|
||||
type: 'iframe',
|
||||
src: PATH_CLIENT,
|
||||
},
|
||||
})
|
||||
modelsDir: join(nuxt.options.serverDir, options.modelsDir!),
|
||||
})
|
||||
|
||||
// virtual imports
|
||||
nuxt.hook('nitro:config', (nitroConfig) => {
|
||||
nitroConfig.alias = nitroConfig.alias || {}
|
||||
nuxt.hook('nitro:config', (_config) => {
|
||||
_config.alias = _config.alias || {}
|
||||
|
||||
// Inline module runtime in Nitro bundle
|
||||
nitroConfig.externals = defu(typeof nitroConfig.externals === 'object' ? nitroConfig.externals : {}, {
|
||||
_config.externals = defu(typeof _config.externals === 'object' ? _config.externals : {}, {
|
||||
inline: [resolve('./runtime')],
|
||||
})
|
||||
nitroConfig.alias['#nuxt/mongoose'] = resolve('./runtime/server/services')
|
||||
_config.alias['#nuxt/mongoose'] = resolve('./runtime/server/services')
|
||||
|
||||
if (_config.imports) {
|
||||
_config.imports.dirs = _config.imports.dirs || []
|
||||
_config.imports.dirs?.push(config.mongoose.modelsDir)
|
||||
}
|
||||
})
|
||||
|
||||
addTemplate({
|
||||
@ -106,15 +112,9 @@ export default defineNuxtModule<ModuleOptions>({
|
||||
options.references.push({ path: resolve(nuxt.options.buildDir, 'types/nuxt-mongoose.d.ts') })
|
||||
})
|
||||
|
||||
// Nitro auto imports
|
||||
nuxt.hook('nitro:config', (_nitroConfig) => {
|
||||
if (_nitroConfig.imports) {
|
||||
_nitroConfig.imports.dirs = _nitroConfig.imports.dirs || []
|
||||
_nitroConfig.imports.dirs?.push(
|
||||
join(nuxt.options.serverDir, runtimeConfig.mongoose.modelsDir),
|
||||
)
|
||||
}
|
||||
})
|
||||
const isDevToolsEnabled = typeof nuxt.options.devtools === 'boolean' ? nuxt.options.devtools : nuxt.options.devtools.enabled
|
||||
if (nuxt.options.dev && isDevToolsEnabled)
|
||||
setupDevToolsUI(options, resolve, nuxt)
|
||||
|
||||
// Add server-plugin for database connection
|
||||
addServerPlugin(resolve('./runtime/server/plugins/mongoose.db'))
|
||||
|
||||
@ -1,9 +1,8 @@
|
||||
import mongoose from 'mongoose'
|
||||
import type { NuxtDevtoolsServerContext, ServerFunctions } from '../types'
|
||||
|
||||
export function setupDatabaseRPC({ options }: NuxtDevtoolsServerContext): any {
|
||||
mongoose.connect(options.uri, options.options)
|
||||
import type { DevtoolsServerContext, ServerFunctions } from '../types'
|
||||
|
||||
// eslint-disable-next-line no-empty-pattern
|
||||
export function setupDatabaseRPC({}: DevtoolsServerContext) {
|
||||
return {
|
||||
async readyState() {
|
||||
return mongoose.connection.readyState
|
||||
@ -62,8 +61,8 @@ export function setupDatabaseRPC({ options }: NuxtDevtoolsServerContext): any {
|
||||
const skip = (options.page - 1) * options.limit
|
||||
const cursor = mongoose.connection.db.collection(collection).find().skip(skip)
|
||||
if (options.limit !== 0)
|
||||
cursor.limit(options.limit)
|
||||
return await cursor.toArray()
|
||||
cursor?.limit(options.limit)
|
||||
return await cursor?.toArray()
|
||||
},
|
||||
async getDocument(collection: string, document: any) {
|
||||
try {
|
||||
23
src/rpc/index.ts
Normal file
23
src/rpc/index.ts
Normal file
@ -0,0 +1,23 @@
|
||||
import mongoose from 'mongoose'
|
||||
import type { DevtoolsServerContext, ServerFunctions } from '../types'
|
||||
|
||||
import { setupDatabaseRPC } from './database'
|
||||
import { setupResourceRPC } from './resource'
|
||||
|
||||
export function setupRPC(ctx: DevtoolsServerContext): ServerFunctions {
|
||||
mongoose.connect(ctx.options.uri, ctx.options.options)
|
||||
|
||||
return {
|
||||
getOptions() {
|
||||
return ctx.options
|
||||
},
|
||||
|
||||
...setupDatabaseRPC(ctx),
|
||||
...setupResourceRPC(ctx),
|
||||
|
||||
async reset() {
|
||||
const ws = await ctx.wsServer
|
||||
ws.send('nuxt-mongoose:reset')
|
||||
},
|
||||
}
|
||||
}
|
||||
@ -1,21 +1,22 @@
|
||||
import fs from 'fs-extra'
|
||||
import { resolve } from 'pathe'
|
||||
import type { Collection, NuxtDevtoolsServerContext, Resource, ServerFunctions } from '../types'
|
||||
import { generateApiRoute, generateSchemaFile } from '../utils/schematics'
|
||||
import { capitalize, pluralize, singularize } from '../utils/formatting'
|
||||
import { join } from 'pathe'
|
||||
import mongoose from 'mongoose'
|
||||
import type { Collection, DevtoolsServerContext, Resource, ServerFunctions } from '../types'
|
||||
import { capitalize, generateApiRoute, generateSchemaFile, pluralize, singularize } from '../utils'
|
||||
|
||||
export function setupResourceRPC({ nuxt }: DevtoolsServerContext): any {
|
||||
const config = nuxt.options.runtimeConfig.mongoose
|
||||
|
||||
export function setupResourceRPC({ nuxt, rpc }: NuxtDevtoolsServerContext): any {
|
||||
return {
|
||||
// TODO: maybe separate functions
|
||||
async generateResource(collection: Collection, resources: Resource[]) {
|
||||
const singular = singularize(collection.name).toLowerCase()
|
||||
const plural = pluralize(collection.name).toLowerCase()
|
||||
const dbName = capitalize(singular)
|
||||
|
||||
if (collection.fields) {
|
||||
const schemaPath = resolve(nuxt.options.serverDir, 'utils/models', `${singular}.schema.ts`)
|
||||
const schemaPath = join(config.modelsDir, `${singular}.schema.ts`)
|
||||
if (!fs.existsSync(schemaPath)) {
|
||||
fs.ensureDirSync(resolve(nuxt.options.serverDir, 'utils/models'))
|
||||
fs.ensureDirSync(config.modelsDir)
|
||||
fs.writeFileSync(schemaPath, generateSchemaFile(dbName, collection.fields))
|
||||
}
|
||||
|
||||
@ -34,9 +35,9 @@ export function setupResourceRPC({ nuxt, rpc }: NuxtDevtoolsServerContext): any
|
||||
? (routeTypes[route.type] as any)(route.by)
|
||||
: routeTypes[route.type]
|
||||
|
||||
const filePath = resolve(nuxt.options.serverDir, 'api', plural, fileName)
|
||||
const filePath = join(nuxt.options.serverDir, 'api', plural, fileName)
|
||||
if (!fs.existsSync(filePath)) {
|
||||
fs.ensureDirSync(resolve(nuxt.options.serverDir, `api/${plural}`))
|
||||
fs.ensureDirSync(join(nuxt.options.serverDir, `api/${plural}`))
|
||||
const content = generateApiRoute(route.type, { model, by: route.by })
|
||||
fs.writeFileSync(filePath, content)
|
||||
}
|
||||
@ -44,14 +45,13 @@ export function setupResourceRPC({ nuxt, rpc }: NuxtDevtoolsServerContext): any
|
||||
}
|
||||
|
||||
// create collection if not exists
|
||||
const collections = await rpc.functions.listCollections()
|
||||
const collections = await mongoose.connection.db.listCollections().toArray()
|
||||
if (!collections.find((c: any) => c.name === plural))
|
||||
await rpc.functions.createCollection(plural)
|
||||
return await mongoose.connection.db.createCollection(plural)
|
||||
},
|
||||
async resourceSchema(collection: string) {
|
||||
// TODO: use magicast
|
||||
const singular = singularize(collection).toLowerCase()
|
||||
const schemaPath = resolve(nuxt.options.serverDir, 'utils/models', `${singular}.schema.ts`)
|
||||
const schemaPath = join(config.modelsDir, `${singular}.schema.ts`)
|
||||
if (fs.existsSync(schemaPath)) {
|
||||
const content = fs.readFileSync(schemaPath, 'utf-8').match(/schema: \{(.|\n)*\}/g)
|
||||
if (content) {
|
||||
@ -1,8 +1,8 @@
|
||||
/**
|
||||
* Due to an upstream bug in Nuxt 3 we need to stub the plugin here, track:https://github.com/nuxt/nuxt/issues/18556
|
||||
* */
|
||||
*/
|
||||
import type { NitroApp } from 'nitropack'
|
||||
import { defineMongooseConnection } from '../services/mongoose'
|
||||
import { defineMongooseConnection } from '../services'
|
||||
|
||||
type NitroAppPlugin = (nitro: NitroApp) => void
|
||||
|
||||
|
||||
21
src/runtime/server/services/connection.ts
Normal file
21
src/runtime/server/services/connection.ts
Normal file
@ -0,0 +1,21 @@
|
||||
import type { ConnectOptions } from 'mongoose'
|
||||
import { consola } from 'consola'
|
||||
import { colors } from 'consola/utils'
|
||||
import mongoose from 'mongoose'
|
||||
|
||||
// @ts-ignore
|
||||
import { useRuntimeConfig } from '#imports'
|
||||
|
||||
export async function defineMongooseConnection({ uri, options }: { uri?: string; options?: ConnectOptions } = {}): Promise<void> {
|
||||
const config = useRuntimeConfig().mongoose
|
||||
const mongooseUri = uri || config.uri
|
||||
const mongooseOptions = options || config.options
|
||||
|
||||
try {
|
||||
await mongoose.connect(mongooseUri, { ...mongooseOptions })
|
||||
consola.success('Connected to MongoDB')
|
||||
}
|
||||
catch (err) {
|
||||
consola.error(colors.red(`Error connecting to MongoDB: ${err}`))
|
||||
}
|
||||
}
|
||||
33
src/runtime/server/services/discriminator.ts
Normal file
33
src/runtime/server/services/discriminator.ts
Normal file
@ -0,0 +1,33 @@
|
||||
import type { Model, SchemaDefinition, SchemaOptions } from 'mongoose'
|
||||
import mongoose from 'mongoose'
|
||||
|
||||
export function defineMongooseDiscriminatorModel<T>(
|
||||
nameOrOptions: string | {
|
||||
name: string;
|
||||
baseModel: Model<T>;
|
||||
schema: SchemaDefinition<T>;
|
||||
options?: SchemaOptions;
|
||||
hooks?: (schema: mongoose.Schema<T>) => void;
|
||||
},
|
||||
baseModel?: Model<T>,
|
||||
schema?: SchemaDefinition<T>,
|
||||
options?: SchemaOptions,
|
||||
hooks?: (schema: mongoose.Schema<T>) => void,
|
||||
): Model<T> {
|
||||
let name: string
|
||||
if (typeof nameOrOptions === 'string') { name = nameOrOptions }
|
||||
else {
|
||||
name = nameOrOptions.name
|
||||
baseModel = nameOrOptions.baseModel
|
||||
schema = nameOrOptions.schema
|
||||
options = nameOrOptions.options
|
||||
hooks = nameOrOptions.hooks
|
||||
}
|
||||
|
||||
const newSchema = new mongoose.Schema<T>(schema, options as any)
|
||||
|
||||
if (hooks)
|
||||
hooks(newSchema)
|
||||
|
||||
return baseModel!.discriminator<T>(name, newSchema)
|
||||
}
|
||||
@ -1 +1,3 @@
|
||||
export { defineMongooseConnection, defineMongooseModel } from './mongoose'
|
||||
export { defineMongooseConnection } from './connection'
|
||||
export { defineMongooseModel } from './model'
|
||||
export { defineMongooseDiscriminatorModel } from './discriminator'
|
||||
|
||||
32
src/runtime/server/services/model.ts
Normal file
32
src/runtime/server/services/model.ts
Normal file
@ -0,0 +1,32 @@
|
||||
import type { Model, SchemaDefinition, SchemaOptions } from 'mongoose'
|
||||
import mongoose from 'mongoose'
|
||||
|
||||
export function defineMongooseModel<T>(
|
||||
nameOrOptions: string | {
|
||||
name: string
|
||||
schema: SchemaDefinition<T>
|
||||
options?: SchemaOptions
|
||||
hooks?: (schema: mongoose.Schema<T>) => void
|
||||
},
|
||||
schema?: SchemaDefinition<T>,
|
||||
options?: SchemaOptions,
|
||||
hooks?: (schema: mongoose.Schema<T>) => void,
|
||||
): Model<T> {
|
||||
let name: string
|
||||
if (typeof nameOrOptions === 'string') {
|
||||
name = nameOrOptions
|
||||
}
|
||||
else {
|
||||
name = nameOrOptions.name
|
||||
schema = nameOrOptions.schema
|
||||
options = nameOrOptions.options
|
||||
hooks = nameOrOptions.hooks
|
||||
}
|
||||
|
||||
const newSchema = new mongoose.Schema<T>(schema, options as any)
|
||||
|
||||
if (hooks)
|
||||
hooks(newSchema)
|
||||
|
||||
return mongoose.model<T>(name, newSchema)
|
||||
}
|
||||
@ -1,36 +0,0 @@
|
||||
import type { ConnectOptions, Model, SchemaDefinition, SchemaOptions } from 'mongoose'
|
||||
import mongoose from 'mongoose'
|
||||
import { logger } from '@nuxt/kit'
|
||||
|
||||
import { useRuntimeConfig } from '#imports'
|
||||
|
||||
export async function defineMongooseConnection({ uri, options }: { uri?: string; options?: ConnectOptions } = {}): Promise<void> {
|
||||
const config = useRuntimeConfig().mongoose
|
||||
const mongooseUri = uri || config.uri
|
||||
const mongooseOptions = options || config.options
|
||||
|
||||
try {
|
||||
await mongoose.connect(mongooseUri, { ...mongooseOptions })
|
||||
logger.info('Connected to mongoose database')
|
||||
}
|
||||
catch (err) {
|
||||
logger.error('Error connecting to database', err)
|
||||
}
|
||||
}
|
||||
|
||||
export function defineMongooseModel(nameOrOptions: string | { name: string; schema: SchemaDefinition; options?: SchemaOptions }, schema?: SchemaDefinition, options?: SchemaOptions): Model<any> {
|
||||
let name: string
|
||||
if (typeof nameOrOptions === 'string') {
|
||||
name = nameOrOptions
|
||||
}
|
||||
else {
|
||||
name = nameOrOptions.name
|
||||
schema = nameOrOptions.schema
|
||||
options = nameOrOptions.options
|
||||
}
|
||||
|
||||
const newSchema = new mongoose.Schema({
|
||||
...schema,
|
||||
}, { ...options })
|
||||
return mongoose.model(name, newSchema)
|
||||
}
|
||||
@ -1,103 +0,0 @@
|
||||
import type { TinyWSRequest } from 'tinyws'
|
||||
import type { NodeIncomingMessage, NodeServerResponse } from 'h3'
|
||||
import type { WebSocket } from 'ws'
|
||||
import { createBirpcGroup } from 'birpc'
|
||||
import type { ChannelOptions } from 'birpc'
|
||||
|
||||
import { parse, stringify } from 'flatted'
|
||||
import type { Nuxt } from 'nuxt/schema'
|
||||
import type { ClientFunctions, ModuleOptions, NuxtDevtoolsServerContext, ServerFunctions } from '../types'
|
||||
import { setupDatabaseRPC } from './database'
|
||||
import { setupResourceRPC } from './resource'
|
||||
|
||||
export function setupRPC(nuxt: Nuxt, options: ModuleOptions): any {
|
||||
const serverFunctions = {} as ServerFunctions
|
||||
const extendedRpcMap = new Map<string, any>()
|
||||
const rpc = createBirpcGroup<ClientFunctions, ServerFunctions>(
|
||||
serverFunctions,
|
||||
[],
|
||||
{
|
||||
resolver: (name, fn) => {
|
||||
if (fn)
|
||||
return fn
|
||||
|
||||
if (!name.includes(':'))
|
||||
return
|
||||
|
||||
const [namespace, fnName] = name.split(':')
|
||||
return extendedRpcMap.get(namespace)?.[fnName]
|
||||
},
|
||||
onError(error, name) {
|
||||
console.error(`[nuxt-devtools] RPC error on executing "${name}":`, error)
|
||||
},
|
||||
},
|
||||
)
|
||||
|
||||
function refresh(event: keyof ServerFunctions) {
|
||||
rpc.broadcast.refresh.asEvent(event)
|
||||
}
|
||||
|
||||
function extendServerRpc(namespace: string, functions: any): any {
|
||||
extendedRpcMap.set(namespace, functions)
|
||||
|
||||
return {
|
||||
broadcast: new Proxy({}, {
|
||||
get: (_, key) => {
|
||||
if (typeof key !== 'string')
|
||||
return
|
||||
return (rpc.broadcast as any)[`${namespace}:${key}`]
|
||||
},
|
||||
}),
|
||||
}
|
||||
}
|
||||
|
||||
const ctx: NuxtDevtoolsServerContext = {
|
||||
nuxt,
|
||||
options,
|
||||
rpc,
|
||||
refresh,
|
||||
extendServerRpc,
|
||||
}
|
||||
|
||||
// @ts-expect-error untyped
|
||||
nuxt.devtools = ctx
|
||||
|
||||
Object.assign(serverFunctions, {
|
||||
...setupDatabaseRPC(ctx),
|
||||
...setupResourceRPC(ctx),
|
||||
} satisfies Partial<ServerFunctions>)
|
||||
|
||||
const wsClients = new Set<WebSocket>()
|
||||
const middleware = async (req: NodeIncomingMessage & TinyWSRequest, _res: NodeServerResponse, next: Function) => {
|
||||
// Handle WebSocket
|
||||
if (req.ws) {
|
||||
const ws = await req.ws()
|
||||
wsClients.add(ws)
|
||||
const channel: ChannelOptions = {
|
||||
post: d => ws.send(d),
|
||||
on: fn => ws.on('message', fn),
|
||||
serialize: stringify,
|
||||
deserialize: parse,
|
||||
}
|
||||
rpc.updateChannels((c) => {
|
||||
c.push(channel)
|
||||
})
|
||||
ws.on('close', () => {
|
||||
wsClients.delete(ws)
|
||||
rpc.updateChannels((c) => {
|
||||
const index = c.indexOf(channel)
|
||||
if (index >= 0)
|
||||
c.splice(index, 1)
|
||||
})
|
||||
})
|
||||
}
|
||||
else {
|
||||
next()
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
middleware,
|
||||
...ctx,
|
||||
}
|
||||
}
|
||||
@ -1,3 +1,47 @@
|
||||
export * from './rpc'
|
||||
export * from './server-ctx'
|
||||
export * from './module-options'
|
||||
import type { Nuxt } from 'nuxt/schema'
|
||||
import type { WebSocketServer } from 'vite'
|
||||
import type { ModuleOptions } from '../module'
|
||||
|
||||
export interface ServerFunctions {
|
||||
getOptions(): ModuleOptions
|
||||
|
||||
// Database - collections
|
||||
readyState(): Promise<any>
|
||||
createCollection(name: string): Promise<any>
|
||||
listCollections(): Promise<any>
|
||||
getCollection(name: string): Promise<any>
|
||||
dropCollection(name: string): Promise<any>
|
||||
|
||||
// Database - documents
|
||||
createDocument(collection: string, data: any): Promise<any>
|
||||
countDocuments(collection: string): Promise<any>
|
||||
listDocuments(collection: string, options: any): Promise<any>
|
||||
getDocument(collection: string, id: string): Promise<any>
|
||||
updateDocument(collection: string, data: any): Promise<any>
|
||||
deleteDocument(collection: string, id: string): Promise<any>
|
||||
|
||||
// Resource - api-routes & models
|
||||
generateResource(collection: Collection, resources: Resource[]): Promise<any>
|
||||
resourceSchema(collection: string): Promise<any>
|
||||
|
||||
reset(): void
|
||||
}
|
||||
|
||||
export interface ClientFunctions {
|
||||
}
|
||||
|
||||
export interface DevtoolsServerContext {
|
||||
nuxt: Nuxt
|
||||
options: ModuleOptions
|
||||
wsServer: Promise<WebSocketServer>
|
||||
}
|
||||
|
||||
export interface Collection {
|
||||
name: string
|
||||
fields?: object[]
|
||||
}
|
||||
|
||||
export interface Resource {
|
||||
type: 'index' | 'create' | 'show' | 'put' | 'delete'
|
||||
by?: string
|
||||
}
|
||||
|
||||
@ -1,8 +0,0 @@
|
||||
import type { ConnectOptions } from 'mongoose'
|
||||
|
||||
export interface ModuleOptions {
|
||||
uri: string
|
||||
devtools: boolean
|
||||
options?: ConnectOptions
|
||||
modelsDir?: string
|
||||
}
|
||||
@ -1,34 +0,0 @@
|
||||
export interface ServerFunctions {
|
||||
// Database - collections
|
||||
readyState(): Promise<any>
|
||||
createCollection(name: string): Promise<any>
|
||||
listCollections(): Promise<any>
|
||||
getCollection(name: string): Promise<any>
|
||||
dropCollection(name: string): Promise<any>
|
||||
|
||||
// Database - documents
|
||||
createDocument(collection: string, data: any): Promise<any>
|
||||
countDocuments(collection: string): Promise<any>
|
||||
listDocuments(collection: string, options: any): Promise<any>
|
||||
getDocument(collection: string, id: string): Promise<any>
|
||||
updateDocument(collection: string, data: any): Promise<any>
|
||||
deleteDocument(collection: string, id: string): Promise<any>
|
||||
|
||||
// Resource - api-routes & models
|
||||
generateResource(collection: Collection, resources: Resource[]): Promise<any>
|
||||
resourceSchema(collection: string): Promise<any>
|
||||
}
|
||||
|
||||
export interface ClientFunctions {
|
||||
refresh(type: string): void
|
||||
}
|
||||
|
||||
export interface Collection {
|
||||
name: string
|
||||
fields?: {}[]
|
||||
}
|
||||
|
||||
export interface Resource {
|
||||
type: 'index' | 'create' | 'show' | 'put' | 'delete'
|
||||
by?: string
|
||||
}
|
||||
@ -1,15 +0,0 @@
|
||||
import type { BirpcGroup } from 'birpc'
|
||||
import type { Nuxt } from 'nuxt/schema'
|
||||
import type { ClientFunctions, ServerFunctions } from './rpc'
|
||||
import type { ModuleOptions } from './module-options'
|
||||
|
||||
export interface NuxtDevtoolsServerContext {
|
||||
nuxt: Nuxt
|
||||
options: ModuleOptions
|
||||
|
||||
rpc: BirpcGroup<ClientFunctions, ServerFunctions>
|
||||
|
||||
refresh: (event: keyof ServerFunctions) => void
|
||||
|
||||
extendServerRpc: <ClientFunctions = {}, ServerFunctions = {}>(name: string, functions: ServerFunctions) => BirpcGroup<ClientFunctions, ServerFunctions>
|
||||
}
|
||||
@ -1,22 +0,0 @@
|
||||
import plrz from 'pluralize'
|
||||
|
||||
export function normalizeToKebabOrSnakeCase(str: string) {
|
||||
const STRING_DASHERIZE_REGEXP = /\s/g
|
||||
const STRING_DECAMELIZE_REGEXP = /([a-z\d])([A-Z])/g
|
||||
return str
|
||||
.replace(STRING_DECAMELIZE_REGEXP, '$1-$2')
|
||||
.toLowerCase()
|
||||
.replace(STRING_DASHERIZE_REGEXP, '-')
|
||||
}
|
||||
|
||||
export function pluralize(str: string) {
|
||||
return plrz.plural(str)
|
||||
}
|
||||
|
||||
export function singularize(str: string) {
|
||||
return plrz.singular(str)
|
||||
}
|
||||
|
||||
export function capitalize(str: string) {
|
||||
return str.charAt(0).toUpperCase() + str.slice(1)
|
||||
}
|
||||
@ -1,4 +1,35 @@
|
||||
import { capitalize } from './formatting'
|
||||
import type { WebSocketServer } from 'vite'
|
||||
import type { Nuxt } from 'nuxt/schema'
|
||||
import plrz from 'pluralize'
|
||||
|
||||
export function useViteWebSocket(nuxt: Nuxt) {
|
||||
return new Promise<WebSocketServer>((_resolve) => {
|
||||
nuxt.hooks.hook('vite:serverCreated', (viteServer) => {
|
||||
_resolve(viteServer.ws)
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
export function normalizeToKebabOrSnakeCase(str: string) {
|
||||
const STRING_DASHERIZE_REGEXP = /\s/g
|
||||
const STRING_DECAMELIZE_REGEXP = /([a-z\d])([A-Z])/g
|
||||
return str
|
||||
.replace(STRING_DECAMELIZE_REGEXP, '$1-$2')
|
||||
.toLowerCase()
|
||||
.replace(STRING_DASHERIZE_REGEXP, '-')
|
||||
}
|
||||
|
||||
export function pluralize(str: string) {
|
||||
return plrz.plural(str)
|
||||
}
|
||||
|
||||
export function singularize(str: string) {
|
||||
return plrz.singular(str)
|
||||
}
|
||||
|
||||
export function capitalize(str: string) {
|
||||
return str.charAt(0).toUpperCase() + str.slice(1)
|
||||
}
|
||||
|
||||
export function generateSchemaFile(name: string, fields: any) {
|
||||
name = capitalize(name)
|
||||
@ -1,3 +1,3 @@
|
||||
{
|
||||
"extends": "./client/.nuxt/tsconfig.json"
|
||||
"extends": "./playground/.nuxt/tsconfig.json"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user