@next-friday/create-app 2.0.0 → 2.1.1

package/templates/turborepo/apps/backoffice/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@next-friday-template-turborepo/backoffice",
+  "version": "0.1.0",
+  "private": true,
+  "description": "Next Friday Payload backoffice.",
+  "license": "UNLICENSED",
+  "type": "module",
+  "scripts": {
+    "build": "next build",
+    "depcruise": "depcruise --config .dependency-cruiser.json src test next.config.ts playwright.config.ts vitest.config.ts",
+    "dev": "next dev --port 3001",
+    "generate:importmap": "payload generate:importmap",
+    "generate:types": "payload generate:types",
+    "migrate": "payload migrate",
+    "migrate:create": "payload migrate:create",
+    "payload": "payload",
+    "start": "cp -R .next/static .next/standalone/apps/backoffice/.next/ && (test ! -d public || cp -R public .next/standalone/apps/backoffice/) && PORT=3001 node .next/standalone/apps/backoffice/server.js",
+    "test": "vitest run --passWithNoTests",
+    "test:changed": "if git rev-parse --quiet --verify origin/main > /dev/null && git diff --quiet \"$(git merge-base origin/main HEAD)\" -- pnpm-lock.yaml pnpm-workspace.yaml \"*package.json\" \"*tsconfig.json\" .husky; then vitest run --changed origin/main --passWithNoTests; else vitest run --passWithNoTests; fi",
+    "test:coverage": "vitest run --coverage --passWithNoTests",
+    "test:e2e": "playwright test",
+    "test:watch": "vitest",
+    "typecheck": "next typegen && tsc --noEmit -p tsconfig.json"
+  },
+  "dependencies": {
+    "@payloadcms/db-postgres": "3.92.1",
+    "@payloadcms/next": "3.92.1",
+    "@payloadcms/richtext-lexical": "3.92.1",
+    "next": "16.4.3",
+    "payload": "3.92.1",
+    "react": "19.3.1",
+    "react-dom": "19.3.1",
+    "sharp": "0.35.5"
+  },
+  "devDependencies": {
+    "@playwright/test": "1.64.1",
+    "@types/node": "26.6.5",
+    "@types/react": "19.3.0",
+    "@types/react-dom": "19.3.0",
+    "@vitest/coverage-v8": "5.0.5",
+    "dependency-cruiser": "18.7.0",
+    "fast-check": "4.10.2",
+    "typescript": "7.0.2",
+    "vitest": "5.0.5"
+  },
+  "engines": {
+    "node": ">=24.22.1 <25"
+  }
+}

package/templates/turborepo/apps/backoffice/playwright.config.ts

@@ -0,0 +1,27 @@
+import {defineConfig, devices} from "@playwright/test";
+
+const isCi = Boolean(process.env.CI);
+
+export default defineConfig({
+  forbidOnly: isCi,
+  testDir: "test",
+  projects: [
+    {
+      name: "chromium",
+      use: devices["Desktop Chrome"],
+    },
+  ],
+  use: {
+    baseURL: "http://localhost:3001",
+    trace: "on-first-retry",
+  },
+  webServer: {
+    url: "http://localhost:3001",
+    command: isCi
+      ? "cp -R .next/static .next/standalone/apps/backoffice/.next/ && (test ! -d public || cp -R public .next/standalone/apps/backoffice/) && PORT=3001 node .next/standalone/apps/backoffice/server.js"
+      : "next dev --port 3001",
+    reuseExistingServer: !isCi,
+  },
+  reporter: isCi ? "github" : "list",
+  retries: isCi ? 2 : 0,
+});

package/templates/turborepo/apps/backoffice/src/app/(frontend)/layout.tsx

@@ -0,0 +1,18 @@
+import type {Metadata} from "next";
+
+import "./styles.css";
+
+export const metadata: Metadata = {
+  title: "Next Friday Payload template",
+  description: "Starter application for Next Friday Payload projects.",
+};
+
+export default function RootLayout(props: LayoutProps<"/">) {
+  const {children} = props;
+
+  return (
+    <html lang="en">
+      <body>{children}</body>
+    </html>
+  );
+}

package/templates/turborepo/apps/backoffice/src/app/(frontend)/page.test.ts

@@ -0,0 +1,14 @@
+import {createElement} from "react";
+import {describe, expect, it} from "vitest";
+import {renderToStaticMarkup} from "react-dom/server";
+
+import Page from "./page";
+
+describe("Page", () => {
+  it("renders the template heading and the admin link", () => {
+    const html = renderToStaticMarkup(createElement(Page));
+
+    expect(html).toContain("Next Friday Payload template");
+    expect(html).toContain('href="/admin"');
+  });
+});

package/templates/turborepo/apps/backoffice/src/app/(frontend)/page.tsx

@@ -0,0 +1,14 @@
+import Link from "next/link";
+
+export default function Page() {
+  return (
+    <main>
+      <h1>Next Friday Payload template</h1>
+
+      <p>
+        Edit <code>src/app/(frontend)/page.tsx</code> to get started, or open the{" "}
+        <Link href="/admin">admin panel</Link>.
+      </p>
+    </main>
+  );
+}

package/templates/turborepo/apps/backoffice/src/app/(frontend)/styles.css

@@ -0,0 +1,15 @@
+:root {
+  font-family: system-ui, sans-serif;
+  color-scheme: light dark;
+}
+
+main {
+  display: flex;
+  flex-direction: column;
+  gap: 1rem;
+  align-items: center;
+  justify-content: center;
+  min-height: 100vh;
+  padding: 4rem;
+  text-align: center;
+}

package/templates/turborepo/apps/backoffice/src/app/(payload)/admin/[[...segments]]/not-found.tsx

@@ -0,0 +1,24 @@
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+import type { Metadata } from 'next'
+
+import config from '@payload-config'
+import { NotFoundPage, generatePageMetadata } from '@payloadcms/next/views'
+import { importMap } from '../importMap'
+
+type Args = {
+  params: Promise<{
+    segments: string[]
+  }>
+  searchParams: Promise<{
+    [key: string]: string | string[]
+  }>
+}
+
+export const generateMetadata = ({ params, searchParams }: Args): Promise<Metadata> =>
+  generatePageMetadata({ config, params, searchParams })
+
+const NotFound = ({ params, searchParams }: Args) =>
+  NotFoundPage({ config, params, searchParams, importMap })
+
+export default NotFound

package/templates/turborepo/apps/backoffice/src/app/(payload)/admin/[[...segments]]/page.tsx

@@ -0,0 +1,24 @@
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+import type { Metadata } from 'next'
+
+import config from '@payload-config'
+import { RootPage, generatePageMetadata } from '@payloadcms/next/views'
+import { importMap } from '../importMap'
+
+type Args = {
+  params: Promise<{
+    segments: string[]
+  }>
+  searchParams: Promise<{
+    [key: string]: string | string[]
+  }>
+}
+
+export const generateMetadata = ({ params, searchParams }: Args): Promise<Metadata> =>
+  generatePageMetadata({ config, params, searchParams })
+
+const Page = ({ params, searchParams }: Args) =>
+  RootPage({ config, params, searchParams, importMap })
+
+export default Page

package/templates/turborepo/apps/backoffice/src/app/(payload)/admin/importMap.ts

@@ -0,0 +1,6 @@
+import { CollectionCards as CollectionCards_f9c02e79a4aed9a3924487c0cd4cafb1 } from '@payloadcms/next/rsc'
+
+/** @type import('payload').ImportMap */
+export const importMap = {
+  "@payloadcms/next/rsc#CollectionCards": CollectionCards_f9c02e79a4aed9a3924487c0cd4cafb1
+}

package/templates/turborepo/apps/backoffice/src/app/(payload)/api/[...slug]/route.ts

@@ -0,0 +1,19 @@
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+import config from '@payload-config'
+import '@payloadcms/next/css'
+import {
+  REST_DELETE,
+  REST_GET,
+  REST_OPTIONS,
+  REST_PATCH,
+  REST_POST,
+  REST_PUT,
+} from '@payloadcms/next/routes'
+
+export const GET = REST_GET(config)
+export const POST = REST_POST(config)
+export const DELETE = REST_DELETE(config)
+export const PATCH = REST_PATCH(config)
+export const PUT = REST_PUT(config)
+export const OPTIONS = REST_OPTIONS(config)

package/templates/turborepo/apps/backoffice/src/app/(payload)/layout.tsx

@@ -0,0 +1,31 @@
+/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
+/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+import config from '@payload-config'
+import '@payloadcms/next/css'
+import type { ServerFunctionClient } from 'payload'
+import { handleServerFunctions, RootLayout } from '@payloadcms/next/layouts'
+import React from 'react'
+
+import { importMap } from './admin/importMap'
+import './custom.scss'
+
+type Args = {
+  children: React.ReactNode
+}
+
+const serverFunction: ServerFunctionClient = async function (args) {
+  'use server'
+  return handleServerFunctions({
+    ...args,
+    config,
+    importMap,
+  })
+}
+
+const Layout = ({ children }: Args) => (
+  <RootLayout config={config} importMap={importMap} serverFunction={serverFunction}>
+    {children}
+  </RootLayout>
+)
+
+export default Layout

package/templates/turborepo/apps/backoffice/src/app/health/route.test.ts

@@ -0,0 +1,20 @@
+import {describe, expect, it, vi} from "vitest";
+
+import {GET} from "./route";
+
+vi.mock("next/server", () => ({
+  connection: vi.fn(async () => {}),
+}));
+
+describe("GET /health", () => {
+  it("reports ok without caching", async () => {
+    const response = await GET();
+
+    expect(response.status).toBe(200);
+    expect(response.headers.get("Cache-Control")).toBe("no-store");
+
+    await expect(response.json()).resolves.toEqual({
+      status: "ok",
+    });
+  });
+});

package/templates/turborepo/apps/backoffice/src/app/health/route.ts

@@ -0,0 +1,23 @@
+import {connection} from "next/server";
+
+/**
+ * Report that the server is up, for platform health checks. Rendered per request and never cached, so a
+ * stopped server cannot pass from a cached response.
+ * @returns A JSON response with `status: "ok"`.
+ */
+async function get(): Promise<Response> {
+  await connection();
+
+  return Response.json(
+    {
+      status: "ok",
+    },
+    {
+      headers: {
+        "Cache-Control": "no-store",
+      },
+    },
+  );
+}
+
+export {get as GET};

package/templates/turborepo/apps/backoffice/src/collections/media.test.ts

@@ -0,0 +1,27 @@
+import {describe, expect, it} from "vitest";
+import type {PayloadRequest} from "payload";
+
+import {Media} from "./media";
+
+describe("Media", () => {
+  it("lets anyone read uploaded files", () => {
+    const read = Media.access?.read;
+
+    expect(read).toBeTypeOf("function");
+
+    expect(
+      read?.({
+        req: {} as PayloadRequest,
+      }),
+    ).toBe(true);
+  });
+
+  it("requires alt text", () => {
+    expect(Media.fields).toContainEqual(
+      expect.objectContaining({
+        name: "alt",
+        required: true,
+      }),
+    );
+  });
+});

package/templates/turborepo/apps/backoffice/src/collections/media.ts

@@ -0,0 +1,18 @@
+import type {CollectionConfig} from "payload";
+
+export const Media: CollectionConfig = {
+  slug: "media",
+  fields: [
+    {
+      name: "alt",
+      type: "text",
+      required: true,
+    },
+  ],
+  upload: {
+    mimeTypes: ["image/*"],
+  },
+  access: {
+    read: () => true,
+  },
+};

package/templates/turborepo/apps/backoffice/src/collections/users.test.ts

@@ -0,0 +1,10 @@
+import {describe, expect, it} from "vitest";
+
+import {Users} from "./users";
+
+describe("Users", () => {
+  it("enables authentication and titles users by email", () => {
+    expect(Users.auth).toBe(true);
+    expect(Users.admin?.useAsTitle).toBe("email");
+  });
+});

package/templates/turborepo/apps/backoffice/src/collections/users.ts

@@ -0,0 +1,10 @@
+import type {CollectionConfig} from "payload";
+
+export const Users: CollectionConfig = {
+  slug: "users",
+  auth: true,
+  fields: [],
+  admin: {
+    useAsTitle: "email",
+  },
+};

package/templates/turborepo/apps/backoffice/src/environment.test.ts

@@ -0,0 +1,32 @@
+import {afterEach, describe, expect, it, vi} from "vitest";
+import {assert, property, string} from "fast-check";
+
+import {requireEnvironment} from "./environment";
+
+afterEach(() => {
+  vi.unstubAllEnvs();
+});
+
+describe("requireEnvironment", () => {
+  it("returns any non-empty value unchanged", () => {
+    assert(
+      property(
+        string({
+          minLength: 1,
+        }).filter(value => !value.includes("\0")),
+        value => {
+          vi.stubEnv("EXAMPLE_VALUE", value);
+          expect(requireEnvironment("EXAMPLE_VALUE")).toBe(value);
+        },
+      ),
+    );
+  });
+
+  it.each([undefined, ""])("throws when the value is %j", value => {
+    vi.stubEnv("EXAMPLE_VALUE", value);
+
+    expect(() => requireEnvironment("EXAMPLE_VALUE")).toThrow(
+      "EXAMPLE_VALUE environment variable is required",
+    );
+  });
+});

package/templates/turborepo/apps/backoffice/src/environment.ts

@@ -0,0 +1,27 @@
+import {existsSync} from "node:fs";
+import {fileURLToPath} from "node:url";
+import path from "node:path";
+
+/**
+ * Read a required environment variable.
+ * @param name - Variable name.
+ * @returns The variable's value.
+ */
+export function requireEnvironment(name: string): string {
+  const environmentFile = path.resolve(
+    path.dirname(fileURLToPath(import.meta.url)),
+    "../../../.env",
+  );
+
+  if (existsSync(environmentFile)) {
+    process.loadEnvFile(environmentFile);
+  }
+
+  const value = process.env[name];
+
+  if (value === undefined || value === "") {
+    throw new Error(`${name} environment variable is required`);
+  }
+
+  return value;
+}