13 Commits

Author SHA1 Message Date
e2d37c2efe chore(release): v0.0.8 2023-06-18 13:19:46 +03:00
487cca530b chore: update cover 2023-06-18 13:09:00 +03:00
9e867fc0b3 docs: favicon 2023-06-18 13:04:06 +03:00
23ec1989f7 docs: style 2023-06-18 13:00:34 +03:00
1c3608743e fix: resource generator modelsDir output 2023-06-18 12:32:00 +03:00
33bb3cc550 fix: run studio action only for docs 2023-06-18 12:26:59 +03:00
fe1807fcd5 Merge branch 'main' of https://github.com/arashsheyda/nuxt-mongoose 2023-06-18 12:21:49 +03:00
aaef56cb29 refactor: reuse vite's websocket 2023-06-18 12:20:57 +03:00
32846c1e44 Merge pull request #6 from joypal23jkp/patch-1
Updated the configuration setup docs.
2023-06-12 10:53:36 +03:00
771e071005 Updated the configuration setup docs.
Figured out that need to just add MONGODB_URI to .env if only need to provide URI.
2023-06-12 02:12:47 +06:00
2ba8bdadfc docs(devtools): demo video 2023-06-08 22:39:03 +03:00
6c057d4cd7 docs: remove devtools 2023-06-05 21:35:37 +03:00
00259fc865 chore(deployment): add workflow file 2023-06-05 21:31:22 +03:00
22 changed files with 283 additions and 111 deletions

82
.github/workflows/studio.yml vendored Normal file
View 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
- 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

1
.nuxtrc Normal file
View File

@ -0,0 +1 @@
typescript.includeWorkspace=true

View File

@ -1,6 +1,44 @@
# Changelog # Changelog
## 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 ## v0.0.7
[compare changes](https://github.com/arashsheyda/nuxt-mongoose/compare/v0.0.6...v0.0.7) [compare changes](https://github.com/arashsheyda/nuxt-mongoose/compare/v0.0.6...v0.0.7)

View File

@ -1,4 +1,4 @@
![nuxt-mongoose](https://raw.githubusercontent.com/arashsheyda/nuxt-mongoose/c967d0bb162dddc27fa510ba3b49e4f9b6b2db61/docs/public/nuxt-mongoose.svg) ![nuxt-mongoose](https://nuxt-mongoose.nuxt.space/cover.jpg)
<div align="center"> <div align="center">
<h1>Nuxt Mongoose</h1> <h1>Nuxt Mongoose</h1>

View File

@ -81,8 +81,9 @@ function editDocument(document: any) {
async function saveDocument(document: any, create = true) { async function saveDocument(document: any, create = true) {
const method = create ? rpc.createDocument : rpc.updateDocument const method = create ? rpc.createDocument : rpc.updateDocument
const newDocument = await method(props.collection, document) const newDocument = await method(props.collection, document)
// TODO: show toast
if (newDocument?.error) if (newDocument?.error)
return alert(newDocument.error.message) return
if (create) { if (create) {
if (!documents.value.length) { if (!documents.value.length) {
@ -105,8 +106,9 @@ function discardEditing() {
async function deleteDocument(document: any) { async function deleteDocument(document: any) {
const newDocument = await rpc.deleteDocument(props.collection, document._id) const newDocument = await rpc.deleteDocument(props.collection, document._id)
// TODO: show toast
if (newDocument.deletedCount === 0) if (newDocument.deletedCount === 0)
return alert('Failed to delete document') return
documents.value = documents.value.filter((doc: any) => doc._id !== document._id) documents.value = documents.value.filter((doc: any) => doc._id !== document._id)
} }

View File

@ -1,14 +1,14 @@
import { createBirpc } from 'birpc' import { createBirpc } from 'birpc'
import { parse, stringify } from 'flatted' import { parse, stringify } from 'flatted'
import { createHotContext } from 'vite-hot-client'
import type { ClientFunctions, ServerFunctions } from '../../src/types' import type { ClientFunctions, ServerFunctions } from '../../src/types'
import { PATH_ENTRY } from '../../src/constants' import { WS_EVENT_NAME } from '../../src/constants'
const RECONNECT_INTERVAL = 2000
export const wsConnecting = ref(true) export const wsConnecting = ref(true)
export const wsError = ref<any>() export const wsError = ref<any>()
export const wsConnectingDebounced = useDebounce(wsConnecting, 2000)
let connectPromise = connectWS() const connectPromise = connectVite()
let onMessage: Function = () => {} let onMessage: Function = () => {}
export const clientFunctions = { export const clientFunctions = {
@ -19,9 +19,11 @@ export const extendedRpcMap = new Map<string, any>()
export const rpc = createBirpc<ServerFunctions>(clientFunctions, { export const rpc = createBirpc<ServerFunctions>(clientFunctions, {
post: async (d) => { post: async (d) => {
(await connectPromise).send(d) (await connectPromise).send(WS_EVENT_NAME, d)
},
on: (fn) => {
onMessage = fn
}, },
on: (fn) => { onMessage = fn },
serialize: stringify, serialize: stringify,
deserialize: parse, deserialize: parse,
resolver(name, fn) { resolver(name, fn) {
@ -35,35 +37,22 @@ export const rpc = createBirpc<ServerFunctions>(clientFunctions, {
onError(error, name) { onError(error, name) {
console.error(`[nuxt-devtools] RPC error on executing "${name}":`, error) console.error(`[nuxt-devtools] RPC error on executing "${name}":`, error)
}, },
timeout: 120_000,
}) })
async function connectWS() { async function connectVite() {
const wsUrl = new URL(`ws://host${PATH_ENTRY}`) const hot = await createHotContext()
wsUrl.protocol = location.protocol === 'https:' ? 'wss:' : 'ws:'
wsUrl.host = 'localhost:3000'
const ws = new WebSocket(wsUrl.toString()) if (!hot)
ws.addEventListener('message', e => onMessage(String(e.data))) throw new Error('Unable to connect to devtools')
ws.addEventListener('error', (e) => {
console.error(e) hot.on(WS_EVENT_NAME, (data) => {
wsError.value = e onMessage(data)
}) })
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 // TODO:
console.log('[nuxt-devtools] WebSocket connected.') // hot.on('vite:connect', (data) => {})
wsConnecting.value = false // hot.on('vite:disconnect', (data) => {})
wsError.value = null
return ws return hot
} }

View File

@ -2,8 +2,9 @@ export default defineAppConfig({
docus: { docus: {
title: 'Nuxt Mongoose', title: 'Nuxt Mongoose',
description: 'A Nuxt module for simplifying the use of Mongoose in your project.', 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', image: '/cover.jpg',
socials: { socials: {
twitter: 'arash_sheyda',
github: 'arashsheyda/nuxt-mongoose', github: 'arashsheyda/nuxt-mongoose',
}, },
github: { github: {

View File

@ -1,12 +1,18 @@
<template> <template>
<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 235.5 33.2"> <svg id="NuxtMongooseLogo" 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" /> <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="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.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" /> <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"> <text transform="translate(32.8 25.6)" style="font-size:25.818214416503906px;font-family:var(--font-sans);font-weight:700">
<tspan fill="currentColor" x="4" y="0">Nuxt</tspan> <tspan fill="currentColor" x="4" y="0">Nuxt</tspan>
<tspan x="70.8" y="0" style="fill:#10aa50">Mongoose</tspan> <tspan x="67.8" y="0" style="fill:#10aa50">Mongoose</tspan>
</text> </text>
</svg> </svg>
</template> </template>
<style>
.NuxtMongooseLogo {
font-family: serif;
}
</style>

View File

@ -19,7 +19,7 @@ secondary:
--- ---
#title #title
Nuxt Mongoose Nuxt [Mongoose]{style="color: var(--color-primary-500)"}
#description #description
A Nuxt module for simplifying the use of [Mongoose](https://mongoosejs.com/) in your project. A Nuxt module for simplifying the use of [Mongoose](https://mongoosejs.com/) in your project.

View File

@ -49,3 +49,8 @@ export default defineNuxtConfig({
}, },
}) })
``` ```
If you want to configure only the `uri` just add `MONGODB_URI` in your `.env` file.
```env
MONGODB_URI=YOUR_MONGO_URI
```

View File

@ -1,3 +1,8 @@
# Devtools (beta) # 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... `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...
Here is a demo video:
:video-player{src="https://www.youtube.com/watch?v=hK0npSfr_Vs"}

View File

@ -1,8 +1,19 @@
export default defineNuxtConfig({ export default defineNuxtConfig({
extends: '@nuxt-themes/docus', extends: '@nuxt-themes/docus',
app: {
head: {
link: [
{
rel: 'icon',
type: 'image/x-icon',
href: '/mongoose-icon.svg',
},
],
},
},
modules: [ modules: [
'@nuxthq/studio', '@nuxthq/studio',
'@nuxt/devtools',
], ],
}) })

BIN
docs/public/cover.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 214 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

View File

@ -1,7 +1,7 @@
{ {
"name": "nuxt-mongoose", "name": "nuxt-mongoose",
"type": "module", "type": "module",
"version": "0.0.7", "version": "0.0.8",
"description": "Nuxt 3 module for MongoDB with Mongoose", "description": "Nuxt 3 module for MongoDB with Mongoose",
"license": "MIT", "license": "MIT",
"repository": { "repository": {
@ -14,10 +14,6 @@
"require": "./module.cjs", "require": "./module.cjs",
"import": "./dist/module.mjs" "import": "./dist/module.mjs"
}, },
"./types": {
"types": "./dist/types.d.ts",
"import": "./dist/types.mjs"
},
"./*": "./*" "./*": "./*"
}, },
"main": "./module.cjs", "main": "./module.cjs",
@ -46,10 +42,11 @@
"flatted": "^3.2.7", "flatted": "^3.2.7",
"fs-extra": "^11.1.1", "fs-extra": "^11.1.1",
"mongoose": "^7.2.2", "mongoose": "^7.2.2",
"ofetch": "^1.1.0",
"pathe": "^1.1.0", "pathe": "^1.1.0",
"pluralize": "^8.0.0", "pluralize": "^8.0.0",
"sirv": "^2.0.3", "sirv": "^2.0.3",
"tinyws": "^0.1.0", "vite-hot-client": "^0.2.1",
"ws": "^8.13.0" "ws": "^8.13.0"
}, },
"devDependencies": { "devDependencies": {

66
pnpm-lock.yaml generated
View File

@ -1,4 +1,8 @@
lockfileVersion: '6.0' lockfileVersion: '6.1'
settings:
autoInstallPeers: true
excludeLinksFromLockfile: false
dependencies: dependencies:
'@nuxt/devtools-kit': '@nuxt/devtools-kit':
@ -25,6 +29,9 @@ dependencies:
mongoose: mongoose:
specifier: ^7.2.2 specifier: ^7.2.2
version: 7.2.2 version: 7.2.2
ofetch:
specifier: ^1.1.0
version: 1.1.0
pathe: pathe:
specifier: ^1.1.0 specifier: ^1.1.0
version: 1.1.0 version: 1.1.0
@ -34,9 +41,9 @@ dependencies:
sirv: sirv:
specifier: ^2.0.3 specifier: ^2.0.3
version: 2.0.3 version: 2.0.3
tinyws: vite-hot-client:
specifier: ^0.1.0 specifier: ^0.2.1
version: 0.1.0(ws@8.13.0) version: 0.2.1(vite@4.3.9)
ws: ws:
specifier: ^8.13.0 specifier: ^8.13.0
version: 8.13.0 version: 8.13.0
@ -1150,7 +1157,7 @@ packages:
mri: 1.2.0 mri: 1.2.0
nanoid: 4.0.2 nanoid: 4.0.2
node-fetch: 3.3.1 node-fetch: 3.3.1
ofetch: 1.0.1 ofetch: 1.1.0
parse-git-config: 3.0.0 parse-git-config: 3.0.0
rc9: 2.1.0 rc9: 2.1.0
std-env: 3.3.3 std-env: 3.3.3
@ -1180,7 +1187,7 @@ packages:
defu: 6.1.2 defu: 6.1.2
execa: 7.1.1 execa: 7.1.1
get-port-please: 3.0.1 get-port-please: 3.0.1
ofetch: 1.0.1 ofetch: 1.1.0
pathe: 1.1.0 pathe: 1.1.0
ufo: 1.1.2 ufo: 1.1.2
vitest: 0.31.2(sass@1.62.1) vitest: 0.31.2(sass@1.62.1)
@ -1820,7 +1827,7 @@ packages:
dependencies: dependencies:
'@iconify/utils': 2.1.5 '@iconify/utils': 2.1.5
'@unocss/core': 0.52.5 '@unocss/core': 0.52.5
ofetch: 1.0.1 ofetch: 1.1.0
transitivePeerDependencies: transitivePeerDependencies:
- supports-color - supports-color
dev: true dev: true
@ -1857,7 +1864,7 @@ packages:
resolution: {integrity: sha512-oynjtFC05NQM1RXith7LM0MCQGqy4yF0tFRnpM8zmq3p6L7XPFitL5Lmx/walXOB7bw9QSL+gMjamdpEo+KjQg==} resolution: {integrity: sha512-oynjtFC05NQM1RXith7LM0MCQGqy4yF0tFRnpM8zmq3p6L7XPFitL5Lmx/walXOB7bw9QSL+gMjamdpEo+KjQg==}
dependencies: dependencies:
'@unocss/core': 0.52.5 '@unocss/core': 0.52.5
ofetch: 1.0.1 ofetch: 1.1.0
dev: true dev: true
/@unocss/preset-wind@0.52.5: /@unocss/preset-wind@0.52.5:
@ -2900,7 +2907,7 @@ packages:
execa: 7.1.1 execa: 7.1.1
mri: 1.2.0 mri: 1.2.0
node-fetch-native: 1.1.1 node-fetch-native: 1.1.1
ofetch: 1.0.1 ofetch: 1.1.0
open: 9.1.0 open: 9.1.0
pathe: 1.1.0 pathe: 1.1.0
pkg-types: 1.0.3 pkg-types: 1.0.3
@ -4385,7 +4392,7 @@ packages:
defu: 6.1.2 defu: 6.1.2
https-proxy-agent: 5.0.1 https-proxy-agent: 5.0.1
mri: 1.2.0 mri: 1.2.0
node-fetch-native: 1.1.1 node-fetch-native: 1.2.0
pathe: 1.1.0 pathe: 1.1.0
tar: 6.1.15 tar: 6.1.15
transitivePeerDependencies: transitivePeerDependencies:
@ -5827,8 +5834,8 @@ packages:
mime: 3.0.0 mime: 3.0.0
mlly: 1.3.0 mlly: 1.3.0
mri: 1.2.0 mri: 1.2.0
node-fetch-native: 1.1.1 node-fetch-native: 1.2.0
ofetch: 1.0.1 ofetch: 1.1.0
ohash: 1.1.2 ohash: 1.1.2
openapi-typescript: 6.2.6 openapi-typescript: 6.2.6
pathe: 1.1.0 pathe: 1.1.0
@ -5868,6 +5875,10 @@ packages:
/node-fetch-native@1.1.1: /node-fetch-native@1.1.1:
resolution: {integrity: sha512-9VvspTSUp2Sxbl+9vbZTlFGq9lHwE8GDVVekxx6YsNd1YH59sb3Ba8v3Y3cD8PkLNcileGGcA21PFjVl0jzDaw==} resolution: {integrity: sha512-9VvspTSUp2Sxbl+9vbZTlFGq9lHwE8GDVVekxx6YsNd1YH59sb3Ba8v3Y3cD8PkLNcileGGcA21PFjVl0jzDaw==}
dev: true
/node-fetch-native@1.2.0:
resolution: {integrity: sha512-5IAMBTl9p6PaAjYCnMv5FmqIF6GcZnawAVnzaCG0rX2aYZJ4CxEkZNtVPuTRug7fL7wyM5BQYTlAzcyMPi6oTQ==}
/node-fetch@2.6.11: /node-fetch@2.6.11:
resolution: {integrity: sha512-4I6pdBY1EthSqDmJkiNk3JIT8cswwR9nfeW/cPdUagJYEQG7R95WRH74wpz7ma8Gh/9dI9FP+OU+0E4FvtA55w==} resolution: {integrity: sha512-4I6pdBY1EthSqDmJkiNk3JIT8cswwR9nfeW/cPdUagJYEQG7R95WRH74wpz7ma8Gh/9dI9FP+OU+0E4FvtA55w==}
@ -6106,7 +6117,7 @@ packages:
nitropack: 2.4.1 nitropack: 2.4.1
nuxi: 3.5.2 nuxi: 3.5.2
nypm: 0.2.0 nypm: 0.2.0
ofetch: 1.0.1 ofetch: 1.1.0
ohash: 1.1.2 ohash: 1.1.2
pathe: 1.1.0 pathe: 1.1.0
perfect-debounce: 1.0.0 perfect-debounce: 1.0.0
@ -6200,11 +6211,11 @@ packages:
es-abstract: 1.21.2 es-abstract: 1.21.2
dev: true dev: true
/ofetch@1.0.1: /ofetch@1.1.0:
resolution: {integrity: sha512-icBz2JYfEpt+wZz1FRoGcrMigjNKjzvufE26m9+yUiacRQRHwnNlGRPiDnW4op7WX/MR6aniwS8xw8jyVelF2g==} resolution: {integrity: sha512-yjq2ZUUMto1ITpge2J5vNlUfteLzxfHn9aJC55WtVGD3okKwSfPoLaKpcHXmmKd2kZZUGo+jdkFuuj09Blyeig==}
dependencies: dependencies:
destr: 1.2.2 destr: 1.2.2
node-fetch-native: 1.1.1 node-fetch-native: 1.2.0
ufo: 1.1.2 ufo: 1.1.2
/ohash@1.1.2: /ohash@1.1.2:
@ -7661,15 +7672,6 @@ packages:
engines: {node: '>=14.0.0'} engines: {node: '>=14.0.0'}
dev: true dev: true
/tinyws@0.1.0(ws@8.13.0):
resolution: {integrity: sha512-6WQ2FlFM7qm6lAXxeKnzsAEfmnBHz5W5EwonNs52V0++YfK1IoCCAWM429afcChFE9BFrDgOFnq7ligaWMsa/A==}
engines: {node: '>=12.4'}
peerDependencies:
ws: '>=8'
dependencies:
ws: 8.13.0
dev: false
/titleize@3.0.0: /titleize@3.0.0:
resolution: {integrity: sha512-KxVu8EYHDPBdUYdKZdKtU2aj2XfEx9AfjXxE/Aj0vT06w2icA09Vus1rh6eSu1y01akYg6BjIK/hxyLJINoMLQ==} resolution: {integrity: sha512-KxVu8EYHDPBdUYdKZdKtU2aj2XfEx9AfjXxE/Aj0vT06w2icA09Vus1rh6eSu1y01akYg6BjIK/hxyLJINoMLQ==}
engines: {node: '>=12'} engines: {node: '>=12'}
@ -7887,7 +7889,7 @@ packages:
consola: 3.1.0 consola: 3.1.0
defu: 6.1.2 defu: 6.1.2
mime: 3.0.0 mime: 3.0.0
node-fetch-native: 1.1.1 node-fetch-native: 1.2.0
pathe: 1.1.0 pathe: 1.1.0
/unhead@1.1.27: /unhead@1.1.27:
@ -8064,8 +8066,8 @@ packages:
listhen: 1.0.4 listhen: 1.0.4
lru-cache: 9.1.1 lru-cache: 9.1.1
mri: 1.2.0 mri: 1.2.0
node-fetch-native: 1.1.1 node-fetch-native: 1.2.0
ofetch: 1.0.1 ofetch: 1.1.0
ufo: 1.1.2 ufo: 1.1.2
transitivePeerDependencies: transitivePeerDependencies:
- supports-color - supports-color
@ -8152,6 +8154,14 @@ packages:
builtins: 5.0.1 builtins: 5.0.1
dev: true dev: true
/vite-hot-client@0.2.1(vite@4.3.9):
resolution: {integrity: sha512-UqsQdw5PODnSrTDT85nr09RlhV0gkm2Xat74U2l8JZ5R8M/wTCggWSyPjxbLk5fbbVnWfr0JwW+vVoosjQnYrA==}
peerDependencies:
vite: ^2.6.0 || ^3.0.0 || ^4.0.0
dependencies:
vite: 4.3.9(@types/node@20.2.5)(sass@1.62.1)
dev: false
/vite-node@0.31.2(@types/node@20.2.5)(sass@1.62.1): /vite-node@0.31.2(@types/node@20.2.5)(sass@1.62.1):
resolution: {integrity: sha512-NvoO7+zSvxROC4JY8cyp/cO7DHAX3dwMOHQVDdNtCZ4Zq8wInnR/bJ/lfsXqE6wrUgtYCE5/84qHS+A7vllI3A==} resolution: {integrity: sha512-NvoO7+zSvxROC4JY8cyp/cO7DHAX3dwMOHQVDdNtCZ4Zq8wInnR/bJ/lfsXqE6wrUgtYCE5/84qHS+A7vllI3A==}
engines: {node: '>=v14.18.0'} engines: {node: '>=v14.18.0'}

View File

@ -1,3 +1,3 @@
export const PATH = '/__nuxt_mongoose__' export const PATH = '/__nuxt_mongoose__'
export const PATH_ENTRY = `${PATH}/entry`
export const PATH_CLIENT = `${PATH}/client` export const PATH_CLIENT = `${PATH}/client`
export const WS_EVENT_NAME = 'nuxt:devtools:mongoose:rpc'

View File

@ -2,17 +2,19 @@ import {
addImportsDir, addImportsDir,
addServerPlugin, addServerPlugin,
addTemplate, addTemplate,
addVitePlugin,
createResolver, createResolver,
defineNuxtModule, defineNuxtModule,
logger, logger,
} from '@nuxt/kit' } from '@nuxt/kit'
import { pathExists } from 'fs-extra' import { pathExists } from 'fs-extra'
import { tinyws } from 'tinyws'
import { join } from 'pathe' import { join } from 'pathe'
import { defu } from 'defu' import { defu } from 'defu'
import sirv from 'sirv' import sirv from 'sirv'
import { $fetch } from 'ofetch'
import { version } from '../package.json'
import { PATH_CLIENT, PATH_ENTRY } from './constants' import { PATH_CLIENT } from './constants'
import type { ModuleOptions } from './types' import type { ModuleOptions } from './types'
import { setupRPC } from './server-rpc' import { setupRPC } from './server-rpc'
@ -34,6 +36,13 @@ export default defineNuxtModule<ModuleOptions>({
const { resolve } = createResolver(import.meta.url) const { resolve } = createResolver(import.meta.url)
const runtimeConfig = nuxt.options.runtimeConfig const runtimeConfig = nuxt.options.runtimeConfig
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(() => {})
}
addImportsDir(resolve('./runtime/composables')) addImportsDir(resolve('./runtime/composables'))
if (!options.uri) { if (!options.uri) {
@ -58,11 +67,11 @@ export default defineNuxtModule<ModuleOptions>({
} }
const clientPath = distResolve('./client') const clientPath = distResolve('./client')
const { middleware: rpcMiddleware } = setupRPC(nuxt, options) const { vitePlugin } = setupRPC(nuxt, options)
addVitePlugin(vitePlugin)
nuxt.hook('vite:serverCreated', async (server) => { 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)) if (await pathExists(clientPath))
server.middlewares.use(PATH_CLIENT, sirv(clientPath, { dev: true, single: true })) server.middlewares.use(PATH_CLIENT, sirv(clientPath, { dev: true, single: true }))
}) })

View File

@ -11,7 +11,7 @@ export async function defineMongooseConnection({ uri, options }: { uri?: string;
try { try {
await mongoose.connect(mongooseUri, { ...mongooseOptions }) await mongoose.connect(mongooseUri, { ...mongooseOptions })
logger.info('Connected to mongoose database') logger.info('Connected to MONGODB')
} }
catch (err) { catch (err) {
logger.error('Error connecting to database', err) logger.error('Error connecting to database', err)

View File

@ -1,12 +1,12 @@
import type { TinyWSRequest } from 'tinyws'
import type { NodeIncomingMessage, NodeServerResponse } from 'h3'
import type { WebSocket } from 'ws' import type { WebSocket } from 'ws'
import { createBirpcGroup } from 'birpc' import { createBirpcGroup } from 'birpc'
import type { ChannelOptions } from 'birpc' import type { ChannelOptions } from 'birpc'
import { parse, stringify } from 'flatted' import { parse, stringify } from 'flatted'
import type { Plugin } from 'vite'
import type { Nuxt } from 'nuxt/schema' import type { Nuxt } from 'nuxt/schema'
import type { ClientFunctions, ModuleOptions, NuxtDevtoolsServerContext, ServerFunctions } from '../types' import type { ClientFunctions, ModuleOptions, NuxtDevtoolsServerContext, ServerFunctions } from '../types'
import { WS_EVENT_NAME } from '../constants'
import { setupDatabaseRPC } from './database' import { setupDatabaseRPC } from './database'
import { setupResourceRPC } from './resource' import { setupResourceRPC } from './resource'
@ -68,36 +68,50 @@ export function setupRPC(nuxt: Nuxt, options: ModuleOptions): any {
} satisfies Partial<ServerFunctions>) } satisfies Partial<ServerFunctions>)
const wsClients = new Set<WebSocket>() const wsClients = new Set<WebSocket>()
const middleware = async (req: NodeIncomingMessage & TinyWSRequest, _res: NodeServerResponse, next: Function) => {
// Handle WebSocket const vitePlugin: Plugin = {
if (req.ws) { name: 'nuxt:devtools:rpc',
const ws = await req.ws() configureServer(server) {
wsClients.add(ws) server.ws.on('connection', (ws) => {
const channel: ChannelOptions = { wsClients.add(ws)
post: d => ws.send(d), const channel: ChannelOptions = {
on: fn => ws.on('message', fn), post: d => ws.send(JSON.stringify({
serialize: stringify, type: 'custom',
deserialize: parse, event: WS_EVENT_NAME,
} data: d,
rpc.updateChannels((c) => { })),
c.push(channel) on: (fn) => {
}) ws.on('message', (e) => {
ws.on('close', () => { try {
wsClients.delete(ws) const data = JSON.parse(String(e)) || {}
if (data.type === 'custom' && data.event === WS_EVENT_NAME) {
// console.log(data.data)
fn(data.data)
}
}
catch {}
})
},
serialize: stringify,
deserialize: parse,
}
rpc.updateChannels((c) => { rpc.updateChannels((c) => {
const index = c.indexOf(channel) c.push(channel)
if (index >= 0) })
c.splice(index, 1) ws.on('close', () => {
wsClients.delete(ws)
rpc.updateChannels((c) => {
const index = c.indexOf(channel)
if (index >= 0)
c.splice(index, 1)
})
}) })
}) })
} },
else {
next()
}
} }
return { return {
middleware, vitePlugin,
...ctx, ...ctx,
} }
} }

View File

@ -5,6 +5,8 @@ import { generateApiRoute, generateSchemaFile } from '../utils/schematics'
import { capitalize, pluralize, singularize } from '../utils/formatting' import { capitalize, pluralize, singularize } from '../utils/formatting'
export function setupResourceRPC({ nuxt, rpc }: NuxtDevtoolsServerContext): any { export function setupResourceRPC({ nuxt, rpc }: NuxtDevtoolsServerContext): any {
const runtimeConfig = nuxt.options.runtimeConfig
return { return {
// TODO: maybe separate functions // TODO: maybe separate functions
async generateResource(collection: Collection, resources: Resource[]) { async generateResource(collection: Collection, resources: Resource[]) {
@ -13,9 +15,9 @@ export function setupResourceRPC({ nuxt, rpc }: NuxtDevtoolsServerContext): any
const dbName = capitalize(singular) const dbName = capitalize(singular)
if (collection.fields) { if (collection.fields) {
const schemaPath = resolve(nuxt.options.serverDir, 'utils/models', `${singular}.schema.ts`) const schemaPath = resolve(nuxt.options.serverDir, runtimeConfig.mongoose.modelsDir, `${singular}.schema.ts`)
if (!fs.existsSync(schemaPath)) { if (!fs.existsSync(schemaPath)) {
fs.ensureDirSync(resolve(nuxt.options.serverDir, 'utils/models')) fs.ensureDirSync(resolve(nuxt.options.serverDir, runtimeConfig.mongoose.modelsDir))
fs.writeFileSync(schemaPath, generateSchemaFile(dbName, collection.fields)) fs.writeFileSync(schemaPath, generateSchemaFile(dbName, collection.fields))
} }
@ -51,7 +53,7 @@ export function setupResourceRPC({ nuxt, rpc }: NuxtDevtoolsServerContext): any
async resourceSchema(collection: string) { async resourceSchema(collection: string) {
// TODO: use magicast // TODO: use magicast
const singular = singularize(collection).toLowerCase() const singular = singularize(collection).toLowerCase()
const schemaPath = resolve(nuxt.options.serverDir, 'utils/models', `${singular}.schema.ts`) const schemaPath = resolve(nuxt.options.serverDir, runtimeConfig.mongoose.modelsDir, `${singular}.schema.ts`)
if (fs.existsSync(schemaPath)) { if (fs.existsSync(schemaPath)) {
const content = fs.readFileSync(schemaPath, 'utf-8').match(/schema: \{(.|\n)*\}/g) const content = fs.readFileSync(schemaPath, 'utf-8').match(/schema: \{(.|\n)*\}/g)
if (content) { if (content) {