refactor(studio): move main logic in runtime

Author: larbish

src/runtime/components/StudioPreviewMode.vue

@@ -1,7 +1,7 @@
 <script setup lang="ts">
 import { onMounted, ref, onUnmounted } from 'vue'
 import type { Socket } from 'socket.io-client'
-import type { DraftSyncData } from '../../types/studio'
+import type { DraftSyncData } from '@nuxt/content'
 import { useCookie, useNuxtApp, useRouter } from '#app'
 
 const props = defineProps({

src/runtime/internal/schema.ts

@@ -0,0 +1,11 @@
+import type { ZodRawShape } from 'zod'
+
+export function getOrderedSchemaKeys(shape: ZodRawShape) {
+  const keys = new Set([
+    shape.id ? 'id' : undefined,
+    shape.title ? 'title' : undefined,
+    ...Object.keys(shape).sort(),
+  ].filter(Boolean))
+
+  return Array.from(keys) as string[]
+}

src/utils/studio/collection.ts renamed to src/runtime/internal/studio/collection.ts

@@ -1,5 +1,5 @@
 import micromatch from 'micromatch'
-import type { CollectionInfo } from '../../types/collection'
+import type { CollectionInfo } from '@nuxt/content'
 import { getOrderedSchemaKeys } from '../schema'
 import { withoutRoot } from './files'
 

src/utils/studio/compatibility.ts renamed to src/runtime/internal/studio/compatibility.ts

@@ -1,5 +1,4 @@
-import type { CollectionInfo } from '../../types/collection'
-import type { DraftSyncFile } from '../../types/studio'
+import type { CollectionInfo, DraftSyncFile } from '@nuxt/content'
 
 export const v2ToV3ParsedFile = (file: DraftSyncFile, collection: CollectionInfo) => {
   const mappedFile: Record<string, unknown> = {

src/utils/studio/files.ts renamed to src/runtime/internal/studio/files.ts

@@ -1,13 +1,12 @@
 import { createApp } from 'vue'
 import type { AppConfig } from 'nuxt/schema'
-import type { CollectionInfo } from '@nuxt/content'
+import type { CollectionInfo, FileChangeMessagePayload, FileMessageData, FileSelectMessagePayload, DraftSyncData, PreviewFile, DraftSyncFile } from '@nuxt/content'
 import { withLeadingSlash } from 'ufo'
-import StudioPreviewMode from '../components/StudioPreviewMode.vue'
-import { FileMessageType, type FileChangeMessagePayload, type FileMessageData, type FileSelectMessagePayload, type DraftSyncData, type PreviewFile, type DraftSyncFile } from '../../types/studio'
-import { createSingleton, deepAssign, deepDelete, defu, generateStemFromPath, mergeDraft, StudioConfigFiles, withoutRoot } from '../../utils/studio'
-import { loadDatabaseAdapter } from '../internal/database.client'
-import { getCollectionByPath, generateCollectionInsert, generateRecordDeletion, generateRecordSelectByColumn, generateRecordUpdate } from '../../utils/studio/collection'
-import { v2ToV3ParsedFile } from '../../utils/studio/compatibility'
+import StudioPreviewMode from '../../components/StudioPreviewMode.vue'
+import { loadDatabaseAdapter } from '../database.client'
+import { v2ToV3ParsedFile } from './compatibility'
+import { getCollectionByPath, generateCollectionInsert, generateRecordDeletion, generateRecordSelectByColumn, generateRecordUpdate } from './collection'
+import { createSingleton, deepAssign, deepDelete, defu, generateStemFromPath, mergeDraft, StudioConfigFiles, withoutRoot } from './utils'
 import { callWithNuxt, refreshNuxtData } from '#app'
 import { useAppConfig, useNuxtApp, useRuntimeConfig, useRoute, useRouter, ref } from '#imports'
 import { collections } from '#content/studio'
@@ -131,12 +130,12 @@ export function initIframeCommunication() {
     const { type, payload = {}, navigate } = e.data || {}
 
     switch (type) {
-      case FileMessageType.FileSelected: {
+      case 'nuxt-studio:editor:file-selected': {
         await handleFileSelection((payload as FileSelectMessagePayload).path)
         break
       }
-      case FileMessageType.FileChanged:
-      case FileMessageType.MediaChanged: {
+      case 'nuxt-studio:editor:file-changed':
+      case 'nuxt-studio:editor:media-changed': {
         const { additions = [], deletions = [] } = payload as FileChangeMessagePayload
         for (const addition of additions) {
           await handleFileUpdate(addition, navigate)
@@ -148,7 +147,7 @@ export function initIframeCommunication() {
         rerenderPreview()
         break
       }
-      case FileMessageType.ConfigFileChanged: {
+      case 'nuxt-studio:config:file-changed': {
         const { additions = [], deletions = [] } = payload as FileChangeMessagePayload
 
         const appConfig = additions.find(item => [StudioConfigFiles.appConfig, StudioConfigFiles.appConfigV4].includes(item.path))

src/runtime/internal/studio.ts renamed to src/runtime/internal/studio/index.ts

@@ -6,3 +6,4 @@ export type * from './query'
 export type * from './content'
 export type * from './tree'
 export type * from './database'
+export type * from './studio'

src/utils/studio/index.ts renamed to src/runtime/internal/studio/utils.ts

@@ -66,12 +66,7 @@ export interface FileSelectMessagePayload {
   path: string
 }
 
-export const enum FileMessageType {
-  FileSelected = 'nuxt-studio:editor:file-selected',
-  FileChanged = 'nuxt-studio:editor:file-changed',
-  MediaChanged = 'nuxt-studio:editor:media-changed',
-  ConfigFileChanged = 'nuxt-studio:config:file-changed',
-}
+export type FileMessageType = 'nuxt-studio:editor:file-selected' | 'nuxt-studio:editor:file-changed' | 'nuxt-studio:editor:media-changed' | 'nuxt-studio:config:file-changed'
 
 export interface FileMessageData {
   type: FileMessageType

src/types/index.ts

@@ -1,7 +1,8 @@
 import type { ZodObject, ZodOptionalDef, ZodRawShape, ZodStringDef, ZodType } from 'zod'
 import type { Collection, ResolvedCollection, CollectionSource, DefinedCollection, ResolvedCollectionSource } from '../types/collection'
+import { getOrderedSchemaKeys } from '../runtime/internal/schema'
 import { defineLocalSource, defineGitHubSource } from './source'
-import { getOrderedSchemaKeys, metaSchema, pageSchema } from './schema'
+import { metaSchema, pageSchema } from './schema'
 import type { ZodFieldType } from './zod'
 import { getUnderlyingType, ZodToSqlFieldTypes, z, getUnderlyingTypeName } from './zod'
 import { logger } from './dev'