feat: add repository.private option for public repos

Author: atinux

playground/docus/content/2.studio/2.setup.md

@@ -63,7 +63,8 @@ export default defineNuxtConfig({
       owner: 'your-username', // your GitHub username or organization
       repo: 'your-repo', // your repository name
       branch: 'main', // the branch to commit to
-      rootDir: '' // optional: if your Nuxt app is in a subdirectory
+      rootDir: '', // optional: if your Nuxt app is in a subdirectory
+      private: true // optional: whether the repository is private or public (default: true)
     }
   }
 })

playground/docus/nuxt.config.ts

@@ -19,6 +19,7 @@ export default defineNuxtConfig({
       repo: 'studio',
       branch: 'main',
       rootDir: 'playground/docus',
+      private: false
     },
   },
 })

src/module/src/module.ts

@@ -62,6 +62,12 @@ interface ModuleOptions {
      * @default ''
      */
     rootDir?: string
+    /**
+     * Whether the repository is private or public.
+     * If set to false, the 'public_repo' scope will be used instead of the 'repo' scope.
+     * @default true
+     */
+    private?: boolean
   }
   /**
    * Enable Nuxt Studio to edit content and media files on your filesystem.
@@ -89,6 +95,7 @@ export default defineNuxtModule<ModuleOptions>({
       repo: '',
       branch: 'main',
       rootDir: '',
+      private: true,
     },
     auth: {
       github: {
@@ -140,6 +147,8 @@ export default defineNuxtModule<ModuleOptions>({
         // @ts-expect-error todo fix github type issue
         github: options.auth?.github,
       },
+      // @ts-expect-error Autogenerated type does not match with options
+      repository: options.repository,
     }
 
     addPlugin(process.env.STUDIO_DEV_SERVER

src/module/src/runtime/server/routes/auth/github.get.ts

@@ -80,7 +80,8 @@ interface RequestAccessTokenOptions {
 }
 
 export default eventHandler(async (event: H3Event) => {
-  const config = defu(useRuntimeConfig(event).studio?.auth?.github, {
+  const studioConfig = useRuntimeConfig(event).studio
+  const config = defu(studioConfig?.auth?.github, {
     clientId: process.env.STUDIO_GITHUB_CLIENT_ID,
     clientSecret: process.env.STUDIO_GITHUB_CLIENT_SECRET,
     authorizationURL: 'https://github.com/login/oauth/authorize',
@@ -117,8 +118,8 @@ export default eventHandler(async (event: H3Event) => {
     if (config.emailRequired && !config.scope.includes('user:email')) {
       config.scope.push('user:email')
     }
-    if (config.emailRequired && !config.scope.includes('repo')) {
-      config.scope.push('repo')
+    if (config.emailRequired && !config.scope.includes('repo') && !config.scope.includes('public_repo')) {
+      config.scope.push(studioConfig.repository.private ? 'repo' : 'public_repo')
     }
 
     return sendRedirect(