directus/rstore/rstore-vite-monospace

Rstore Vite Monospace

Use @rstore/vite-monospace to generate Monospace-backed rstore schema and plugin modules in a non-Nuxt Vite app.

Setup

Register the Vite plugin in vite.config.ts:

import { rstoreMonospace } from '@rstore/vite-monospace'
import { defineConfig } from 'vite'
export default defineConfig({
  plugins: [
    rstoreMonospace({
      url: 'https://your-monospace-instance.com',
      workspace: 'your-workspace',
      schemaApiKey: process.env.MONOSPACE_API_KEY,
      scopeId: 'rstore-monospace',
    }),
  ],
})

Then create the store from the generated virtual module:

import { createStore, RstorePlugin } from '@rstore/vue'
import { monospacePlugin, schema } from 'virtual:rstore-monospace'
const store = await createStore({
  schema,
  plugins: [monospacePlugin],
})
app.use(RstorePlugin, { store })

Options

Virtual Modules

• virtual:rstore-monospace re-exports schema, monospace, and monospacePlugin.
• virtual:rstore-monospace/schema exports the generated rstore schema.
• virtual:rstore-monospace/plugin exports the Monospace REST client and rstore plugin.

Local Schema Mode

Use input plus metadataInput when the schema is checked into the project or generated separately. The metadata snapshot holds the Monospace schema meta collection items keyed by collection name; write it from loadRemoteSchemaMetadata (@rstore/monospace/schema):

rstoreMonospace({
  input: './openapi.json',
  metadataInput: './schema-metadata.json',
})

With only one local file, the other schema source is loaded remotely and url/workspace are required.

Guardrails

1. Keep schemaApiKey build-time only; it must not appear in generated virtual modules.
2. Configure runtimeApiKey only when the key is safe to emit into runtime/client code.
3. Do not hand-write replacement schema or plugin virtual modules; fix generator input/config instead.
4. Use the generated schema and monospacePlugin together in the same store.
5. Use rstore-monospace for OpenAPI, REST, query, and mutation behavior.
6. Use rstore-vue for component query/form/cache patterns.