refactor: Contentrain Nuxt JSON readme update and playground fix

- Playground için otomatik olarak oluşturulan tür tanımlarını kaldırma
- İçe aktarılan tür tanımlarını `#build/types/contentrain` olarak güncelleme
- Gereksiz bağımlılıkları `package.json` ve `pnpm-lock.yaml`'den çıkarma
- Sayfa bileşenlerinde tür güvenliğini ve veri erişimini iyileştirme

Author: ABB65

packages/nuxt-json/README.md

@@ -11,11 +11,12 @@
 ## Features
 
 - 🚀 **High Performance**: Optimized query engine and caching system
-- 🔒 **Type Safety**: Full TypeScript integration and type support
+- 🔒 **Type Safety**: Full TypeScript integration and automatic type generation
 - 🔄 **Relational Data**: Easily manage relationships between models
 - 🌐 **Multilingual Support**: Complete support for localized content
 - 📊 **Advanced Querying**: Filtering, sorting, and pagination capabilities
 - 🧩 **Seamless Integration**: Effortless integration with Nuxt.js
+- 🔄 **Automatic Type Generation**: TypeScript interfaces generated from your content models
 
 ## Installation
 
@@ -56,7 +57,8 @@ Query content in your pages or components:
 
 ```vue
 <script setup>
-import type { WorkItem } from '~/types'
+// Automatically generated types from your content models
+import type { WorkItem } from '#build/types/contentrain'
 
 // Basic query
 const workQuery = useContentrainQuery<WorkItem>('work-items')
@@ -229,7 +231,27 @@ const hasMore = query.hasMore
 
 ## Type Safety
 
-For full TypeScript integration, define your content types:
+### Automatic Type Generation
+
+The module automatically generates TypeScript types from your content models during the build process. These types are available in your project via the `#build/types/contentrain` import path:
+
+```ts
+// Import automatically generated types
+import type { Post, Author, Category } from '#build/types/contentrain'
+
+// Use the types in your queries
+const query = useContentrainQuery<Post>('posts')
+```
+
+The generated types include:
+- All model properties with correct types
+- Relation properties with proper typing
+- Multilingual support with language-specific types
+- Full IntelliSense support in your IDE
+
+### Manual Type Definitions
+
+You can also define your content types manually if needed:
 
 ```ts
 // types/content.ts
@@ -266,12 +288,12 @@ The main composable for querying content.
 - `modelId`: Model ID
 
 **Methods:**
-- `where(field, operator, value)`: Adds a filter
-- `orderBy(field, direction)`: Adds a sort
+- `where(field, operator, value)`: Adds a filter with type-safe field and value checking
+- `orderBy(field, direction)`: Adds a sort with type-safe field checking
 - `limit(limit)`: Limits the number of results
 - `offset(offset)`: Sets the starting index
-- `include(relation)`: Includes a relation
-- `locale(locale)`: Sets the language
+- `include(relation)`: Includes a relation with type-safe relation checking
+- `locale(locale)`: Sets the language with type-safe locale checking (only accepts valid locales defined in your model)
 - `get()`: Executes the query and returns the results
 - `first()`: Returns the first result
 - `count()`: Returns the total count
@@ -593,6 +615,36 @@ Query parameters are invalid.
 
 **Solution:** Ensure that your query parameters are in the correct format.
 
+### TypeScript Errors
+
+#### `Argument of type 'string' is not assignable to parameter of type 'never'`
+
+This error occurs when using the `locale()` method with a locale that is not defined in your model.
+
+**Solution:** Make sure you're using a locale that is defined in your model's `_lang` property. For example, if your model only supports 'en' and 'tr', you can only use these values with the `locale()` method.
+
+```ts
+// Correct usage
+query.locale('en') // Works if 'en' is defined in your model
+query.locale('tr') // Works if 'tr' is defined in your model
+
+// Incorrect usage
+query.locale('fr') // TypeScript error if 'fr' is not defined in your model
+```
+
+#### `Property '_relations' does not exist on type...`
+
+This error occurs when trying to access relations on a model that doesn't have any defined relations.
+
+**Solution:** Make sure your model has relations defined in its schema, or check if the relation is properly included in your query using the `include()` method.
+
+```ts
+// Make sure to include the relation before accessing it
+const query = useContentrainQuery<Post>('posts')
+  .include('author')
+  .get()
+```
+
 ## Contributing
 
 We welcome your contributions! Please read our [contribution guidelines](CONTRIBUTING.md).

playground/nuxt/package.json

@@ -12,10 +12,7 @@
     "clean": "rm -rf .output && rm -rf node_modules && rm -rf .nuxt "
   },
   "dependencies": {
-    "@contentrain/nuxt": "workspace:*",
     "@contentrain/nuxt-json": "workspace:*",
-    "@contentrain/query": "workspace:*",
-    "@contentrain/types-generator": "workspace:*",
     "@nuxtjs/tailwindcss": "^6.13.1",
     "nuxt": "^3.15.4",
     "unstorage": "^1.15.0",

playground/nuxt/pages/index.vue

@@ -1,60 +1,5 @@
 <script setup lang="ts">
-import type { Content, LocalizedContent, QueryResult } from '@contentrain/nuxt-json';
-
-interface IWorkItem extends LocalizedContent {
-    title: string
-    description: string
-    image: string
-    category: string
-    link: string
-    order: number
-    _lang: 'tr' | 'en'
-    _relations: {
-        category: IWorkCategory
-    }
-}
-
-interface IWorkCategory extends LocalizedContent {
-    category: string
-    order: number
-    _lang: 'tr' | 'en'
-}
-
-interface ITabItem extends LocalizedContent {
-    title: string
-    description: string
-    order: number
-    category: string
-    _lang: 'tr' | 'en'
-    _relations: {
-        category: IWorkCategory[]
-    }
-}
-
-interface ITestimonialItem extends LocalizedContent {
-    'name': string
-    'description': string
-    'title': string
-    'image': string
-    'creative-work': string
-    '_lang': 'tr' | 'en'
-    '_relations': {
-        'creative-work': IWorkItem
-    }
-}
-
-interface IFaqItem extends LocalizedContent {
-    question: string
-    answer: string
-    order: number
-    _lang: 'tr' | 'en'
-}
-
-interface ISocialLink extends Content {
-    icon: string
-    link: string
-    service: string
-}
+import type { FaqItems, SocialLinks, TabItems, TestimonialItems, WorkItems } from '#build/types/contentrain';
 
 // Debug için
 console.log('=== APP.VUE SETUP START ===');
@@ -80,24 +25,24 @@ const { data: pagedWorkItems } = await useAsyncData('paged-work-items', () =>
 
 // === 2. İlişki Sorguları ===
 // 2.1 Bire-Bir İlişki
-const { data: testimonials } = await useAsyncData<QueryResult<ITestimonialItem>>('testimonials', () =>
-    useContentrainQuery<ITestimonialItem>('testimonial-items')
+const { data: testimonials } = await useAsyncData('testimonials', () =>
+    useContentrainQuery<TestimonialItems>('testimonial-items')
         .locale('tr')
         .include('creative-work')
         .get());
 
 // 2.2 Bire-Çok İlişki
-const { data: tabItems } = await useAsyncData<QueryResult<ITabItem>>('tab-items', () =>
-    useContentrainQuery<ITabItem>('tabitems')
+const { data: tabItems } = await useAsyncData('tab-items', () =>
+    useContentrainQuery<TabItems>('tabitems')
         .locale('tr')
         .where('status', 'eq', 'publish')
         .include('category')
         .get());
 
 // === 3. Gelişmiş Sorgular ===
 // 3.1 Çoklu Filtreler
-const { data: advancedFilteredItems } = await useAsyncData<QueryResult<IWorkItem>>('advanced-filtered-items', () =>
-    useContentrainQuery<IWorkItem>('workitems')
+const { data: advancedFilteredItems } = await useAsyncData('advanced-filtered-items', () =>
+    useContentrainQuery<WorkItems>('workitems')
         .where('status', 'eq', 'publish')
         .where('order', 'gt', 2)
         .where('order', 'lt', 6)
@@ -107,15 +52,15 @@ const { data: advancedFilteredItems } = await useAsyncData<QueryResult<IWorkItem
         .get());
 
 // 3.2 Dizi Operatörleri
-const { data: arrayFilteredItems } = await useAsyncData<QueryResult<IWorkItem>>('array-filtered-items', () =>
-    useContentrainQuery<IWorkItem>('workitems')
+const { data: arrayFilteredItems } = await useAsyncData('array-filtered-items', () =>
+    useContentrainQuery<WorkItems>('workitems')
         .where('status', 'ne', 'draft')
         .locale('tr')
         .get());
 
 // 3.3 Array Operatörü Örneği
 const { data: specificSocialLinks } = await useAsyncData('specific-social-links', () =>
-    useContentrainQuery<ISocialLink>('sociallinks')
+    useContentrainQuery<SocialLinks>('sociallinks')
         .where('icon', 'in', ['ri-twitter-line', 'ri-instagram-line', 'ri-linkedin-line'] as unknown as string)
         .where('status', 'eq', 'publish')
         .orderBy('icon', 'asc')
@@ -124,32 +69,32 @@ const { data: specificSocialLinks } = await useAsyncData('specific-social-links'
 // === 4. Çoklu Dil Desteği ===
 // 4.1 Farklı Dillerde İçerik
 const { data: trContent } = await useAsyncData('tr-content', () =>
-    useContentrainQuery<IWorkItem>('workitems')
+    useContentrainQuery<WorkItems>('workitems')
         .locale('tr')
         .first());
 
 const { data: enContent } = await useAsyncData('en-content', () =>
-    useContentrainQuery<IWorkItem>('workitems')
+    useContentrainQuery<WorkItems>('workitems')
         .locale('en')
         .first());
 
 // 4.2 Lokalize Olmayan Model
 const { data: socialLinks } = await useAsyncData('social-links', () =>
-    useContentrainQuery<ISocialLink>('sociallinks')
+    useContentrainQuery<SocialLinks>('sociallinks')
         .where('status', 'eq', 'publish')
         .orderBy('icon', 'asc')
         .get());
 
 const { data: socialLinks2 } = await useAsyncData('social-links-2', () =>
-    useContentrainQuery<ISocialLink>('sociallinks')
+    useContentrainQuery<SocialLinks>('sociallinks')
         .where('icon', 'eq', 'ri-instagram-line')
         .orderBy('icon', 'asc')
         .get());
 
 // === 5. Önbellek Yönetimi ===
 // 5.1 Önbellek Bypass
-const { data: bypassCacheItems } = await useAsyncData<QueryResult<IFaqItem>>('bypass-cache-items', () =>
-    useContentrainQuery<IFaqItem>('faqitems')
+const { data: bypassCacheItems } = await useAsyncData('bypass-cache-items', () =>
+    useContentrainQuery<FaqItems>('faqitems')
         .locale('tr')
         .get());
 </script>

playground/nuxt/pages/works/[id].vue

@@ -1,16 +1,16 @@
 <script setup lang="ts">
+import type { WorkItems } from '#build/types/contentrain';
+
 const route = useRoute();
 const slug = computed(() => route.params.id);
-const { data: workItem } = await useAsyncData('work-item', async () => {
-    const result = await useContentrainQuery<any>('workitems').where('ID', 'eq', slug.value).locale('tr').first();
-    return result;
-});
+const { data: workItem } = await useAsyncData('work-item', () =>
+    useContentrainQuery<WorkItems>('workitems').where('ID', 'eq', slug.value as string).locale('tr').first());
 </script>
 
 <template>
     <div class="container mx-auto p-4">
-        <h1 class="text-2xl font-bold">{{ workItem.title }}</h1>
-        <p class="text-gray-600">{{ workItem.description }}</p>
+        <h1 class="text-2xl font-bold">{{ workItem.data.title }}</h1>
+        <p class="text-gray-600">{{ workItem.data.description }}</p>
     </div>
 </template>