[pull] main from pages-cms:main

.env.local.example

@@ -7,7 +7,9 @@ xxx
 GITHUB_APP_WEBHOOK_SECRET="another-random-string-of-characters"
 GITHUB_APP_CLIENT_ID="your-github-app-client-id"
 GITHUB_APP_CLIENT_SECRET="your-github-app-client-secret"
+RESEND_DOMAIN_EMAIL ="your-domain-email"
 RESEND_API_KEY="your-resend-api-key"
 SQLITE_URL="file:./local.db"
 # SQLITE_AUTH_TOKEN=""
-# BASE_URL="https://mycustomdomain.com"
+# BASE_URL="https://mycustomdomain.com"
+# PERMISSION_CACHE_TTL="60"

.gitignore

@@ -35,5 +35,5 @@ yarn-error.log*
 *.tsbuildinfo
 next-env.d.ts
 
-# local sqlite db
+# Database
 local.db

CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing to Pages CMS
+
+- Submit pull requests (PRs) against the `development` branch, not `main`.
+- For branches, we have:
+  - `main` is our production and default branch. This is what we deploy to https://app.pagescms.org.
+  - `development` is for staging. We deploy it at https://dev.pagescms.org.
+  - New features are worked in `feature/name-of-the-feature` branches.
+  - Issues are addressed in `issue/123-main-isse` branches.
+  - When ready, we PR against `development`, test it and then finally merge to `main`.
+- Keep changes focused: one feature or fix per PR.
+- Test locally before submitting.
+- Follow existing code style.
+
+Thanks for helping!

README.md

@@ -18,6 +18,10 @@ It offers a user-friendly interface to edit the content of your website or app d
 
 Go to [pagescms.org/docs](https://pagescms.org/docs).
 
+## Community chat
+
+[Join the Discord server](https://pagescms.org/chat) to get help with Pages CMS, share feedback, and connect with other users building with the platform.
+
 ## Built with
 
 - [Next.js](https://nextjs.org/)
@@ -71,7 +75,9 @@ You will need to fill in the following information:
     - Account permissions: nothing.
 - **Subscribe to events**:
     - Installation target
-    - Repository (you'll probably need to add this after creating the GitHub App)
+    - Repository
+    - Push
+    - Delete
 - **Where can this GitHub App be installed?**: you'll want to select "Any account" unless you intend to only use Pages CMS on the account this GitHub App is created under.
 
 ### Environment variables
@@ -85,10 +91,14 @@ Variable | Comments
 `GITHUB_APP_WEBHOOK_SECRET` | The secret you picked for your webhook. This is used to ensure the request is coming from GitHub.
 `GITHUB_APP_CLIENT_ID` | GitHub App Client ID from your GitHub App details page.
 `GITHUB_APP_CLIENT_SECRET` | GitHub App Client Secret you generate on theGitHub App details page.
+`RESEND_FROM_EMAIL` | The sender for authentication emails. Must be a verified domain in your Resend account and follow the format `[email protected]` or `Name <[email protected]>`.
 `RESEND_API_KEY` | You'll get that when you create a (free) [Resend](https://resend.com) account to handle emails.
 `SQLITE_URL` | `file:./local.db` for development, `libsql://pages-cms-username.turso.io` for example if you use [Turso](https://turso.tech) (you should, Turso is great).
 `SQLITE_AUTH_TOKEN` | Leave blank for development, otherwise use the token provided by [Turso](https://turso.tech) (if that's what you use).
 `BASE_URL` | **OPTIONAL**. If you're deploying to Vercel or working locally, you won't need that. If you're deploying elsewhere, you'll need to specify the base URL for the app (e.g. `https://mycustomdomain.com`).
+`FILE_CACHE_TTL` | **OPTIONAL**. Time to live (in minutes) for file cache (collections and
+media folders). Defaults to 10080 (7 days). Set to "-1" to prevent the cache from ever expiring, or "0" if you want no cache.
+`PERMISSION_CACHE_TTL` | **OPTIONAL**. Time to live (in minutes) for the permission cache, which controls access to file cache. Defaults to 60. Set to "0" if you want to always check permissions against the GitHub API.
 
 ### Local development
 

app/(main)/[owner]/[repo]/[branch]/layout.tsx

@@ -8,7 +8,6 @@ import { ConfigProvider } from "@/contexts/config-context";
 import { RepoLayout } from "@/components/repo/repo-layout";
 import { EmptyCreate } from "@/components/empty-create";
 import { Message } from "@/components/message";
-import { Tracker } from "@/components/tracker";
 
 export default async function Layout({
   children,
@@ -107,7 +106,6 @@ export default async function Layout({
 
   return (
     <ConfigProvider value={config}>
-      <Tracker owner={owner} repo={repo} branch={branch} />
       <RepoLayout>{errorMessage ? errorMessage : children}</RepoLayout>
     </ConfigProvider>
   );

app/(main)/[owner]/[repo]/[branch]/media/page.tsx → app/(main)/[owner]/[repo]/[branch]/media/[name]/page.tsx

@@ -3,22 +3,27 @@
 import { useSearchParams } from "next/navigation";
 import { useConfig } from "@/contexts/config-context";
 import { MediaView} from "@/components/media/media-view";
-import { Message } from "@/components/message";
 
-export default function Page() {
+export default function Page({
+  params
+}: {
+  params: {
+    name: string;
+  }
+}) {
   const searchParams = useSearchParams();
   const path = searchParams.get("path") || "";
 
   const { config } = useConfig();
   if (!config) throw new Error(`Configuration not found.`);
-
+  
   return (
     <div className="max-w-screen-xl mx-auto flex-1 flex flex-col h-full">
       <header className="flex items-center mb-6">
         <h1 className="font-semibold text-lg md:text-2xl">Media</h1>
       </header>
       <div className="flex flex-col relative flex-1">
-        <MediaView initialPath={path}/>
+        <MediaView initialPath={path} media={params.name} />
       </div>
     </div>
   );

app/(main)/[owner]/[repo]/[branch]/page.tsx

@@ -12,11 +12,11 @@ export default function Page() {
 
   useEffect(() => {
     if (config?.object.content?.[0]) {
-      router.replace(`/${config.owner}/${config.repo}/${config.branch}/${config.object.content[0].type}/${config.object.content[0].name}`);
+      router.replace(`/${config.owner}/${config.repo}/${encodeURIComponent(config.branch)}/${config.object.content[0].type}/${config.object.content[0].name}`);
     } else if (config?.object.media) {
-      router.replace(`/${config.owner}/${config.repo}/${config.branch}/media`);
+      router.replace(`/${config.owner}/${config.repo}/${encodeURIComponent(config.branch)}/media/${config.object.media[0].name}`);
     } else if (config?.object.settings !== false) {
-      router.replace(`/${config?.owner}/${config?.repo}/${config?.branch}/settings`);
+      router.replace(`/${config?.owner}/${config?.repo}/${encodeURIComponent(config!.branch)}/settings`);
     } else {
       setError(true);
     }
@@ -28,7 +28,7 @@ export default function Page() {
         description={<>This branch and/or repository has no configuration and settings are disabled. Edit on GitHub if you think this is a mistake.</>}
         className="absolute inset-0"
         cta="Edit configuration on GitHub"
-        href={`https://github.com/${config?.owner}/${config?.repo}/edit/${config?.branch}/.pages.yml`}
+        href={`https://github.com/${config?.owner}/${config?.repo}/edit/${encodeURIComponent(config!.branch)}/.pages.yml`}
       />
     : null;
 }

app/(main)/settings/page.tsx

@@ -32,7 +32,7 @@ export default async function Page() {
   return (
     <MainRootLayout>
       <div className="max-w-screen-sm mx-auto p-4 md:p-6 space-y-6">
-        <Link className={cn(buttonVariants({ variant: "outline", size: "xs" }), "inline-flex")} href="/">
+        <Link className={cn(buttonVariants({ variant: "outline", size: "xs" }), "inline-flex")} href="/" prefetch={true}>
           <ArrowLeft className="h-4 w-4 mr-1.5" />
           Go home
         </Link>

app/api/[owner]/[repo]/[branch]/branches/route.ts

@@ -2,6 +2,14 @@ import { createOctokitInstance } from "@/lib/utils/octokit";
 import { getAuth } from "@/lib/auth";
 import { getToken } from "@/lib/token";
 
+/**
+ * Creates a new branch in a GitHub repository.
+ * 
+ * POST /api/[owner]/[repo]/[branch]/branches
+ * 
+ * Requires authentication.
+ */
+
 export async function POST(
   request: Request,
   { params }: { params: { owner: string, repo: string, branch: string } }
@@ -18,7 +26,7 @@ export async function POST(
 
     const octokit = createOctokitInstance(token);
 
-    // Get the SHA of the branch we"re creating the new branch from
+    // Get the SHA of the branch we're creating the new branch from
     const { data: refData } = await octokit.rest.git.getRef({
       owner: params.owner,
       repo: params.repo,

app/api/[owner]/[repo]/[branch]/collections/[name]/route.ts

@@ -1,14 +1,24 @@
 export const maxDuration = 30;
 
 import { type NextRequest } from "next/server";
-import { createOctokitInstance } from "@/lib/utils/octokit"
 import { readFns } from "@/fields/registry";
 import { parse } from "@/lib/serialization";
-import { deepMap, getDateFromFilename, getSchemaByName } from "@/lib/schema";
+import { deepMap, getDateFromFilename, getSchemaByName, safeAccess } from "@/lib/schema";
 import { getConfig } from "@/lib/utils/config";
 import { normalizePath } from "@/lib/utils/file";
 import { getAuth } from "@/lib/auth";
 import { getToken } from "@/lib/token";
+import { getCollectionCache, checkRepoAccess } from "@/lib/githubCache";
+
+/**
+ * Fetches and parses collection contents from GitHub repositories
+ * (for collection views and searches)
+ * 
+ * GET /api/[owner]/[repo]/[branch]/collections/[name]
+ * 
+ * Requires authentication. If type is set to "search", we filter the contents
+ * based on the query and fields parameters.
+ */
 
 export async function GET(
   request: NextRequest,
@@ -21,6 +31,11 @@ export async function GET(
     const token = await getToken(user, params.owner, params.repo);
     if (!token) throw new Error("Token not found");
 
+    if (user.githubId) {
+      const hasAccess = await checkRepoAccess(token, params.owner, params.repo, user.githubId);
+      if (!hasAccess) throw new Error(`No access to repository ${params.owner}/${params.repo}.`);
+    }
+
     const config = await getConfig(params.owner, params.repo, params.branch);
     if (!config) throw new Error(`Configuration not found for ${params.owner}/${params.repo}/${params.branch}.`);
 
@@ -29,48 +44,64 @@ export async function GET(
 
     const searchParams = request.nextUrl.searchParams;
     const path = searchParams.get("path") || "";
+    const type = searchParams.get("type");
+    const query = searchParams.get("query") || "";
+    const fields = searchParams.get("fields")?.split(",") || ["name"];
+
     const normalizedPath = normalizePath(path);
     if (!normalizedPath.startsWith(schema.path)) throw new Error(`Invalid path "${path}" for collection "${params.name}".`);
-
-    const octokit = createOctokitInstance(token);
-    const query = `
-      query ($owner: String!, $repo: String!, $expression: String!) {
-        repository(owner: $owner, name: $repo) {
-          object(expression: $expression) {
-            ... on Tree {
-              entries {
-                name
-                path
-                type
-                object {
-                  ... on Blob {
-                    text
-                    oid
-                  }
-                }
-              }
-            }
-          }
-        }
-      }
-    `;
-    const expression = `${params.branch}:${normalizedPath}`;
-    const response: any = await octokit.graphql(query, { owner: params.owner, repo: params.repo, expression });
-    // TODO: handle 401 / Bad credentials error
 
-    const entries = response.repository?.object?.entries;
-
-    if (entries === undefined) throw new Error("Not found");
+    if (schema.subfolders === false) {
+      if (normalizedPath !== schema.path) throw new Error(`Invalid path "${path}" for collection "${params.name}".`);
+    }
 
+    let entries = await getCollectionCache(params.owner, params.repo, params.branch, normalizedPath, token);
+
     let data: {
       contents: Record<string, any>[],
       errors: string[]
     } = {
       contents: [],
       errors: []
     };
+
+    if (entries) {
+      data = parseContents(entries, schema, config);
+
+      // If this is a search request, filter the contents
+      if (type === "search" && query) {
+        const searchQuery = query.toLowerCase();
+        const searchFields = Array.isArray(fields) ? fields : fields ? [fields] : [];
+
+        data.contents = data.contents.filter(item => {
+          if (searchFields.length === 0) {
+            if (
+              (item.name && item.name.toLowerCase().includes(searchQuery)) ||
+              (item.path && item.path.toLowerCase().includes(searchQuery))
+            ) {
+              return true;
+            }
 
-    if (entries) data  = parseContents(entries, schema, config);
+            return item.content && item.content.toLowerCase().includes(searchQuery);
+          }
+
+          return searchFields.some(field => {
+            if (field === 'name' || field === 'path') {
+              const value = item[field];
+              return value && String(value).toLowerCase().includes(searchQuery);
+            }
+
+            if (field.startsWith('fields.')) {
+              const fieldPath = field.replace('fields.', '');
+              const value = safeAccess(item.fields, fieldPath);
+              return value && String(value).toLowerCase().includes(searchQuery);
+            }
+
+            return false;
+          });
+        });
+      }
+    }
 
     return Response.json({
       status: "success",
@@ -85,6 +116,7 @@ export async function GET(
   }
 }
 
+// Parse the list of entries into objects based on the content schema.
 const parseContents = (
   contents: any,
   schema: Record<string, any>,
@@ -101,13 +133,13 @@ const parseContents = (
 
   parsedContents = contents.map((item: any) => {
     // If it's a file and it matches the schema extension
-    if (item.type === "blob" && (item.path.endsWith(`.${schema.extension}`) || schema.extension === "") && !excludedFiles.includes(item.name)) {
+    if (item.type === "file" && (item.path.endsWith(`.${schema.extension}`) || schema.extension === "") && !excludedFiles.includes(item.name)) {
       let contentObject: Record<string, any> = {};
 
       if (serializedTypes.includes(schema.format) && schema.fields) {
         // If we are dealing with a serialized format and we have fields defined
         try {
-          contentObject = parse(item.object.text, { format: schema.format, delimiters: schema.delimiters });
+          contentObject = parse(item.content, { format: schema.format, delimiters: schema.delimiters });
           contentObject = deepMap(contentObject, schema.fields, (value, field) => readFns[field.type] ? readFns[field.type](value, field, config) : value);
         } catch (error: any) {
           // TODO: send this to the client?
@@ -132,14 +164,14 @@ const parseContents = (
       }
       // TODO: handle proper returns
       return {
-        sha: item.object.oid,
+        sha: item.sha,
         name: item.name,
         path: item.path,
-        content: item.object.text,
-        object: contentObject,
+        content: item.content,
+        fields: contentObject,
         type: "file",
       };
-    } else if (item.type === "tree") {
+    } else if (item.type === "dir" && !excludedFiles.includes(item.name) && schema.subfolders !== false) {
       return {
         name: item.name,
         path: item.path,

app/api/[owner]/[repo]/[branch]/entries/[path]/history/route.ts

@@ -6,6 +6,14 @@ import { getFileExtension, normalizePath } from "@/lib/utils/file";
 import { getAuth } from "@/lib/auth";
 import { getToken } from "@/lib/token";
 
+/**
+ * Fetches the history of a file from GitHub repositories.
+ * 
+ * GET /api/[owner]/[repo]/[branch]/entries/[path]/history
+ * 
+ * Requires authentication.
+ */
+
 export async function GET(
   request: NextRequest,
   { params }: { params: { owner: string, repo: string, branch: string, path: string } }

app/api/[owner]/[repo]/[branch]/entries/[path]/route.ts

@@ -8,6 +8,16 @@ import { getFileExtension, normalizePath } from "@/lib/utils/file";
 import { getAuth } from "@/lib/auth";
 import { getToken } from "@/lib/token";
 
+/**
+ * Fetches and parses individual file contents from GitHub repositories
+ * (usually for editing).
+ * 
+ * GET /api/[owner]/[repo]/[branch]/entries/[path]?name=[schemaName]
+ * 
+ * Requires authentication. If no schema name is provided, we return the raw
+ * contents.
+ */
+
 export async function GET(
   request: NextRequest,
   { params }: { params: { owner: string, repo: string, branch: string, path: string } }
@@ -80,6 +90,7 @@ export async function GET(
   }
 }
 
+// Parse the entry into an object based on the content schema.
 const parseContent = (
   content: string,
   schema: Record<string, any>,