22 Commits

Author SHA1 Message Date
0f73464afe chore: update dependencies 2023-09-21 16:41:21 -06:00
5bf554fbdf chore(release): v1.0.1 2023-09-20 20:19:25 +03:00
b566196c96 chore(release): v1.0.0 2023-09-20 19:54:06 +03:00
4da24986ee chore(release): v1.0.0 2023-09-20 19:53:01 +03:00
ced2c77427 chore(release): v1.1.0 2023-09-20 19:48:51 +03:00
431d3784fe feat: version 1.0.0 (#21) 2023-09-20 19:47:07 +03:00
033380e051 chore(release): v0.0.9 2023-09-20 05:21:24 +03:00
0db6bddbc4 docs: update docus 2023-07-17 16:18:50 +03:00
0dfad07399 chore(release): v0.0.9 2023-07-09 14:39:55 +03:00
e6b8b7d0fa chore: fix tsconfig for build time 2023-07-09 14:39:02 +03:00
0cdba0d764 chore: lint 2023-07-09 14:27:10 +03:00
9c0e0baf95 docs: add types link 2023-07-09 14:21:33 +03:00
925d382f2f chore: update dependencies 2023-07-09 14:16:21 +03:00
3ff97569f5 docs(utils): fix model options type 2023-07-09 14:10:34 +03:00
52a5ae9180 Merge branch 'main' of https://github.com/arashsheyda/nuxt-mongoose 2023-07-09 14:08:23 +03:00
4647fbda16 Revert "chore: fix defineNitroPlugin patch (#9)"
This reverts commit 470f272183.
2023-07-09 14:08:05 +03:00
647d26db85 docs(utils): add hooks and improve documentation 2023-07-09 13:53:11 +03:00
40b8ca91ee chore: example env 2023-07-09 13:28:28 +03:00
d92a58b2ad feat: mongoose schema hooks 2023-07-09 13:25:38 +03:00
5a43ebe06f fix: update connection message in logger (#10) 2023-07-02 12:36:48 +03:00
56259adaf7 feat: add possibility to type mongoose model (#8)
Co-authored-by: Arash <38922203+arashsheyda@users.noreply.github.com>
2023-07-02 11:55:49 +03:00
470f272183 chore: fix defineNitroPlugin patch (#9) 2023-06-28 23:15:30 +03:00
48 changed files with 7775 additions and 4920 deletions

View File

@ -1,2 +1,5 @@
dist
node_modules
docs
.github
.vscode

1
.github/FUNDING.yml vendored Normal file
View File

@ -0,0 +1 @@
github: [arashsheyda]

View File

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

View File

@ -1,3 +0,0 @@
{
"editor.tabSize": 2,
}

View File

@ -1,6 +1,56 @@
# Changelog
## 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)

View File

@ -5,6 +5,7 @@ import './styles/global.css'
<template>
<Html>
<Body h-screen>
<Notification />
<NuxtLayout>
<NuxtPage />
</NuxtLayout>

View File

@ -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>

View File

@ -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,10 +119,8 @@ 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
@ -126,7 +128,7 @@ const formattedFields = computed(() => {
})
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
},
@ -247,7 +250,7 @@ const toggleSchema = computed({
</div>
<div flex justify-center gap2>
<NIconButton icon="carbon-add" n="cyan" @click="addField(index)" />
<NIconButton icon="carbon-delete" n="red" @click="removeField(index)" />
<NIconButton icon="carbon-trash-can" n="red" @click="removeField(index)" />
</div>
</div>
</div>
@ -257,5 +260,3 @@ const toggleSchema = computed({
</NButton>
</div>
</template>
<style></style>

View File

@ -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,7 +84,9 @@ 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)
@ -87,7 +94,7 @@ async function saveDocument(document: any, create = true) {
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 })
@ -105,7 +112,7 @@ 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
@ -170,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" />
<NIconButton title="Save" icon="carbon-save" @click="saveDocument(selectedDocument, false)" />
<NIconButton title="Cancel" icon="carbon-close" @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))" />
<NIconButton title="Edit" icon="carbon-edit" @click="editDocument(document)" />
<NIconButton title="Delete" icon="carbon-trash-can" @click="deleteDocument(document)" />
<NIconButton title="Duplicate" icon="carbon-document-multiple-02" @click="saveDocument(document)" />
<NIconButton title="Copy" n="xs" absolute right-4 opacity-0 group-hover="opacity-100" transition-all icon="carbon-copy" @click="copy(JSON.stringify(document))" />
</template>
</div>
</td>
@ -190,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">
<NIconButton title="Save" icon="carbon-save" @click="saveDocument(selectedDocument)" />
<NIconButton title="Cancel" icon="carbon-close" @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>
@ -205,11 +212,6 @@ const copy = useCopy()
</template>
<style lang="scss">
// TODO:
.actions .n-icon {
margin: 0;
}
table {
table-layout: fixed;
tr {

View File

@ -1,4 +1,7 @@
<script setup lang="ts">
import { ref } from 'vue'
import { onClickOutside, useElementSize } from '@vueuse/core'
const props = defineProps<{
modelValue?: boolean
navbar?: HTMLElement
@ -17,7 +20,7 @@ onClickOutside(el, () => {
if (props.modelValue && props.autoClose)
emit('close')
}, {
ignore: ['#open-drawer-right'],
ignore: ['a', 'button', 'summary', '[role="dialog"]'],
})
</script>
@ -41,7 +44,7 @@ export default {
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
absolute bottom-0 right-0 z-10 z-20 of-auto text-sm glass-effect
:style="{ top: `${top}px` }"
v-bind="$attrs"
>

View File

@ -0,0 +1,34 @@
<script setup lang='ts'>
const show = ref(false)
const icon = ref<string | undefined>()
const text = ref<string | undefined>()
const classes = ref<string | undefined>()
provideNotificationFn((data) => {
text.value = data.message
icon.value = data.icon
classes.value = data.classes ?? 'text-green'
show.value = true
setTimeout(() => {
show.value = false
}, data.duration ?? 1500)
})
</script>
<template>
<div
fixed left-0 right-0 top-0 z-999 text-center
:class="show ? '' : 'pointer-events-none overflow-hidden'"
>
<div
border="~ base"
flex="~ inline gap2"
m-3 inline-block items-center rounded px-4 py-1 transition-all duration-300 bg-base
:style="show ? {} : { transform: 'translateY(-300%)' }"
:class="[show ? 'shadow' : 'shadow-none', classes]"
>
<div v-if="icon" :class="icon" />
<div>{{ text }}</div>
</div>
</div>
</template>

View File

@ -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>

View File

@ -0,0 +1,33 @@
<script lang="ts" setup>
import { computed, ref } from 'vue'
import { Pane, Splitpanes } from 'splitpanes'
import 'splitpanes/dist/splitpanes.css'
const props = defineProps<{
storageKey?: string
leftSize?: number
minSize?: number
}>()
const DEFAULT = 30
const state = ref()
const key = props.storageKey
const size = key
? computed({
get: () => state.value[key] || props.leftSize || DEFAULT,
set: (v) => { state.value[key] = v },
})
: ref(props.leftSize || DEFAULT)
</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="$slots.right ? (minSize || 10) : 100">
<slot name="left" />
</Pane>
<Pane v-if="$slots.right" relative h-full class="of-auto!" :min-size="minSize || 10">
<slot name="right" />
</Pane>
</Splitpanes>
</template>

View File

@ -0,0 +1,14 @@
let _showNotification: typeof showNotification
export function showNotification(data: {
message: string
icon?: string
classes?: string
duration?: number
}) {
_showNotification?.(data)
}
export function provideNotificationFn(fn: typeof showNotification) {
_showNotification = fn
}

View File

@ -1,10 +1,14 @@
import { useClipboard } from '@vueuse/core'
import { showNotification } from './dialog'
export function useCopy() {
const clipboard = useClipboard()
return (text: string) => {
clipboard.copy(text)
// TODO: show toast
showNotification({
message: 'Copied to clipboard',
icon: 'carbon-copy',
})
}
}

View File

@ -1,58 +1,18 @@
import { createBirpc } from 'birpc'
import { parse, stringify } from 'flatted'
import { createHotContext } from 'vite-hot-client'
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 { WS_EVENT_NAME } from '../../src/constants'
import { RPC_NAMESPACE } from '../../src/constants'
export const wsConnecting = ref(true)
export const wsError = ref<any>()
export const wsConnectingDebounced = useDebounce(wsConnecting, 2000)
export const devtools = ref<NuxtDevtoolsClient>()
export const devtoolsRpc = ref<NuxtDevtoolsClient['rpc']>()
export const rpc = ref<BirpcReturn<ServerFunctions, ClientFunctions>>()
const connectPromise = connectVite()
let onMessage: Function = () => {}
onDevtoolsClientConnected(async (client) => {
devtoolsRpc.value = client.devtools.rpc
devtools.value = client.devtools
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(WS_EVENT_NAME, 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)
},
timeout: 120_000,
})
async function connectVite() {
const hot = await createHotContext()
if (!hot)
throw new Error('Unable to connect to devtools')
hot.on(WS_EVENT_NAME, (data) => {
onMessage(data)
rpc.value = client.devtools.extendClientRpc<ServerFunctions, ClientFunctions>(RPC_NAMESPACE, {
})
// TODO:
// hot.on('vite:connect', (data) => {})
// hot.on('vite:disconnect', (data) => {})
return hot
}
})

View File

@ -0,0 +1 @@
export const selectedCollection = useState('mongo:collection', () => '')

View File

@ -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>

View File

@ -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,
},
})

View File

@ -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,28 +20,23 @@ 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">
<SplitPanel :min-left="13" :max-left="20">
<template #left>
<div px4>
<Navbar v-model:search="search" :placeholder="`${collections?.length ?? '-'} collection in total`" mt2>
@ -48,13 +47,20 @@ async function refresh() {
</div>
</Navbar>
<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 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 block n="red" icon="carbon-trash-can" @click="dropCollection(table)" />
<!-- <NIconButton icon="carbon-overflow-menu-horizontal" /> -->
</div>
</NuxtLink>
@ -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">
</SplitPanel>
<Drawer v-model="drawer" style="width: calc(80.5%);" auto-close @close="drawer = false">
<CreateResource @refresh="refresh" />
</DrawerRight>
</Drawer>
</template>

View File

@ -12,12 +12,16 @@ This function creates a new Mongoose model with schema. Example usage:
export const User = defineMongooseModel({
name: 'User',
schema: {
name: {
type: String,
email: {
type: 'string',
required: true,
unique: true,
},
},
options: {
},
hooks(schema) {
},
})
@ -27,11 +31,14 @@ This function creates a new Mongoose model with schema. Example usage:
import { defineMongooseModel } from '#nuxt/mongoose'
export const User = defineMongooseModel('User', {
name: {
type: String,
email: {
type: 'string',
required: true,
unique: true,
},
}, {
}, (schema) => {
})
```
@ -39,6 +46,16 @@ This function creates a new Mongoose model with schema. Example usage:
::
| **Key** | **Type** | **Require** | **Description** |
| ---------------------------- | ----------- | ----------- | ----- |
| `name` | `string` | true | Name of Model |
| `schema` | [`SchemaDefinition`](https://mongoosejs.com/docs/schematypes.html) | true | Schema Definition of Model |
| `options` | [`SchemaOptions`](https://mongoosejs.com/docs/guide.html#options) | false | Schema Options for Model |
| `hooks` | [`(schema: Schema<T>) => void`](https://mongoosejs.com/docs/middleware.html) | false | Schema Hooks Function to customize Model |
## `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).
@ -49,4 +66,4 @@ Example usage:
import { defineMongooseConnection } from '#nuxt/mongoose'
export const connection = defineMongooseConnection('mongodb://127.0.0.1/nuxt-mongoose')
```
```

View File

@ -10,8 +10,8 @@
"lint": "eslint ."
},
"devDependencies": {
"@nuxt-themes/docus": "^1.12.0",
"@nuxthq/studio": "^0.13.2",
"nuxt": "^3.5.0"
"@nuxt-themes/docus": "^1.14.3",
"@nuxthq/studio": "^0.13.4",
"nuxt": "^3.6.3"
}
}

2507
docs/pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -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)

View File

@ -1,69 +1,76 @@
{
"name": "nuxt-mongoose",
"type": "module",
"version": "0.0.8",
"version": "1.0.1",
"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://nuxt-mongoose.nuxt.space",
"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"
}
},
"main": "./module.cjs",
"build": {
"externals": [
"ofetch"
]
},
"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",
"@nuxt/devtools-kit": "^0.8.4",
"@nuxt/devtools-ui-kit": "^0.8.4",
"@nuxt/kit": "^3.7.3",
"@vueuse/core": "^10.4.1",
"defu": "^6.1.2",
"flatted": "^3.2.7",
"fs-extra": "^11.1.1",
"mongoose": "^7.2.2",
"ofetch": "^1.1.0",
"pathe": "^1.1.0",
"mongoose": "^7.5.2",
"ofetch": "^1.3.3",
"pathe": "^1.1.1",
"pluralize": "^8.0.0",
"sirv": "^2.0.3",
"vite-hot-client": "^0.2.1",
"ws": "^8.13.0"
"sirv": "^2.0.3"
},
"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": "^0.43.0",
"@nuxt/module-builder": "^0.5.1",
"@types/fs-extra": "^11.0.2",
"@types/pluralize": "^0.0.30",
"changelogen": "^0.5.5",
"eslint": "8.49.0",
"nuxt": "^3.7.3",
"sass": "^1.67.0",
"sass-loader": "^13.3.2",
"splitpanes": "^3.1.5"
}
}
}

1
playground/.env.example Normal file
View File

@ -0,0 +1 @@
MONGODB_URI="mongodb://localhost:27017/nuxt-mongoose"

View File

@ -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',
},
)
},
}),
],
})

View File

@ -0,0 +1,5 @@
export default defineEventHandler(async () => {
return {
message: 'hi',
}
})

View File

@ -7,10 +7,20 @@ export const UserSchema = defineMongooseModel({
type: 'string',
required: true,
},
slug: {
email: {
type: 'string',
required: true,
unique: false,
},
password: {
type: 'string',
required: true,
unique: true,
},
},
hooks(schema) {
schema.pre('save', function (this, next) {
this.password = `hash.${this.password}.${Math.random()}`
next()
})
},
})

View File

@ -0,0 +1,3 @@
{
"extends": "../.nuxt/tsconfig.server.json"
}

8953
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -1,3 +1,3 @@
export const PATH = '/__nuxt_mongoose__'
export const PATH_CLIENT = `${PATH}/client`
export const WS_EVENT_NAME = 'nuxt:devtools:mongoose:rpc'
export const CLIENT_PATH = '/__nuxt-mongoose'
export const CLIENT_PORT = 3300
export const RPC_NAMESPACE = 'nuxt-mongoose-rpc'

56
src/devtools.ts Normal file
View 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)
})
}

View File

@ -1,25 +1,46 @@
import {
addImportsDir,
addServerPlugin,
addTemplate,
addVitePlugin,
createResolver,
defineNuxtModule,
logger,
} from '@nuxt/kit'
import { pathExists } from 'fs-extra'
import type { ConnectOptions } from 'mongoose'
import defu from 'defu'
import { join } from 'pathe'
import { defu } from 'defu'
import sirv from 'sirv'
import { $fetch } from 'ofetch'
import { version } from '../package.json'
import { setupDevToolsUI } from './devtools'
import { PATH_CLIENT } 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: {
@ -27,15 +48,13 @@ 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
async setup(options, nuxt) {
if (nuxt.options.dev) {
$fetch('https://registry.npmjs.org/nuxt-mongoose/latest').then((release) => {
if (release.version > version)
@ -43,62 +62,35 @@ export default defineNuxtModule<ModuleOptions>({
}).catch(() => {})
}
addImportsDir(resolve('./runtime/composables'))
if (!options.uri) {
logger.warn('Missing `MONGODB_URI` in `.env`')
logger.warn('Missing MongoDB URI. You can set it in your `nuxt.config` or in your `.env` as `MONGODB_URI`')
return
}
// Runtime Config
runtimeConfig.mongoose = defu(runtimeConfig.mongoose || {}, {
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 { vitePlugin } = setupRPC(nuxt, options)
addVitePlugin(vitePlugin)
nuxt.hook('vite:serverCreated', async (server) => {
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({
@ -115,15 +107,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'))

View File

@ -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
View 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')
},
}
}

View File

@ -1,23 +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, rpc }: NuxtDevtoolsServerContext): any {
const runtimeConfig = nuxt.options.runtimeConfig
export function setupResourceRPC({ nuxt }: DevtoolsServerContext): any {
const config = nuxt.options.runtimeConfig.mongoose
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, runtimeConfig.mongoose.modelsDir, `${singular}.schema.ts`)
const schemaPath = join(config.modelsDir, `${singular}.schema.ts`)
if (!fs.existsSync(schemaPath)) {
fs.ensureDirSync(resolve(nuxt.options.serverDir, runtimeConfig.mongoose.modelsDir))
fs.ensureDirSync(config.modelsDir)
fs.writeFileSync(schemaPath, generateSchemaFile(dbName, collection.fields))
}
@ -36,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)
}
@ -46,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, runtimeConfig.mongoose.modelsDir, `${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) {

View File

@ -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

View File

@ -1 +1,50 @@
export { defineMongooseConnection, defineMongooseModel } from './mongoose'
import { logger } from '@nuxt/kit'
import mongoose from 'mongoose'
import type { ConnectOptions, Model, SchemaDefinition, SchemaOptions } from 'mongoose'
import { useRuntimeConfig } from '#imports'
export async function defineMongooseConnection({ uri, options }: { uri?: string; options?: ConnectOptions } = {}): Promise<void> {
// TODO: types
const config = useRuntimeConfig().mongoose
const mongooseUri = uri || config.uri
const mongooseOptions = options || config.options
try {
await mongoose.connect(mongooseUri, { ...mongooseOptions })
logger.success('Connected to `MongoDB`')
}
catch (err) {
logger.error('Error connecting to `MongoDB`', err)
}
}
export function defineMongooseModel<T>(
nameOrOptions: string | {
name: string
schema: SchemaDefinition
options?: SchemaOptions
hooks?: (schema: mongoose.Schema<T>) => void
},
schema?: SchemaDefinition,
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)
}

View File

@ -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 MONGODB')
}
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)
}

View File

@ -1,117 +0,0 @@
import type { WebSocket } from 'ws'
import { createBirpcGroup } from 'birpc'
import type { ChannelOptions } from 'birpc'
import { parse, stringify } from 'flatted'
import type { Plugin } from 'vite'
import type { Nuxt } from 'nuxt/schema'
import type { ClientFunctions, ModuleOptions, NuxtDevtoolsServerContext, ServerFunctions } from '../types'
import { WS_EVENT_NAME } from '../constants'
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 vitePlugin: Plugin = {
name: 'nuxt:devtools:rpc',
configureServer(server) {
server.ws.on('connection', (ws) => {
wsClients.add(ws)
const channel: ChannelOptions = {
post: d => ws.send(JSON.stringify({
type: 'custom',
event: WS_EVENT_NAME,
data: d,
})),
on: (fn) => {
ws.on('message', (e) => {
try {
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) => {
c.push(channel)
})
ws.on('close', () => {
wsClients.delete(ws)
rpc.updateChannels((c) => {
const index = c.indexOf(channel)
if (index >= 0)
c.splice(index, 1)
})
})
})
},
}
return {
vitePlugin,
...ctx,
}
}

View File

@ -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
}

View File

@ -1,8 +0,0 @@
import type { ConnectOptions } from 'mongoose'
export interface ModuleOptions {
uri: string
devtools: boolean
options?: ConnectOptions
modelsDir?: string
}

View File

@ -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
}

View File

@ -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>
}

View File

@ -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)
}

View File

@ -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)

View File

@ -1,3 +1,3 @@
{
"extends": "./client/.nuxt/tsconfig.json"
"extends": "./playground/.nuxt/tsconfig.json"
}