nuxt-studio 1.0.0-alpha.0 → 1.0.0-alpha.2

package/dist/app/shared.d.ts

@@ -1,22 +1,3 @@
-import { CollectionItemBase } from '@nuxt/content';
-
-declare interface BaseItem {
-    id: string;
-    extension: string;
-    stem: string;
-    path?: string;
-}
-
-declare interface DatabaseItem extends CollectionItemBase, BaseItem {
-    [key: string]: unknown;
-}
-
-export declare function generateContentFromDocument(document: DatabaseItem): Promise<string | null>;
-
-export declare function generateDocumentFromContent(id: string, content: string): Promise<DatabaseItem | null>;
-
-export declare function removeReservedKeysFromDocument(document: DatabaseItem): {
-    [k: string]: unknown;
-};
+export declare const VirtualMediaCollectionName: "public-assets";
 
 export { }

package/dist/app/shared.js

@@ -1,6 +1,4 @@
-import { e as t, f as n, F as r } from "./shared-D04791PA.js";
+import { V as o } from "./shared-B6H2zqDG.js";
 export {
-  t as generateContentFromDocument,
-  n as generateDocumentFromContent,
-  r as removeReservedKeysFromDocument
+  o as VirtualMediaCollectionName
 };

package/dist/module/module.d.mts

@@ -1,5 +1,38 @@
 import * as _nuxt_schema from '@nuxt/schema';
 
+interface BaseRepository {
+    /**
+     * The owner of the git repository.
+     */
+    owner: string;
+    /**
+     * The repository name.
+     */
+    repo: string;
+    /**
+     * The branch to use for the git repository.
+     * @default 'main'
+     */
+    branch?: string;
+    /**
+     * The root directory to use for the git repository.
+     * @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;
+}
+interface GitHubRepository extends BaseRepository {
+    provider: 'github';
+}
+interface GitLabRepository extends BaseRepository {
+    provider: 'gitlab';
+    instanceUrl?: string;
+}
 interface ModuleOptions {
     /**
      * The route to access the studio login page.
@@ -25,43 +58,53 @@ interface ModuleOptions {
              */
             clientSecret?: string;
         };
+        /**
+         * The GitLab OAuth credentials.
+         */
+        gitlab?: {
+            /**
+             * The GitLab OAuth application ID.
+             * @default process.env.STUDIO_GITLAB_APPLICATION_ID
+             */
+            applicationId?: string;
+            /**
+             * The GitLab OAuth application secret.
+             * @default process.env.STUDIO_GITLAB_APPLICATION_SECRET
+             */
+            applicationSecret?: string;
+            /**
+             * The GitLab instance URL (for self-hosted instances).
+             * @default 'https://gitlab.com'
+             */
+            instanceUrl?: string;
+        };
     };
     /**
      * The git repository information to connect to.
      */
-    repository?: {
-        /**
-         * The provider to use for the git repository.
-         * @default 'github'
-         */
-        provider?: 'github';
-        /**
-         * The owner of the git repository.
-         */
-        owner: string;
-        /**
-         * The repository name.
-         */
-        repo: string;
-        /**
-         * The branch to use for the git repository.
-         * @default 'main'
-         */
-        branch?: string;
-        /**
-         * The root directory to use for the git repository.
-         * @default ''
-         */
-        rootDir?: string;
-    };
+    repository?: GitHubRepository | GitLabRepository;
+    /**
+     * Enable Nuxt Studio to edit content and media files on your filesystem.
+     */
+    dev: boolean;
     /**
      * Enable Nuxt Studio to edit content and media files on your filesystem.
-     * Currently experimental.
-     * @experimental
+     *
+     * @deprecated Use the 'dev' option instead.
      */
     development?: {
         sync?: boolean;
     };
+    /**
+     * i18n settings for the Studio.
+     */
+    i18n?: {
+        /**
+         * The default locale to use.
+         * @default 'en'
+         */
+        defaultLocale?: string;
+    };
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 

package/dist/module/module.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-studio",
   "configKey": "studio",
-  "version": "1.0.0-alpha.0",
+  "version": "1.0.0-alpha.2",
   "docs": "https://content.nuxt.com/studio",
   "builder": {
     "@nuxt/module-builder": "1.0.2",

package/dist/module/module.mjs

@@ -1,9 +1,10 @@
-import { useLogger, defineNuxtModule, createResolver, addPlugin, extendViteConfig, addServerHandler, addVitePlugin, addTemplate } from '@nuxt/kit';
+import { addServerHandler, addVitePlugin, useLogger, defineNuxtModule, createResolver, extendViteConfig, addPlugin, addTemplate } from '@nuxt/kit';
 import { createHash } from 'node:crypto';
 import { defu } from 'defu';
 import { resolve } from 'node:path';
 import fsDriver from 'unstorage/drivers/fs';
 import { createStorage } from 'unstorage';
+import { withLeadingSlash } from 'ufo';
 
 async function getAssetsStorageDevTemplate(_assetsStorage, _nuxt) {
   return [
@@ -21,11 +22,13 @@ async function getAssetsStorageTemplate(assetsStorage, _nuxt) {
     "const storage = createStorage({})",
     "",
     ...keys.map((key) => {
+      const path = withLeadingSlash(key.replace(/:/g, "/"));
       const value = {
         id: `public-assets/${key.replace(/:/g, "/")}`,
         extension: key.split(".").pop(),
         stem: key.split(".").join("."),
-        path: "/" + key.replace(/:/g, "/")
+        path,
+        fsPath: path
       };
       return `storage.setItem('${value.id}', ${JSON.stringify(value)})`;
     }),
@@ -34,10 +37,47 @@ async function getAssetsStorageTemplate(assetsStorage, _nuxt) {
   ].join("\n");
 }
 
-const version = "1.0.0-alpha.0";
+const version = "1.0.0-alpha.2";
+
+function setupDevMode(nuxt, runtime, assetsStorage) {
+  nuxt.options.nitro.storage = {
+    ...nuxt.options.nitro.storage,
+    nuxt_studio_content: {
+      driver: "fs",
+      base: resolve(nuxt.options.rootDir, "content")
+    },
+    nuxt_studio_public_assets: {
+      driver: "fs",
+      base: resolve(nuxt.options.rootDir, "public")
+    }
+  };
+  addServerHandler({
+    route: "/__nuxt_studio/dev/content/**",
+    handler: runtime("./server/routes/dev/content/[...path]")
+  });
+  addServerHandler({
+    route: "/__nuxt_studio/dev/public/**",
+    handler: runtime("./server/routes/dev/public/[...path]")
+  });
+  addVitePlugin({
+    name: "nuxt-studio",
+    configureServer: (server) => {
+      assetsStorage.watch((type, file) => {
+        server.ws.send({
+          type: "custom",
+          event: "nuxt-studio:media:update",
+          data: { type, id: `public-assets/${file}` }
+        });
+      });
+    },
+    closeWatcher: () => {
+      assetsStorage.unwatch();
+    }
+  });
+}
 
 const logger = useLogger("nuxt-studio");
-const module = defineNuxtModule({
+const module$1 = defineNuxtModule({
   meta: {
     name: "nuxt-studio",
     configKey: "studio",
@@ -45,60 +85,82 @@ const module = defineNuxtModule({
     docs: "https://content.nuxt.com/studio"
   },
   defaults: {
+    dev: true,
     route: "/_studio",
     repository: {
       provider: "github",
       owner: "",
       repo: "",
       branch: "main",
-      rootDir: ""
+      rootDir: "",
+      private: true
     },
     auth: {
       github: {
         clientId: process.env.STUDIO_GITHUB_CLIENT_ID,
         clientSecret: process.env.STUDIO_GITHUB_CLIENT_SECRET
+      },
+      gitlab: {
+        applicationId: process.env.STUDIO_GITLAB_APPLICATION_ID,
+        applicationSecret: process.env.STUDIO_GITLAB_APPLICATION_SECRET,
+        instanceUrl: process.env.STUDIO_GITLAB_INSTANCE_URL || process.env.CI_SERVER_URL || "https://gitlab.com"
       }
     },
-    development: {
-      sync: false
+    i18n: {
+      defaultLocale: "en"
     }
   },
   async setup(options, nuxt) {
     const resolver = createResolver(import.meta.url);
     const runtime = (...args) => resolver.resolve("./runtime", ...args);
-    if (!nuxt.options.dev) {
-      options.development.sync = false;
+    if (nuxt.options.dev === false || options.development?.sync === false) {
+      options.dev = false;
     }
     if (!nuxt.options.dev && !nuxt.options._prepare) {
-      if (!options.auth?.github?.clientId && !options.auth?.github?.clientSecret) {
+      const provider = options.repository?.provider || "github";
+      const hasGitHubAuth = options.auth?.github?.clientId && options.auth?.github?.clientSecret;
+      const hasGitLabAuth = options.auth?.gitlab?.applicationId && options.auth?.gitlab?.applicationSecret;
+      if (provider === "github" && !hasGitHubAuth) {
         logger.warn([
-          "Nuxt Content Studio relies on GitHub OAuth to authenticate users.",
+          "Nuxt Content Studio requires GitHub OAuth to authenticate users.",
           "Please set the `STUDIO_GITHUB_CLIENT_ID` and `STUDIO_GITHUB_CLIENT_SECRET` environment variables."
         ].join(" "));
+      } else if (provider === "gitlab" && !hasGitLabAuth) {
+        logger.warn([
+          "Nuxt Content Studio requires GitLab OAuth to authenticate users.",
+          "Please set the `STUDIO_GITLAB_APPLICATION_ID` and `STUDIO_GITLAB_APPLICATION_SECRET` environment variables."
+        ].join(" "));
       }
     }
     nuxt.options.experimental = nuxt.options.experimental || {};
     nuxt.options.experimental.checkOutdatedBuildInterval = 1e3 * 30;
     nuxt.options.runtimeConfig.public.studio = {
       route: options.route,
+      dev: Boolean(options.dev),
       development: {
-        sync: Boolean(options.development.sync),
         server: process.env.STUDIO_DEV_SERVER
       },
       // @ts-expect-error Autogenerated type does not match with options
-      repository: options.repository
+      repository: options.repository,
+      // @ts-expect-error Autogenerated type does not match with options
+      i18n: options.i18n
     };
     nuxt.options.runtimeConfig.studio = {
       auth: {
         sessionSecret: createHash("md5").update([
           options.auth?.github?.clientId,
-          options.auth?.github?.clientSecret
+          options.auth?.github?.clientSecret,
+          options.auth?.gitlab?.applicationId,
+          options.auth?.gitlab?.applicationSecret
         ].join("")).digest("hex"),
         // @ts-expect-error todo fix github type issue
-        github: options.auth?.github
-      }
+        github: options.auth?.github,
+        // @ts-expect-error autogenerated type doesn't match with project options
+        gitlab: options.auth?.gitlab
+      },
+      // @ts-expect-error Autogenerated type does not match with options
+      repository: options.repository
     };
-    addPlugin(process.env.STUDIO_DEV_SERVER ? runtime("./plugins/studio.client.dev") : runtime("./plugins/studio.client"));
     nuxt.options.vite = defu(nuxt.options.vite, {
       vue: {
         template: {
@@ -118,42 +180,7 @@ const module = defineNuxtModule({
         "extend"
       ];
     });
-    if (options.development.sync) {
-      nuxt.options.nitro.storage = {
-        ...nuxt.options.nitro.storage,
-        nuxt_studio_content: {
-          driver: "fs",
-          base: resolve(nuxt.options.rootDir, "content")
-        },
-        nuxt_studio_public_assets: {
-          driver: "fs",
-          base: resolve(nuxt.options.srcDir, "public")
-        }
-      };
-      addServerHandler({
-        route: "/__nuxt_studio/dev/content/**",
-        handler: runtime("./server/routes/dev/content/[...path]")
-      });
-      addServerHandler({
-        route: "/__nuxt_studio/dev/public/**",
-        handler: runtime("./server/routes/dev/public/[...path]")
-      });
-      addVitePlugin({
-        name: "nuxt-studio",
-        configureServer: (server) => {
-          assetsStorage.watch((type, file) => {
-            server.ws.send({
-              type: "custom",
-              event: "nuxt-studio:media:update",
-              data: { type, id: `public-assets/${file}` }
-            });
-          });
-        },
-        closeWatcher: () => {
-          assetsStorage.unwatch();
-        }
-      });
-    }
+    addPlugin(process.env.STUDIO_DEV_SERVER ? runtime("./plugins/studio.client.dev") : runtime("./plugins/studio.client"));
     const assetsStorage = createStorage({
       driver: fsDriver({
         base: resolve(nuxt.options.rootDir, "public")
@@ -161,12 +188,19 @@ const module = defineNuxtModule({
     });
     addTemplate({
       filename: "studio-public-assets.mjs",
-      getContents: () => options.development.sync ? getAssetsStorageDevTemplate() : getAssetsStorageTemplate(assetsStorage)
+      getContents: () => options.dev ? getAssetsStorageDevTemplate() : getAssetsStorageTemplate(assetsStorage)
     });
+    if (options.dev) {
+      setupDevMode(nuxt, runtime, assetsStorage);
+    }
     addServerHandler({
       route: "/__nuxt_studio/auth/github",
       handler: runtime("./server/routes/auth/github.get")
     });
+    addServerHandler({
+      route: "/__nuxt_studio/auth/gitlab",
+      handler: runtime("./server/routes/auth/gitlab.get")
+    });
     addServerHandler({
       route: "/__nuxt_studio/auth/session",
       handler: runtime("./server/routes/auth/session.get")
@@ -176,10 +210,19 @@ const module = defineNuxtModule({
       route: "/__nuxt_studio/auth/session",
       handler: runtime("./server/routes/auth/session.delete")
     });
-    addServerHandler({ route: options.route, handler: runtime("./server/routes/admin") });
-    addServerHandler({ route: "/__nuxt_studio/meta", handler: runtime("./server/routes/meta") });
-    addServerHandler({ route: "/sw.js", handler: runtime("./server/routes/sw") });
+    addServerHandler({
+      route: options.route,
+      handler: runtime("./server/routes/admin")
+    });
+    addServerHandler({
+      route: "/__nuxt_studio/meta",
+      handler: runtime("./server/routes/meta")
+    });
+    addServerHandler({
+      route: "/sw.js",
+      handler: runtime("./server/routes/sw")
+    });
   }
 });
 
-export { module as default };
+export { module$1 as default };

package/dist/module/runtime/host.dev.js

@@ -1,14 +1,15 @@
 import { useStudioHost as useStudioHostBase } from "./host.js";
-import { generateContentFromDocument } from "nuxt-studio/app/utils";
-import { createCollectionDocument, getCollectionInfo } from "./utils/collection.js";
+import { getCollectionByFilePath, generateIdFromFsPath, generateFsPathFromId, getCollectionById } from "./utils/collection.js";
+import { normalizeDocument } from "./utils/document.js";
 import { createStorage } from "unstorage";
 import httpDriver from "unstorage/drivers/http";
 import { useRuntimeConfig } from "#imports";
 import { collections } from "#content/preview";
 import { debounce } from "perfect-debounce";
+import { getCollectionSourceById } from "./utils/source.js";
 export function useStudioHost(user, repository) {
   const host = useStudioHostBase(user, repository);
-  if (!useRuntimeConfig().public.studio.development.sync) {
+  if (!useRuntimeConfig().public.studio.dev) {
     return host;
   }
   host.meta.dev = true;
@@ -17,24 +18,30 @@ export function useStudioHost(user, repository) {
   });
   host.app.requestRerender = () => {
   };
-  host.document.upsert = debounce(async (id, upsertedDocument) => {
-    id = id.replace(/:/g, "/");
-    const collection = getCollectionInfo(id, collections).collection;
-    const doc = createCollectionDocument(collection, id, upsertedDocument);
-    const content = await generateContentFromDocument(doc);
-    await devStorage.setItem(host.document.getFileSystemPath(id), content, {
+  host.document.db.upsert = debounce(async (fsPath, upsertedDocument) => {
+    const collectionInfo = getCollectionByFilePath(fsPath, collections);
+    if (!collectionInfo) {
+      throw new Error(`Collection not found for fsPath: ${fsPath}`);
+    }
+    const id = generateIdFromFsPath(fsPath, collectionInfo);
+    const document = normalizeDocument(id, collectionInfo, upsertedDocument);
+    const content = await host.document.generate.contentFromDocument(document);
+    await devStorage.setItem(fsPath, content, {
       headers: {
         "content-type": "text/plain"
       }
     });
   }, 100);
-  host.document.delete = async (id) => {
-    await devStorage.removeItem(host.document.getFileSystemPath(id.replace(/:/g, "/")));
+  host.document.db.delete = async (fsPath) => {
+    await devStorage.removeItem(fsPath);
   };
   host.on.documentUpdate = (fn) => {
     import.meta.hot.on("nuxt-content:update", (data) => {
+      const collection = getCollectionById(data.key, collections);
+      const source = getCollectionSourceById(data.key, collection.source);
+      const fsPath = generateFsPathFromId(data.key, source);
       const isRemoved = data.queries.length === 0;
-      fn(data.key, isRemoved ? "remove" : "update");
+      fn(fsPath, isRemoved ? "remove" : "update");
     });
   };
   host.on.mediaUpdate = (fn) => {