Merge branch 'main' into patch-1

Author: Diizzayy

.eslintrc

@@ -2,6 +2,7 @@
   "extends": ["@nuxtjs/eslint-config-typescript"],
   "rules": {
     "no-redeclare": "off",
+    "import/named": "off",
     "vue/html-self-closing": "off",
     "vue/multi-word-component-names": "off",
     "@typescript-eslint/no-unused-vars": "off"

.github/workflows/ci.yml

@@ -37,6 +37,8 @@ jobs:
       - name: Install dependencies
         run: pnpm install
 
+      - run: pnpm dev:prepare
+
       - name: Build
         run: pnpm build
 
@@ -66,6 +68,8 @@ jobs:
       - name: Install dependencies
         run: pnpm install
 
+      - run: pnpm dev:prepare
+
       - name: Lint
         run: pnpm lint
 
@@ -95,6 +99,8 @@ jobs:
       - name: Install dependencies
         run: pnpm install
 
+      - run: pnpm dev:prepare
+
       - name: Run Tests
         run: pnpm test -- --coverage --no-threads
 

docs/content/1.getting-started/2.gql-functions.md

@@ -7,6 +7,36 @@ description: 'Gql functions are automatically generated and imported based on yo
 
 Gql Functions are automatically generated and imported based on the GraphQL operations in the project.
 
+## Example
+
+```graphql [example.gql]
+query GetUsers {
+  users {
+    id
+    name
+  }
+}
+
+mutation LoginUser($email: String!, $password: String!) {
+  login(email: $email, password: $password) {
+    id
+    name
+  }
+}
+```
+
+The GraphQL document above will generate two Gql Functions (`GqlGetUsers` and `GqlLoginUser`) that are automatically imported, and can be utilized as shown below:
+
+```ts
+async function loadUsers() {
+  const result = await GqlGetUsers()
+}
+
+async function handleLogin(email: string, password: string) {
+  const result = await GqlLoginUser(email, password)
+}
+```
+
 ## Understanding
 
 Writing GraphQL operations in SFC components is **not supported**, this decision is at the heart of this module.

docs/content/1.getting-started/3.composables.md

@@ -138,9 +138,14 @@ export default defineNuxtPlugin(() => {
 Change the host of a GraphQL Client at runtime.
 
 ```ts
-// Change the host of the default client
-useGqlHost('<host>')
+export default defineNuxtPlugin(() => {
+  // Change the host of the default client
+  useGqlHost('<host>')
+
+  // Change the host of a specific client
+  useGqlHost('<host>', '<client>')
 
-// Change the host of a specific client
-useGqlHost('<host>', '<client>')
+  // Add query parameters to the preconfigured host
+  useGqlHost('?param1=one&param2=two')
+})
 ```

docs/content/1.getting-started/4.configuration.md

@@ -188,6 +188,19 @@ Pass cookies from the browser to the GraphQL API in SSR mode.
 Enabled by default.
 ::
 
+### `corsOptions`
+
+Specify CORS options to be used for client-side requests.
+
+```ts [Type Signature]
+{ 
+    corsOptions: {
+      mode: "cors" | "navigate" | "no-cors" | "same-origin"
+      credentials: "include" | "omit" | "same-origin"
+    }
+}
+```
+
 ### `preferGETQueries`
 
   - default: `false`
@@ -240,6 +253,7 @@ Configuration for the token storage.
 
 ```ts [Type Signature]
 { 
+    name: 'gql:<clientname>'
     mode: 'cookie' | 'localStorage'
     cookieOptions: {
         path: string

docs/content/2.advanced/1.authentication.md

@@ -45,11 +45,12 @@ export default defineNuxtConfig({
 
   'graphql-client': {
     tokenStorage: {
-      mode: 'cookie',
+      name: '__session',
+      mode: 'cookie', // default
       cookieOptions: {
         path: '/',
         secure: false, // defaults to `process.env.NODE_ENV === 'production'`
-        httpOnly: true, // Only accessible via HTTP(S)
+        httpOnly: false, // Only accessible via HTTP(S)
         maxAge: 60 * 60 * 24 * 5 // 5 days
       }
     }

docs/nuxt.config.ts

@@ -5,10 +5,6 @@ export default defineNuxtConfig({
     preference: 'dark'
   },
 
-  routeRules: {
-    '/': { prerender: true }
-  },
-
   content: {
     highlight: {
       preload: ['graphql']

docs/package.json

@@ -11,7 +11,8 @@
   },
   "devDependencies": {
     "@nuxt-themes/docus": "npm:@nuxt-themes/docus-edge@latest",
-    "nuxt": "npm:nuxt3@latest"
+    "@nuxtjs/tailwindcss": "^6.1.3",
+    "nuxt": "latest"
   },
   "packageManager": "[email protected]"
 }